Skip to main content

How to use API Access

API access to your own Publisher Champ account is included with Champ Ultra and during the standard 14-day free trial. View Ultra pricing or follow the step-by-step Ultra upgrade guide.

Already using two accounts for API access?

If you currently have a main Publisher Champ account and a separate account for your API integration, please email our team or contact us through live chat. Your existing two-account API setup will continue to work as before until you ask us to transition it to the Ultra plan. We will then help you move the integration to a single account.

This guide explains how to:

  1. Find your API credentials
  2. Access your own account by API
  3. Grant API access to another Publisher Champ user
  4. Revoke API access later if needed

You can find this page in Publisher Champ at My Account > Settings > API Access.

Before you start​

To use the API with your own account, use the standard 14-day free trial or activate a paid Champ Ultra subscription. Existing users with an approved Enterprise API or legacy arrangement retain their approved access.

Where to find API Access​

  1. Log in to Publisher Champ
  2. Go to My Account Settings
  3. Open the API Access tab

Access your own account​

  1. Use the standard 14-day free trial or activate a paid Champ Ultra subscription.
  2. Open My Account → Settings → API Access.
  3. Copy your api_key and your own account_id.
  4. Use Accounts → List accounts in the API documentation to see the accounts currently available to your key.

The standard 14-day free trial includes API and MCP access to your own account. It does not enable sharing API access with other users.

Include only your own account​

For a master account with connected clients, add own_account_only=true to API requests to exclude connected/shared accounts. Reports then include only the Publisher Champ account identified by account_id. This also works when an authorized integration uses another user's API key.

For example: /api/v1/bookStatsAPI/?api_key=<API_KEY>&account_id=<YOUR_ACCOUNT_UUID>&start_date=2026-09-01&end_date=2026-09-30&own_account_only=true.

The flag applies across account reports, book/author/series data, advertising metrics, and relation lists, including legacy reports and Power Table exports. It takes precedence over saved account selections and Power Table selected_accounts. Endpoints that already query only the requested account continue to do so. Global data such as KENP payout rates is unaffected. On listAccountsAPI, the flag returns only the API key owner's account, subject to existing access checks.

Omit the flag or use own_account_only=false to preserve the endpoint's existing behavior. The flag does not change saved dashboard preferences or grant access to another account. POST endpoints also accept the flag in their form or JSON body.

Filter reports by platform​

The bookStatsAPI, authorStatsAPI, countryStatsAPI, and seriesStatsAPI endpoints accept two optional comma-separated query parameters:

  • platforms includes only the named platforms. If omitted or empty, the report includes all available platforms, preserving existing requests.
  • exclude_platforms removes named platforms. You can use it alone or with platforms. If a platform appears in both parameters, it is left out of the report.

Names are case-insensitive. Account-specific custom platform names are accepted too. Invalid names return HTTP 400 with a list of valid values.

Show all 34 built-in platforms
  • ACX
  • Amazon
  • Apple Books
  • Authors Republic
  • Barnes & Noble Press
  • BookBub Ads
  • BookMundo
  • BookReverb
  • Draft2Digital
  • Facebook
  • Fourthwall
  • Google Books
  • Gumroad
  • Ingram LSI
  • IngramSpark
  • Kobo Writing Life
  • Launch Reads
  • Lemon Squeezy
  • Other
  • Payhip
  • PayPal
  • PublishDrive
  • SamCart
  • Shopify
  • Spotify for Authors
  • Squarespace
  • SquareUp
  • StreetLib
  • Stripe
  • ThriveCart
  • Tolino Media
  • Voices by INaudio
  • Wix
  • WooCommerce

For example, this request returns Amazon data only: platforms includes Amazon and Shopify, then exclude_platforms removes Shopify.

https://www.publisherchamp.com/api/v1/bookStatsAPI/?api_key=YOUR_KEY&account_id=YOUR_ACCOUNT_ID&start_date=2026-09-01&end_date=2026-09-24&platforms=Amazon,Shopify&exclude_platforms=Shopify

For all platforms except Amazon and ACX, omit platforms and use exclude_platforms=Amazon,ACX.

Book stats by ASIN or unique ID​

Add separate_by_asin_and_unique_id=true to bookStatsAPI to return separate rows per ASIN or platform unique ID, even when books share a title or alias. The flag also applies when using breakdown=daily or breakdown=monthly.

Use separate_by_asin_and_unique_id=false to group by title or alias. If omitted, the account's saved grouping preference is used. This flag only affects the request and does not change the saved preference.

https://www.publisherchamp.com/api/v1/bookStatsAPI/?api_key=YOUR_KEY&account_id=YOUR_ACCOUNT_ID&start_date=2026-09-01&end_date=2026-09-24&separate_by_asin_and_unique_id=true

Grant API access to another user​

Use this when you want another Publisher Champ user to access your account by API.

  1. Open the API Access tab
  2. In Share Your Account By API, enter the recipient's email address
  3. Click Grant Access
  4. Confirm the action

After this:

  • The other user can use their own API key
  • They can use your account_id
  • Your account will appear in their available account list only while the commercial access requirements remain satisfied
note

The receiving user must already have an API key. In addition, either:

  • The account owner sharing access must have an active paid Ultra subscription, or
  • The receiving API user must have an approved Enterprise API or legacy arrangement

The API returns only accounts that currently satisfy these rules.

Revoke API access​

You can remove API access at any time.

  1. Open the API Access tab
  2. In Who Has Access, find the email address
  3. Click Revoke
  4. Confirm the action

Once revoked, that user will no longer have explicit API access to your account.

If the account owner downgrades from Ultra or the subscription expires, the granted account also stops being returned unless the receiving API user has an approved Enterprise API or legacy arrangement.

What the other user sees​

If the receiving user has an active API key, they will see:

  • Their assigned api_key
  • The account_id values they can use

They can then call the API with:

  • Their own api_key
  • The granted account's account_id

Summary​

  • Ultra and the standard 14-day free trial include API access to your own account
  • Use the API Access tab to grant access by email
  • Use the same tab to revoke access later
  • Sharing requires a paid Ultra account owner unless the recipient has an approved Enterprise API or legacy arrangement
  • Only currently eligible accounts are returned by the API

For an Enterprise API arrangement, contact us through live chat or email support@publisherchamp.com.