Документация API

Ниже представлены доступные эндпоинты для получения данных из поисковых систем и Вордстата.

Содержание

Аутентификация
/yandex
/yandex/xml
/wordstat

Аутентификация

Все JSON методы API используют единый способ аутентификации.

Bearer Token аутентификация:

Токен должен быть передан в заголовке запроса.

Authorization: Bearer YOUR_API_TOKEN

/yandex

Получение поисковой выдачи из Яндекс.

Метод:

GET https://jsonseo.ru/api/yandex

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

text* — поисковый запрос
region — ID региона (по умолчанию: 213)
pages — количество страниц выдачи (от 1 до 20, по умолчанию - 1)
filter — фильтрация поиска (none, moderate, strict, по умолчанию - moderate)
noreask — отключение автоматического исправления запроса (0 или 1, по умолчанию - 0)
zone — доменная зона поиска (ru, com, kz, kk, by, be, uz, tr,com.tr, по умолчанию - ru)
break_domain — домен, на котором остановить поиск (example.com)
Поможет сократить стоимость и время поиска, в сценариях когда нужно получить только позицию.

Стоимость запроса:

0.01₽ × количество страниц

Указывается максимальное количество страниц, которое нужно получить. Если поиск вернёт меньше страниц, чем вы запросили, списание произойдёт только за фактически полученные страницы.

Пример ответа:


{
    "pages": 1,
    "query": "купить ноутбук",
    "rawQuery": "купть ноутбук",
    "results": [
        {
            "url": "https://www.VZON.ru/category/noutbuki-15692/",
            "domain": "www.vzon.ru",
            "title": "Ноутбуки – купить ноутбук на VZON по низкой цене",
            "passage": "Ноутбуки – покупайте на VZON по выгодным ценам, быстрая и бесплатная доставка...",
            "breadcrumbs": "vzon.ru›Электроника›Ноутбуки, планшеты и электронные книги"
        }
    ]
}

/yandex/xml

Получение поисковой выдачи Яндекса в формате XML.

Этот эндпоинт предназначен для интеграции в приложения и может использоваться вместо сервисов XMLRiver, XMLStock, XMLProxy, XMLSeo. Готовый URL для запросов доступен в личном кабинете.

Метод:

GET https://jsonseo.ru/api/yandex/xml

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

query* — поисковый запрос
lr — ID региона (по умолчанию- 213)
device — устройство (desktop, mobile, tablet по умолчанию - desktop)
domain — доменная зона поиска (ru, com, kz, kk, by, be, uz, tr,com.tr, по умолчанию - ru)
groupby – количество позиций для сбора (кратное 10, по умолчанию — 10).
page – номер страницы (нумерация начинается с нуля, по умолчанию — 0, первая страница).

При использовании параметра page учитывайте, что количество результатов на каждой странице соответствует значению groupby. Рекомендуется вместо пагинации увеличивать groupby, чтобы получить выдачу в рамках одной сессии.

Стоимость запроса:

0.01₽ × количество страниц

Количество страниц = (количество позиций ÷ 10). Например: 100 позиций = 10 страниц = 0.1₽.

Пример ответа:

/wordstat

Получение данных по частотности запросов из Яндекс Вордстата.

Метод:

GET https://jsonseo.ru/api/wordstat

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

text* — ключевое слово или фраза
region — ID регионов через запятую (по умолчанию: all)
device — типы девайсов через запятую (по умолчанию: desktop,phone,tablet)
pages — сколько страниц популярных и похожих запросов собирать (от 1 до 20, по умолчанию - 1)

Стоимость запроса:

0.01₽ × количество страниц

Указывается максимальное количество страниц, которое нужно получить. Если Вордстат вернёт меньше страниц, чем вы запросили, списание произойдёт только за фактически полученные страницы.

Пример ответа:


{
    "text": "ремонт айфона",
    "pages": 5,
    "results": {
        "totalValue": 128929,
        "popular": [
            {
                "text": "ремонт айфонов",
                "value": 128927
            },
            {
                "text": "сколько ремонт айфона",
                "value": 8365
            }
        ],
        "associations": [
            {
                "text": "починить телефон",
                "value": 30546
            }
        ]
    }
}