Sitechecker Public API

The Sitechecker Public API lets you pull your SEO data into your own tools. You can automate reporting, build custom integrations, and run your own workflows on top of your project data. It is a REST API, so you can call it from any language or tool that can send an HTTP request.

Note! The Public API is available for customers on Premium plans.

For the full endpoint list and detailed guides, see:

Create an API key

You manage your keys in Account Settings, in the API keys tab. Only the account owner can create or revoke keys.

  1. Open Account Settings and go to the API keys tab.
  2. Click Create API key.
  3. Give the key a name so you can recognize it later, then click Create.
  4. Copy the key and store it somewhere safe.

Your full API key is shown only once, right after you create it. After you close the window you will only see the last 4 characters, so make sure you copy it first. You can create multiple named keys, so you can use a separate key per integration and revoke one without breaking the others.

Authenticate

Every request needs your API key in the Authorization header as a Bearer token.


Authorization: Bearer sk_live_xxxxxxxx

Your key only works while your account has API access, and it can only see projects your account owns.

Make a request

The base URL is https://sitechecker.pro/api/v1

For example, to get your account status and key limits:


curl -H "Authorization: Bearer sk_live_xxxxxxxx" \
     https://sitechecker.pro/api/v1/account

Foundation endpoints available now:

Endpoint Description
GET /api/v1/account Your account status and API key limits
GET /api/v1/tasks/{task_id} Status of an async task

The full and growing list of endpoints is in the API reference.

Response format

A successful response looks like this:


{
  "data": { ... },
  "meta": { ... },
  "task_id": "..."
}

Some heavier requests run in the background and return a task_id . You can then check that task at /api/v1/tasks/{task_id}  until it is ready.

An error looks like this:


{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

Rate limits

  • Up to 10 requests per second per key
  • Up to 60 requests per minute per IP before your key is verified

Monthly usage

Your usage is measured in API units. One API request equals one API unit. You can see your current usage and your monthly limit at the top of the API keys tab.

Revoke a key

If you no longer need a key, or think it may be exposed, open the API keys tab, find the key, and click Revoke. A revoked key stops working right away. To rotate a key, create a new one, update your integration, then revoke the old key.

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us