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

API Букварикса

получение информации по доменам в автоматическом режиме

Запрос информации по домену осуществляется по следующим URL:

http://api.bukvarix.com/v1/site/ - запрос ключевых слов по одному домену;

http://api.bukvarix.com/v1/site_cmp/ - сравнение ключевых слов двух доменов;

http://api.bukvarix.com/v1/site_mcmp/ - сравнение ключевых слов нескольких доменов (больше двух).

Обязательные параметры запроса данных по одному домену:
Название параметра Тип Описание
q текст домен
api_key текст ключ API
Обязательные параметры запроса данных по двум доменам:
Название параметра Тип Описание
q текст первый домен для сравнения
q2 текст второй домен для сравнения
api_key текст ключ API
Обязательные параметры запроса данных по нескольким доменам:
Название параметра Тип Описание
q текст список доменов, каждый с новой строки, смотрите пример
api_key текст ключ API

Примечания:

Можно указать как домен, так и поддомен, например:

domain.com - если нужны ключевые слова для всего домена,

suddomain.domain.com - если нужны ключевые слова для конкретного поддомена.

Протокол и страницы указывать не нужно, только домен (или поддомен).

Правильно: domain.com или subdomain.domain.com

Неправильно: http://domain.com/index.html

Кириллические домены (например, .рф, .укр, .блог) нужно передавать кириллицей по правилам percent-encoding (конвертировать в punycode не нужно). Например, домен кто.рф нужно передавать как %D0%BA%D1%82%D0%BE.%D1%80%D1%84

Запрос данных для одного домена и сравнение двух доменов осуществляется методом GET.

Запрос данных для нескольких доменов осуществляется методом POST.

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

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

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

http://api.bukvarix.com/v1/site/?q=wildberries.ru&api_key=free

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

http://api.bukvarix.com/v1/site_cmp/?q=wildberries.ru&q2=lamoda.ru&api_key=free

Опциональные параметры запроса:
Название параметра Тип Описание
num число количество строк в отчете (по умолчанию возвращается 250, максимально допустимое количество строк 1000000 для бесплатной версии API)
format текст формат данных, допустимые значения: txt, json, csv, tsv (в нижнем регистре; если формат данных опущен или указан неверно, то подразумевается txt)
bom булево записывать (1) или нет (0) в начале файла сигнатуру UTF-8 (3 байта EF BB BF), если не указано то в зависимости от формата берется значение по умолчанию
header булево передавать (1) или нет (0) заголовки столбцов таблицы; параметр используется при запросе данных в форматах csv и tsv, по умолчанию заголовки передаются
json_type текст используется при передаче данных в формате json, значения object (объект) или array (массив); по умолчанию используется значение object
region текст регион поисковой машины, по которому запрашивалась поисковая выдача; допустимые значения:
msk - Москва (Яндекс),
gmsk - Москва (Google),
spb - СПб (Яндекс),
rus - Россия (Яндекс),
nsk - Новосибирск (Яндекс),
ekb - Екатеринбург (Яндекс),
kzn - Казань (Яндекс),
nnv - Н. Новгород (Яндекс),
kry - Красноярск (Яндекс),
che - Челябинск (Яндекс),
sam - Самара (Яндекс),
ufa - Уфа (Яндекс),
rnd - Ростов-на-Дону (Яндекс),
krr - Краснодар (Яндекс),
oms - Омск (Яндекс),
vrn - Воронеж (Яндекс),
prm - Пермь (Яндекс),
vlg - Волгоград (Яндекс),
sar - Саратов (Яндекс),
tmn - Тюмень (Яндекс),
tom - Томск (Яндекс),
gkiev - Киев (Google),
minsk - Минск (Яндекс),
gminsk - Минск (Google),
nursul - Астана (Яндекс).
При отсутствии параметра region в запросе данные запрашиваются по региону msk - (Яндекс Москва).
comparison_type текст используется для определения типа сравнения двух доменов, которое нужно получить; значения: intersect (пересечение, т.е. общие для двух доменов ключевые слова), domain1_uniq (ключевые слова, являющиеся уникальными для первого домена), domain2_uniq (ключевые слова, являющиеся уникальными для второго домена); по умолчанию используется значение intersect.
result_count булево передавать (1) или нет (0) общее количество полученных результатов (например, количество найденных ключевых слов для домена по поиску домена), а не данные; если параметр не указан, то общее количество результатов не передается, а передаются данные.

Пример получения первой 1000 результатов одного домена в формате csv для региона Яндекс СПб:

http://api.bukvarix.com/v1/site/?q=wildberries.ru&api_key=free&num=1000&format=csv&region=spb

Пример получения уникальных результатов для первого домена при сравнении ключевых слов двух доменов в формате csv для региона Яндекс Россия:

http://api.bukvarix.com/v1/site_cmp/?q=wildberries.ru&q2=lamoda.ru&api_key=free&comparison_type=domain1_uniq&format=csv&region=rus

Пример выполнения запроса сравнения нескольких доменов методом POST :

Примечание:

В бесплатной версии API можно сравнивать не более 10 доменов.

Мы подготовили пример использования API для интегрирования на странице вашего сайта сервис подбора ключевых слов с поиском по доменам. Мы также сделали для этого очень простую инструкцию.

© 2024 Букварикс