menu
Общая информация Поиск по словам Поиск по доменам

API Букварикса

получение ключевых слов в автоматическом режиме

Запрос ключевых слов осуществляется по следующим URL:

http://api.bukvarix.com/v1/keywords/ - простой поиск (по одному ключевому слову), метод GET;

http://api.bukvarix.com/v1/mkeywords/ - расширенный поиск (по списку ключевых слов), метод POST.

Обязательные параметры запроса:
Название параметра Тип Описание
q текст ключевое слово
api_key текст ключ API

Примечание:

В режиме расширенного поиска параметр q служит для запроса списка слов (каждую запрашиваемую ключевую фразу нужно вводить с новой строки). Таким образом можно запросить список до 100 строк. При превышении лимита 101-я и следующие за ней строки будут игнорироваться при запросе.

Запрашивать ключевые слова можно с использованием специального синтаксиса запросов, например, строител* товары (в результатах: строительные товары, товары для строительства, гипермаркет строительных товаров, магазин строитель товары) или !строительные !товары (в результатах: строительные товары вологда, купить строительные товары, строительные товары оптом, сезонные строительные товары). Подробнее о специальном синтаксисе запросов ключевых слов...

Возвращаемые данные:

По умолчанию в отчете 250 строк в формате txt.

Пример данных без опциональных параметров:

http://api.bukvarix.com/v1/keywords/?q=%D0%BF%D0%BB%D0%B0%D1%81%D1%82%D0%B8%D0%BA%D0%BE%D0%B2%D1%8B%D0%B5+%D0%BE%D0%BA%D0%BD%D0%B0&api_key=free

Опциональные параметры запроса:
Название параметра Тип Описание
num число количество строк в отчете (по умолчанию возвращается 250, максимально допустимое количество строк 1048575)
format текст формат данных, допустимые значения: txt, json, csv, tsv (в нижнем регистре; если формат данных опущен или указан неверно, то подразумевается txt)
bom булево записывать (1) или нет (0) в начале файла сигнатуру UTF-8 (3 байта EF BB BF), если не указано то в зависимости от формата берется значение по умолчанию
q2 текст список слов-исключений, который можно использовать в режиме расширенного поиска; допустимый размер такого списка - 100 строк, при превышении размера 101-я строка и следующие за ней игнорируются
header булево передавать (1) или нет (0) заголовки столбцов таблицы; параметр используется при запросе данных в форматах csv и tsv, по умолчанию заголовки передаются
json_type текст используется при передаче данных в формате json, значения object (объект) или array (массив); по умолчанию используется значение object
report_type текст используется для переключения типа отчета как в режиме простого, так и расширенного поиска, значения report (отчет) или word_analysis (анализ); по умолчанию используется значение report
result_count булево передавать (1) или нет (0) общее количество полученных результатов (например, количество найденных вхождений с ключевым словом по поиску ключевого слова), а не данные; если параметр не указан, то общее количество результатов не передается, а передаются данные.

Пример получения первых 1000 результатов в формате CSV:

http://api.bukvarix.com/v1/keywords/?q=%D0%BF%D0%BB%D0%B0%D1%81%D1%82%D0%B8%D0%BA%D0%BE%D0%B2%D1%8B%D0%B5+%D0%BE%D0%BA%D0%BD%D0%B0&api_key=free&num=1000&format=csv

Опциональные параметры для фильтрации результатов:
Название параметра Тип Описание
broad_from число широкая частотность от
broad_to число широкая частотность по
exact_from число точная частотность от
exact_to число точная частотность по
length_from число длина фразы от
length_to число длина фразы по
words_from число количество слов от
words_to число количество слов по

Пример данных с фильтрацией результатов по количеству слов во фразе от 3 по 7 включительно:

http://api.bukvarix.com/v1/keywords/?q=%D0%BF%D0%BB%D0%B0%D1%81%D1%82%D0%B8%D0%BA%D0%BE%D0%B2%D1%8B%D0%B5+%D0%BE%D0%BA%D0%BD%D0%B0&api_key=free&words_from=3&words_to=7

Примечание: Не обязательно указывать фильтр от и по, можно указать только одну (необходимую) часть.

Например, если нужно отфильтровать по количеству слов начиная с 3 (без верхней границы), то запрос будет выглядеть следующим образом:

http://api.bukvarix.com/v1/keywords/?q=%D0%BF%D0%BB%D0%B0%D1%81%D1%82%D0%B8%D0%BA%D0%BE%D0%B2%D1%8B%D0%B5+%D0%BE%D0%BA%D0%BD%D0%B0&api_key=free&words_from=3

Пример выполнения запроса методом POST (по списку ключевых слов с применением списка слов-исключений):

© 2018 Букварикс