API: Получение данных Яндекс.Вордстат

API позволяет получить статистику по ключевым словам из сервиса Яндекс.Вордстат через инструмент PR-CY.
Можно собирать общую статистику, статистику с операторами, а также получать похожие и включающие фразы.

Логика работы API

Создать задачу — отправляем POST-запрос с ключевыми словами, регионом и типом поиска.
В ответ получаем ID задачи.
Получить результат — отправляем GET-запрос по ID задачи.
В ответе возвращаются данные Wordstat.

1. Создание задачи

POST:

https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/

Параметры запроса (`params`)

Параметр	Обязательный	Тип	Описание
`toolName`	✅	string	Название инструмента: всегда `"wordstatChecker"`
`region`	✅	integer	Код региона Яндекса (см. список регионов Яндекса)
`type`	✅	string	Тип запроса (см. ниже список)
`needRelatedPhrases`	❌	boolean	`true` — собирать похожие фразы, `false` — не собирать
`needIncludingPhrases`	❌	boolean	`true` — собирать популярные фразы, содержащие ключевое слово
`keywords`	✅	string	Ключевые слова через запятую
`engine`	✅	string	Поисковая система: всегда `"yandex"`

Поддерживаемые значения `type`

Значение	Описание
`general`	Общая (без операторов). Пример: `купить слона`
`quoted`	В кавычках (фраза в кавычках). Пример: `"купить слона"`
`exact`	Точная (с кавычками и восклицательными знаками перед каждым словом). Пример: `"!купить !слона"`

Пример запроса

curl 'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/' \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'Api-Key: ***' \
  --data-raw '{
    "data": {
      "type": "toolTasks",
      "attributes": {
        "toolName": "wordstatChecker",
        "params": {
          "region": 213,
          "type": "general",
          "needRelatedPhrases": true,
          "needIncludingPhrases": true,
          "keywords": "купить слона, сколько стоит слон",
          "engine": "yandex"
        }
      }
    }
  }'

2. Ответ при создании задачи

API вернёт ID задачи:

{
  "data": {
    "type": "toolTasks",
    "id": "2a67cb477beceb3a677bcf1592214e24",
    "attributes": {..}
  }
}

3. Получение результатов

GET:

https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/{task_id}?filter[since]=0&include=tests

Пример запроса

curl --location --globoff \
'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/62b55f1b3f2d430123456789abcdef12?filter[since]=0&include=tests' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Api-Key: ***' \

Где:

{task_id} — ID задачи, полученный в шаге 1.
filter[since]=0 — фильтр по времени (0 = с начала).
include=tests — выдаёт подробный результат.

Не нашли нужной информации? Напишите нам в тех.поддержку

🍪 Используя сайт, вы соглашаетесь с обработкой cookie и сбором технических данных для улучшения работы сайта согласно политике конфиденциальности.

API: Получение данных Яндекс.Вордстат

Логика работы API

1. Создание задачи

Параметры запроса (params)

Поддерживаемые значения type

Пример запроса

2. Ответ при создании задачи

3. Получение результатов

Пример запроса

Параметры запроса (`params`)

Поддерживаемые значения `type`