API: Ключевые слова сайта найденные в выдаче

Данный API позволяет получить сводку по поисковой выдаче для заданного домена или отдельной страницы.
Аналогично инструменту — PR-CY Website Keywords.

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

Создаём задачу — отправляем POST-запрос с параметрами (домен, регион, путь).
В ответ получаем id задачи.
Запрашиваем результаты — по id задачи делаем GET-запрос.
Получаем список ключевых слов, их позиции и другую статистику.

Метод создания задачи

POST:

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

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

Параметр	Обязательный	Тип	Описание
`toolName`	✅	string	Название инструмента: `"websiteKeywords"`
`domain`	✅	string	Домен сайта (без `https://`)
`base`	✅	string	Регион поиска (см. ниже список кодов)
`path`	✅	string	Путь страницы: если нужен анализ ВСЕГО домена — `"/"`, если конкретной страницы — относительный адрес (`/about`)

Пример запроса (домен)

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": "websiteKeywords",
        "params": {
          "domain": "ria.ru",
          "base": "msk",
          "path": "/"
        }
      }
    }
  }'

➡ Получаем сводку по всему сайту ria.ru в регионе "Яндекс: Москва".

Пример запроса (страница)

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": "websiteKeywords",
        "params": {
          "domain": "ria.ru",
          "base": "msk",
          "path": "/world"
        }
      }
    }
  }'

➡ Получаем сводку по странице https://ria.ru/world/ в регионе "Яндекс: Москва".

Ответ на создание задачи

В ответ API сначала возвращает ID задачи:

{
  "type": "toolTasks",
  "id": "5a124a6891616b0ae13db4bd48fef37",
  "attributes": {
    "params": {...},
    "isExpired": false,
    "isUpdating": true,
    "cost": 1,
    "started": "2025-01-11T17:00:51+03:00",
    "updated": "2025-01-11T17:00:49+03:00",
    "until": 0
  }
}

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

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/5a124a6891616b0ae13db4bd48fef37?filter[since]=0&include=tests' \
--header 'Content-Type: application/vnd.apijson' \
--header 'Api-Key: ***' \
--data ''

Где:

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

Список значений `base` (регион)

Код	Описание
`msk`	Яндекс: Москва
`gru`	Google: Москва
`spb`	Яндекс: Санкт-Петербург
`ekb`	Яндекс: Екатеринбург
`krr`	Яндекс: Краснодар
`nnv`	Яндекс: Н. Новгород
`rnd`	Яндекс: Ростов-на-Дону
`gkv`	Google: Киев
`mns`	Яндекс: Минск
`gmns`	Google: Минск
`kzn`	Яндекс: Казань
`oms`	Яндекс: Омск
`vlg`	Яндекс: Волгоград
`nsk`	Яндекс: Новосибирск
`che`	Яндекс: Челябинск
`sam`	Яндекс: Самара
`ufa`	Яндекс: Уфа
`kry`	Яндекс: Красноярск
`prm`	Яндекс: Пермь
`vrn`	Яндекс: Воронеж
`sar`	Яндекс: Саратов
`gny`	Google: Нью-Йорк (США)
`tmn`	Яндекс: Тюмень
`tom`	Яндекс: Томск

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

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