Skip to main content

API token and documentation

Learn how to use the IndexCheckr API to automate checks, feed SEO reports, and integrate indexing data into your tools or CRM.

Use the API to integrate IndexCheckr into your SEO reporting tools, internal dashboards, or content workflows. Automate checks, manage projects and pages, and monitor indexing status across large websites programmatically.

The API is available to every IndexCheckr account with a verified email address, including free accounts. You only need credits for the calls that check pages (see Credits below).

Your API token

The API page in the left-hand menu gives you access to your personal API token. This token is required to authenticate your requests to the IndexCheckr API.

IndexCheckr API token
  • The token is hidden by default: only its first and last four characters are shown. Click the eye icon to reveal or hide it.

  • Click the copy icon to copy the full token, whether it is hidden or not.

  • Click Rotate to replace your token with a new one, for example if you think it has leaked. The current token stops working immediately, so any script, integration or Chrome extension using it must be updated with the new token.

šŸ’” Note: Keep your API token secure and never share it. It grants full access to your credits and account data.

Team members don’t see the token: the API token of the account is managed by the account owner.

How the API works

The IndexCheckr API is RESTful, uses JSON, and responds with standard HTTP status codes. All requests must include your token in the X-AUTH-TOKEN header. Here's what you can do with it:

Account

  • Get your remaining credits

Projects

  • List all your projects, with summary stats (indexed, not indexed, domain not indexed, pending)

  • Create a new project, with its name, description, and starred status

  • Get project details

  • Delete a project

Pages

  • List pages in a project, filtered by status, URL, recheck frequency or tags, up to 100 pages per request

  • Add pages to a project: one page, or up to 2,000 URLs in a single request, with recheck frequency, stop-when-indexed and tags

  • Get a single page’s full info, including its indexer submissions

  • Update a page: change its URL, recheck settings or tags

  • Delete a page

  • Recheck a page immediately

  • Submit a page to your indexer (requires a connected indexer)

Changelog

  • Get the status changes of a project’s pages, the same data as the Changelog report. Use it to collect only what changed since your last call, or the history of one page.

Check a single URL

  • Check whether a URL is indexed and get the answer in the same request, without adding the URL to a project. This is what the Chrome extension uses for single-page checks.

Credits

Reading data (projects, pages, changelog, credits) is free. Calls that check pages use one credit per check, just like in the app: adding pages, rechecking a page, and checking a single URL. A single-URL check is only charged when it returns a result.

Rate limits

  • Up to 100 requests per minute for most endpoints.

  • Single-URL checks: up to 30 requests per 5 minutes.

  • Paging through a project’s pages: up to 20 page requests per minute. Request 100 pages at a time to go faster.

Above the limit, the API answers with HTTP status 429. Wait a moment and retry.

Typical use cases

  • Feed data into SEO dashboards
    Automatically integrate index status data into reports for clients or internal stakeholders.

  • Connect IndexCheckr with your CRM or internal tools
    Add URLs as soon as they are published or as soon as a backlink is built, and sync indexing data with your content workflows.

  • React to indexing changes
    Poll the changelog to be alerted when pages get indexed or drop out of the index.

šŸ‘‰ For full technical details, including endpoints, parameters, response formats and the API changelog, see the IndexCheckr API documentation. It is also linked from the API page, under API documentation.

šŸ‘‰ To integrate IndexCheckr with Google Sheets, see Using the IndexCheckr API with Google Sheets.

Did this answer your question?