Инструменты · key

`wordstatapikeywords` Сбор запросов из Вордстата по маркерам

Собирает из Яндекс Вордстата запросы, содержащие переданные маркеры, — расширяет семантику. Найденные запросы фильтруются по стоп-словам, числу слов и частоте, по ним можно дособрать точную частоту и частоту в кавычках. Метод асинхронный: постановка возвращает report_id. Частоты готового списка без расширения собирает wordstatapi.

Режим: асинхронный: report_id
Маркеров в задаче: до 200
Глубина: до 10 страниц Вордстата на маркер
Стоимость: по числу обращений к Вордстату; списывается после выполнения

Постановка задачи

POST /api/wordstatapikeywords

Общая частота найденных запросов приходит всегда — её отдаёт сам Вордстат при сборе. Точная, в кавычках и фиксированная собираются вторым проходом, если их заказать.

Параметры query и тело формы

requests array обязательный

Маркерные фразы: массив requests[] или строка, по фразе на строку. До 200 штук.
lr array обязательный

Регионы Яндекса: массив lr[], можно несколько.
count_pages int

Сколько страниц выдачи Вордстата собирать по каждому маркеру. Больше 10 — обрезается до 10.
device string

Тип устройств. Любое другое значение — все устройства.

desktop
десктопы

mobile
мобильные
exact int

1 — дособрать точную частоту найденных запросов.
quoted int

1 — дособрать частоту в кавычках.
fixed int

1 — дособрать точную частоту с фиксированным порядком слов (поле exact_fixed).
stop_list array

Стоп-слова: запросы с ними отбрасываются. Массив stop_list[] или строка, по слову на строку.
min_count_words int

Отбросить запросы короче указанного числа слов.
max_count_words int

Отбросить запросы длиннее указанного числа слов.
min_overall_frequency int

Отбросить запросы с общей частотой ниже указанной.
delete_special_characters int

1 — убрать + из запросов в ответе.
delete_zero_keywords int

1 — убрать запросы с нулевой общей или точной частотой.

Ответ

report_id int

ID задачи для получения результата.

POST /api/wordstatapikeywords

curl -X POST 'https://tools.pixelplus.ru/api/wordstatapikeywords?key=ВАШ_КЛЮЧ' \
  --data-urlencode 'requests[]=купить диван' \
  --data-urlencode 'lr[]=213' \
  --data-urlencode 'count_pages=2'

<?php
$url = 'https://tools.pixelplus.ru/api/wordstatapikeywords?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => http_build_query([
        'requests' => [
            'купить диван',
        ],
        'lr' => [
            213,
        ],
        'count_pages' => 2,
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.post(
    "https://tools.pixelplus.ru/api/wordstatapikeywords",
    params={
        "key": "ВАШ_КЛЮЧ",
    },
    data=[
        ("requests[]", "купить диван"),
        ("lr[]", 213),
        ("count_pages", 2),
    ],
    timeout=60,
)
print(response.json())

requests обязательный Маркерные фразы: массив requests[] или строка, по фразе на строку · по одному на строку lr обязательный Регионы Яндекса: массив lr[], можно несколько · по одному на строку count_pages Сколько страниц выдачи Вордстата собирать по каждому маркеру

Запрос настоящий — выполнится с вашим ключом

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

{
    "report_id": 2617070
}

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

GET /api/wordstatapikeywords

Пока задача выполняется, приходит {"error": "In progress", "code": 50}. Готовый результат — объект: найденный запрос → регион → данные. Незаказанные частоты в ответ не попадают.

Параметры query

report_id int обязательный

ID задачи из ответа на постановку.

Ответ

{запрос}.{регион}.from string

Откуда запрос: Исходная фраза — сам маркер, Левая колонка — найден в Вордстате.
{запрос}.{регион}.source_query string

Маркер, по которому найден запрос.
{запрос}.{регион}.overall int

Общая частота.
{запрос}.{регион}.exact, quoted, exact_fixed int

Дополнительные частоты, если заказаны.

GET /api/wordstatapikeywords

curl -G 'https://tools.pixelplus.ru/api/wordstatapikeywords' \
  --data-urlencode 'key=ВАШ_КЛЮЧ' \
  --data-urlencode 'report_id=2617070'

<?php
$url = 'https://tools.pixelplus.ru/api/wordstatapikeywords?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
    'report_id' => 2617070,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/api/wordstatapikeywords",
    params={
        "key": "ВАШ_КЛЮЧ",
        "report_id": 2617070,
    },
    timeout=60,
)
print(response.json())

report_id обязательный ID задачи из ответа на постановку

Запрос настоящий — выполнится с вашим ключом

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

{
    "купить диван": {
        "213": {
            "from": "Исходная фраза",
            "overall": 14967,
            "exact": 1310,
            "source_query": "купить диван"
        }
    },
    "купить диван недорого": {
        "213": {
            "from": "Левая колонка",
            "overall": 2690,
            "exact": 912,
            "source_query": "купить диван"
        }
    }
}

Ошибки

Код	Сообщение	Когда
`-50`	`{поле: описание}`	Ошибки параметров: в `error` — объект «поле → сообщение» (`requests`, `lr`, `requests_count` — больше 200 маркеров, `limits` — не хватает лимитов на оценку). Запрос не методом POST — `["Data not set"]`.
`-60`	`To many tasks from one user. Try again later.`	Уже идут 5 задач этого метода.
`50`	`In progress`	Задача ещё выполняется.
`-4`	`Access denied`	`report_id` чужой или от другого инструмента.
`-104…-107, -125`	`Processing error / Limits run out / …`	Задача завершилась ошибкой — см. асинхронные задачи.
`-68, -80…-83`	`Not enough … limits`	Исчерпан дневной, часовой, недельный, месячный или годовой лимит.
`-1, -2`	`Access denied`	Ключ не передан (HTTP 404) или не найден (HTTP 403).

Ответ с ошибкой

{
    "error": {
        "requests_count": "Превышено максимальное количество запросов, на вашем тарифе максимум доступно 200"
    },
    "code": -50
}

Сколько стоит

При постановке проверяется, хватит ли лимитов на оценку: маркеры × count_pages × 50 × регионы × число дополнительных частот плюс по 1 лимиту за маркер. Фактический расход — по числу обращений к Вордстату — списывается после выполнения.

Передавайте count_pages явно: без него в задачу уходит глубина 0, а оценка стоимости не учитывает страницы. Регионы — массивом lr[], даже если регион один.

Параметр frequency_relations, который был в прежнем описании, в этом режиме не работает — соотношение частот считает только wordstatapi.

wordstatapikeywords Сбор запросов из Вордстата по маркерам

Постановка задачи

Параметры query и тело формы

Ответ

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

Параметры query

Ответ

Ошибки

Сколько стоит

`wordstatapikeywords` Сбор запросов из Вордстата по маркерам