Получайте поисковую выдачу с нами!
Если запрос API завершается неудачно, API-интерфейс возвращает объект JSON, содержащий сведения об ошибке. Ниже приведены примеры ошибок, которые возвращаются, если был достигнут максимально допустимый предел запросов API.
Код |
Описание |
|---|---|
100 |
Пользователь не предоставил ключ API. |
101 |
Пользователь предоставил неверный ключ API. |
102 |
Пользователь исчерпал баланс на аккаунте. |
103 |
Пользователь исчерпал ежемесячное разрешение на подписку. |
104 |
Аккаунт пользователя неактивен или заблокирован. |
105 |
Пользователь не указал обязательное значение в параметре [query]. |
106 |
Пользователь не указал обязательное значение в параметре [system]. |
300 |
Ошибка при получении результатов поиска. |
301 |
Ошибка при получении результатов поиска с HTTP-кодом. |
302 |
Ошибка при получении результатов поиска с кодом ошибки Яндекс API. |
399 |
Запрос API не выполнен из-за неизвестной ошибки. Пожалуйста, обратитесь в службу поддержки и сообщите об ошибке. |
Параметры HTTP GET запроса
Параметр |
Важность |
Описание |
|---|---|---|
api_key |
Обязательно |
Ваш ключ доступа к API, доступный на панели инструментов вашего аккаунта |
query |
Обязательно |
Укажите любой запрос для поиска (поддерживаются расширенные операторы, такие как site:) |
system |
Обязательно |
Укажите любую поисковую систему google, yandex, bing (по умолчанию: google) |
domain |
– |
Укажите, какой домен поисковой системы использовать: ru (по умолчанию). Другие домены Яндекса: ua, by, kz, com, com.tr |
result_cnt |
– |
Укажите количество результатов (по умолчанию: 10 – показывает 10 обычных результатов, MAX – 100). Для "живой" выдачи Яндекса MAX значение ТОП выдачи равно 10 результатам |
lr |
– |
Укажите географическое местоположение для вашего запроса, который будет обрабатываться с использованием идентификатора локального региона в формате Яндекса (по умолчанию: 213 (Москва)). Список поддерживаемых местоположений lr.csv |
source |
– |
Источник данных: Яндекс XML (по умолчанию) либо "живая" выдача Яндекса. Значения параметра: yandex_xml / yandex_live |
page |
– |
Указание номера страницы с поисковой выдачей по ТОП-10. Страницы нумеруются начиная с нуля (&page=0 – первая страница). Параметр имеет значение только для "живой" выдачи Яндекса |
output_format |
– |
Представление результатов выдачи Яндекса: JSON (по умолчанию) / XML. Значения параметра: json / xml |
Параметры HTTP GET запроса
Параметр |
Важность |
Описание |
|---|---|---|
api_key |
Обязательно |
Ваш ключ доступа к API, доступный на панели инструментов вашего аккаунта |
query |
Обязательно |
Укажите любой запрос для поиска (поддерживаются расширенные операторы, такие как intext:) |
system |
Обязательно |
Укажите любую поисковую систему google, yandex, bing (по умолчанию: google) |
domain |
– |
Укажите, какой домен поисковой системы использовать: com, de, fr и т.д. (по умолчанию: com). Скачать список всех поддерживаемых доменов domains.csv |
result_cnt |
– |
Укажите количество результатов (по умолчанию: 10 – показывает 10 обычных результатов, MAX – 100 (10, 50, 100)) |
hl |
– |
Укажите язык, который будет использоваться для вашего запроса (по умолчанию: en для английского). Скачать список всех поддерживаемых языков languages.csv |
gl |
– |
Укажите код страны, который будет использоваться для вашего запроса (по умолчанию: en для English). Скачать список поддерживаемых двухбуквенных кодов стран countries.csv |
location |
– |
Укажите географическое местоположение для вашего запроса, который будет обрабатываться с использованием произвольного текста в формате Google (который автоматически преобразуется в строку UULE). Скачать список поддерживаемых местоположений locations.csv |
device |
– |
Укажите, какое устройство использовать: desktop (по умолчанию) или mobile |
output_format |
– |
Представление результатов выдачи Google: JSON (по умолчанию) / XML. Значения параметра: json / xml |
Параметры HTTP GET запроса
Параметр |
Важность |
Описание |
|---|---|---|
api_key |
Обязательно |
Ваш ключ доступа к API, доступный на панели инструментов вашего аккаунта |
query |
Обязательно |
Укажите любой запрос для поиска (поддерживаются расширенные операторы, такие как intext:) |
system |
Обязательно |
Укажите любую поисковую систему google, yandex, bing (по умолчанию: google) |
result_cnt |
– |
Укажите количество результатов (по умолчанию: 10 – показывает 10 обычных результатов, MAX – 100 (10, 50, 100)) |
lang |
– |
Укажите язык, который будет использоваться для вашего запроса (по умолчанию: en для английского). Скачать список всех поддерживаемых языков languages.csv |
country |
– |
Укажите код страны, который будет использоваться для вашего запроса (по умолчанию: en для English). Скачать список поддерживаемых двухбуквенных кодов стран markets.csv |
device |
– |
Укажите, какое устройство использовать: desktop (по умолчанию) или mobile |
Параметр |
Описание |
|---|---|
position |
Возвращает позицию текущего результата органического поиска во всем списке результатов |
link |
Возвращает фактический URL органического результата поиска |
title |
Возвращает заголовок органического результата поиска |
snippet |
Возвращает описание органического результата поиска |
res_found |
Возвращает число найденных результатов в поисковых системах Яндекс и Google (также можно получить число страниц сайта в индексе по оператору site:) |
