Параметры и методы

Использование параметров GET

Кроме установки необходимых настроек запросов в аккаунте, вы можете передавать эти параметры через GET запрос.
ВАЖНО! Переданные параметры в GET запросе имеют приоритет перед параметрами, установленными в настройках аккаунта!

Строка запроса

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

Обязательно Описание
query да Параметр определяет строку запроса поиска. Вы можете использовать любые запросы, как если бы Вы делали поиск в Google, кроме символа амперсанда (&), который необходимо заменять на код %26

groupby

нет

Числовое значение, ТОП позиций для сбора. Возможные значения: 10, 20, 30, 50.
для совместимости в параметре groupby можно передавать значения в формате Яндекс.XML
    groupby=attr%3Dd.mode%3Ddeep.groups-on-page%3D5.docs-in-group%3D3
    в этом случае deep.groups-on-page учитывается следующим образом:
    deep.groups-on-page = 1..14 – сбор топ10
    deep.groups-on-page = 15..24 – сбор топ20
    deep.groups-on-page = 25..34 – сбор топ30
    deep.groups-on-page = 35..50 – сбор топ50
    deep.groups-on-page > 50 – возвращается ошибка

page нет Числовое значение, определяет страницу поисковой выдачи. В Яндексе страницы нумеруются начиная с нуля.

 

Географическое расположение

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

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

числовое значение (id) местоположения (регион Яндекса)

 

Локализация

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

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

Код языка Яндекса: ruuk...

domain нет

Строка yandex домена. Возможные значения: rucomuacom.trbykz

 

Параметры XMLRiver

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

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

Устройство, на котором выполняется поиск: desktop, tablet, mobile


Пример: 
http://xmlriver.com/search/xml?user=[user_id]&key=[key]&groupby=10&land=ru&lr=1&domain=ru&device=desktop

 

API-методы

Запросы к дополнительным методам осуществляется по адресу xmlriver.com/api/[имя_метода]/ с обязательной передачей GET-параметров user=[user_id]&key=[key]

Метод Описание
get_balance

Получение баланса по счету. Возвращается сумма основного и бонусного счетов.
Возвращает строку с балансом или с ошибкой.
Формат запроса: xmlriver.com/api/get_balance/?user=[user_id]&key=[key]