Параметры

Мы принимаем GET и POST запросы с параметрами, которые соответствуют параметрам старого Yandex XML, кроме параметра apikey, который будет проигнорирован.

Все запросы должны отправляться на URL https://xmlriver.com/yandex/xml?user=[ваш_id]&key=[ваш_ключ].

Параметры XMLRiver

Наименование

Обязательно Описание
query да

Фраза для поиска.

lr нет

ID региона поиска по классификатору Яндекса.

l10n нет

Язык уведомлений и ошибок в ответе.

sortby нет

Порядок сортировки результатов: rlv (по релевантности), tm (по дате изменения).
Можно использовать дополнительные параметр descending (прямая сортировка) или ascending (обратная)

filter нет

Фильтрация страниц с «взрослым» контентом: none (выкл), moderate (умеренный), strict (строгий)

maxpassages нет Макс. количество пассажей (фрагментов) на документ от 1 до 5 (по умолчанию 2)
groupby нет

Составной параметр группировки результатов в URL:
attr=d.mode=deep.groups-on-page=10.docs-in-group=1

attr=<служебный_атрибут>.mode=<тип_группировки>.groups-on-page=<количество_групп_на_одной_странице>.docs-in-group=<количество_документов_в_каждой_группе>

  • mode (режим группировки результатов): deep (по атрибуту) или flat (плоский список), по умолчанию - deep
  • attr (атрибут, по которому происходит группировка): d (домен) или "" (пусто, при flat), по умолчанию - d
  • groups-on-page (количество групп (доменов) на странице от 1 до 100), по умолчанию - 10
  • docs-in-group (количество документов от одного домена от 1 до 10 (на практике — до 3), по умолчанию - 1
page нет Номер страницы результатов (отсчёт с 0)
domain нет Домен Яндекса (ru, by, be, kz, kk, com, com.tr, tr, uz), по умолчанию - ru
noreask нет

Исправление опечаток:
0 - включено (по умолчанию)
1 - отключено.

Кроме параметров Яндекса мы принимаем дополнительные параметры:

Параметры XMLRiver

Наименование

Обязательно Описание
device нет

Устройство, на котором выполняется сбор: desktop, mobile.
По умолчанию: desktop.

format нет

Формат выдачи. Возможные значения: html, xml. Если параметр не передан, то выдача осуществляется в формате, указанном в настройках в кабинете.
ВНИМАНИЕ! На данный момент нет программ по сбору Яндекс Search API в формате HTML. Если у вас в кабинете будет установлен этот формат, при сборе в программах вы будете получить ошибку сбора!