Wordstat API

The API is used to receive Wordstat data in a format suitable for automatic processing. The current supported format is JSON. The API is accessed over HTTPS. URL for API requests: https://api.wordstat.yandex.net.

To access the API:

  1. Get an OAuth token.
  2. Register the ClientId.
  3. Pass the token in each request in the Authorization HTTP header: Authorization: Bearer <OAuth token>.

How to connect to the Wordstat API

Step 1. Log in with Yandex ID

  1. If you don't have a Yandex username, create a Yandex ID account.
  2. Log in with Yandex ID.

Step 2. Get an OAuth token.

On the app page, create an app and obtain a token:

  1. Under Redirect URI, select Enter URL for debugging.

    api-redirect-uri.png

  2. Select access to at least one data type.

    api-access-to-data.png

Step 3. Register the ID

On the page of the created app, find the ClientId.

api-client-id.png

Step 4. Submit a request for API access

To connect to the API, contact the Yandex Direct support, providing your username and ClientId.

Connection request form

Usage limitations

API access is limited by a quota. There are two quota types:

  • Total quota on the entire API. If you exceed it, you will receive the following HTTP response: 503 Service unavailable, try again later.

  • Personal quota linked to an OAuth token with limitations:

    • On the number of requests per second (avoid initiating too many requests at the same time not to overload the service).
    • On the number of requests per day.

    If you exceed it, you will receive the following HTTP response: 429 Quota limit exceeded, try again later. Time to refill: N seconds. The response will contain an estimated time when you can access the API again.

Previous
Stop word rules
Next
Structure of the API