Инструменты · key

`xml` Выдача Яндекса в формате Yandex Search API (Яндекс.XML)

Возвращает выдачу Яндекса по запросу и региону XML-документом в формате Yandex Search API — так же, как его отдаёт сам Яндекс. Подходит, чтобы подключить готовый парсер Яндекс.XML без своего аккаунта в Yandex Cloud. Метод синхронный: ответ приходит, когда выдача получена.

Стоимость: 1 лимит за вызов
Режим: синхронный
Формат ответа: text/xml; ошибки ключа и лимитов — JSON

Выдача по запросу

GET /api/xml

Параметры передаются в query-строке. Запрос ставится в очередь парсера и ждёт ответа, поэтому вызов длится от нескольких секунд и дольше при загрузке очереди — ставьте таймаут HTTP-клиента с запасом, от минуты.

Параметры query

key string обязательный

Ключ API из настроек аккаунта.
query string обязательный

Поисковый запрос, с операторами Яндекса.
lr int

Регион Яндекса.

По умолчанию 213
page int

Номер страницы выдачи, с нуля.

По умолчанию 0
groupby string

Группировка результатов в синтаксисе Яндекс.XML, например attr=d.mode=deep.groups-on-page=100.docs-in-group=1.
is_mobile int

Мобильная выдача.

0
десктоп

1
мобильная

По умолчанию 0

Ответ

XML-документ <yandexsearch> как в Yandex Search API: найденные документы — в response/results/grouping/group/doc. Если выдачу получить не удалось, приходит тот же формат с <error code="100500"> — повторите запрос позже; лимит за такой вызов тоже списывается.

GET /api/xml

curl -G 'https://tools.pixelplus.ru/api/xml' \
  --data-urlencode 'key=ВАШ_КЛЮЧ' \
  --data-urlencode 'query=купить диван' \
  --data-urlencode 'lr=213'

<?php
$url = 'https://tools.pixelplus.ru/api/xml?' . http_build_query([
    'key' => 'ВАШ_КЛЮЧ',
    'query' => 'купить диван',
    'lr' => 213,
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 60,
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($response);

import requests

response = requests.get(
    "https://tools.pixelplus.ru/api/xml",
    params={
        "key": "ВАШ_КЛЮЧ",
        "query": "купить диван",
        "lr": 213,
    },
    timeout=60,
)
print(response.json())

query обязательный Поисковый запрос, с операторами Яндекса lr Регион Яндекса

Запрос настоящий — выполнится с вашим ключом

Пример ответа

<?xml version="1.0" encoding="utf-8"?>
<yandexsearch version="1.0">
  <request>…</request>
  <response date="20261006T120000">
    <found priority="all">5000000</found>
    <results>
      <grouping attr="d" mode="deep" groups-on-page="100" docs-in-group="1">
        <group>
          <doc id="…">
            <url>https://example.ru/catalog/divany/</url>
            <domain>example.ru</domain>
            <title>Купить <hlword>диван</hlword> в Москве</title>
            <passages><passage>Диваны от производителя с доставкой…</passage></passages>
          </doc>
        </group>
      </grouping>
    </results>
  </response>
</yandexsearch>

Ошибки

Код	Сообщение	Когда
`-1`	`Access denied`	Не передан `key`. Ответ — JSON с HTTP-кодом 200.
`-2`	`Access denied`	Ключ не найден. HTTP-код 200.
`-68`	`Not enough daily limits`	На аккаунте не осталось лимитов. Для тарифов с ограничением по периодам — также `-80`, `-81`, `-82`, `-83`.

Ответ с ошибкой

{
    "error": "Access denied",
    "code": -1
}

Отличия от Yandex Search API

Параметры l10n, sortby, filter и maxpassages, которые упоминались в прежней документации, сейчас не применяются: выдача всегда идёт с настройками Яндекса по умолчанию. Различайте ответы по Content-Type: XML — выдача (в том числе с ошибкой Яндекса внутри), JSON — ошибка ключа или лимитов.