How to Use an API

How to Use an API

seoClarity APIs

Standard API

Data for any element that you already track in your seoClarity account is available to you free of charge through the standard API. Learn more
Our paid API, seoClarity.dev, is an add-on feature that can be enabled by request via your Client Success Manager or support@seoclarity.net. Get access to the same data ocean and core capabilities that power the seoClarity.net platform. Learn more

Requirements for Sending a Request

Below are the requirements you will need to send a request to seoClarity's API endpoints. Note the differences between our standard and paid API endpoints.

API key

The request header will need to include your API key. The keys are unique to each user and should not be shared.
  1. Generate your API token. Learn more
  2. Contact support@seoclarity.net for paid tokens to be upgraded.
The standard and paid APIs have different formats for sending the key in your request header. Your token will be a series of letters and numbers.
  1. Standard: access_token
    1. Example: access_token=yourAccessToken
  2. Paid: x-api-key
    1. Example: x-api-key=yourAccessToken

Endpoints

  1. Full list of endpoints can be found at https://kb.seoclarity.net/portal/en/kb/articles/paid-api-documentation

Request Method

POST: Send your request including the parameters for the data you would like to receive in your results. The response will include the taskId.
GET: Send the taskId from the POST response to receive the URL to access your data file.
  1. taskId exmaple: task_id_lettersAndNumbersSpecificToYourRequest

Parameters

Parameters are the instructions sent in the request identifying the data to be sent back in the data file, filter specifications, and a storage location for the data to be sent to.
The parameters can be included as part of the API request in the URL query string or the request body field.

Examples

Standard API

URL query string example
  1. http://api.seoclarity.net/seoClarity/keyword?access_token=XXXXXXXXXX&kname=XXXX&tagid=XXXX&oid=XXXX&engine=XXXX&market=XXXX&sdate=XXXX&edate=XXXX&limit=XXXX&offset=XXXX&plpType=XXXX&competitor=XXXX&device=XXXX&type=XXXX&enableLocation=XXXX
Request body example
  1. {
        "device": "desktop",
        "top": 10,
        "startDate": 20250201,
        "endDate": 20250201,
        "query": {
            "filters": [
                {
                    "name": "domains",
                    "operation": "ct",
                    "value": "www.example.com"
                },
                {
                    "name": "rank",
                    "operation": "between",
                    "value": "[]"
                },
                {
                    "name": "keyword",
                    "operation": "ct",
                    "value": "example keyword"
                }
            ]
        }
    }
URL query string:
  1. https://data.seoclarity.net/v1/task/backlink-gaps?x-api-key=yourAccessToken&domainName=example.com&competitorDomains=example.com&totalSize=10
Request body:
{
  "domainName": "example.com",
  "competitorDomains": ["competitor1.com", "www.competitor2.com", "competitor3.com"],
  "totalSize": 1000
}

    • Related Articles

    • Standard API Data

      Standard API Overview seoClarity's API provides you programmatic access to a wealth of data, statistics and information collected by the seoClarity platform. The API is designed to be extremely simple to use and flexible to accommodate a wide range ...

    • What is an API?

      API stands for Applications Program Interface which is a set of protocols or routines in order to share data. Each call queries a certain set of data based on the tasks it is supposed to accomplish. The API acts almost as a translator of ...

    • How does seoClarity manage the rate limit associated with the Moz free API?

      We retrieve the SEOmoz data once a month to coincide with their update schedule. Only when you add a new Target URL or Partner URL to the system will the system then query the API for data specific to that URL between scheduled updates. This ensures ...

    • seoClarity.dev API Data

      seoClarity.dev is an add-on feature that can be enabled by request via your Client Success Manager or support@seoclarity.net. Get access to the same data ocean and core capabilities that power the seoClarity.net platform. Build your own tools, ...

    • How to use Actionable Insights

      Actionable Insights (found in the Dashboards section of seoClarity) is a powerful feature that automatically detects and prioritizes over 120 SEO issues and opportunities. Here's how to use it to automate your SEO task prioritization process: