API: ключевые слова сайта в поисковой выдаче

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

API возвращает ключевые слова, позиции и статистику по домену или странице. Перед началом получите API-ключ.

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

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

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

POST:

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

Параметры запроса

Параметры передаются в params.

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

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 — выводит подробные результаты анализа.

Получение всех запросов

Для получения всех ключевых слов домена через API, вы можете воспользоваться следующим запросом:

curl 'https://apis.pr-cy.ru/api/v2.1.0/exports/toolTest' \
 --header 'Content-Type: application/vnd.api+json' \
 --header 'Api-Key: YOUR_API_KEY' \
 --data-raw '{
 "data": {
   "type": "toolTestsExports",
   "attributes": {
     "taskId": "YOUR_ID_TASK",
     "testName": "reportOrganicKeywordsTool",
     "format": "csv",
     "extraData": {
       "limit": 300000
     }
   }
 }
}'

Поисковые системы и регионы

Код базы передается в base.

Смежные инструкции

• Как добавить конкурентов?