Документация

Формат ответа

В ответ на поисковый запрос Яндекс.XML возвращает XML-файл в кодировке UTF-8, содержащий результаты поиска.

Ограничение. 

По каждому поисковому запросу возвращается не более 1000 результатов. В зависимости от значения атрибута docs-in-group, каждый результат может содержать от одного до трех документов. Максимальное количество страниц с результатами поиска определяется количеством групп документов, возвращаемых на каждой странице (значение атрибута groups-on-page). Например, если атрибут groups-on-page передан со значением «10», может быть сформировано не более 100 страниц, содержащих результаты поиска.

Файлы состоят из группирующих тегов request (обобщенная информация о параметрах запроса) и response (результаты обработки поискового запроса).

Ниже приведена общая структура результирующего XML-документа с примерами значений.

Внимание! Структура является ознакомительной. Содержит взаимоисключающие элементы.
<?xml version="1.0" encoding="utf-8"?>
<yandexsearch version="1.0">
<request>
   <query
[no-highlight[

Описание

Текст переданного поискового запроса.

Атрибуты

Отсутствуют.

]no-highlight]
>yandex</query> <page
[no-highlight[

Описание

Номер возвращенной страницы результатов поиска. Нумерация начинается с нуля (первой странице соответствует значение «0»).

Атрибуты

Отсутствуют.

]no-highlight]
>0</page> <sortby
[no-highlight[

Описание

Параметры сортировки результатов. Возможные значения:

  • «rlv» — по релевантности;
  • «tm» — по времени изменения документа.

Атрибуты

  • order — порядок сортировки. По умолчанию используется значение «descending» (прямой). При сортировке по времени изменения может принимать значение «ascending» (обратный);
  • priority — служебный. Принимает значение «no».
]no-highlight]
order="descending" priority="no">rlv</sortby> <maxpassages
[no-highlight[

Описание

Максимальное количество пассажей, которые могут быть переданы в одном результатом поиска.

Атрибуты

Отсутствуют.

]no-highlight]
>2</maxpassages> <groupings
[no-highlight[

Описание

Группирующий.

Содержит параметры группировок в теге groupby. Атрибуты отсутствуют

Атрибуты

Отсутствуют.

]no-highlight]
> <groupby
[no-highlight[

Описание

Параметры группировки найденных результатов поиска.

Атрибуты

  • mode — метод группировки;
  • attr — служебный;
  • groups-on-page — максимальное количество групп, которые могут быть возвращены на одной странице результатов поиска;
  • docs-in-group — максимальное количество документов, которые могут быть возвращены в одной группе. Любая группа может содержать меньшее количество документов, чем указанное в данном параметре значение;
  • curcateg — служебный. Принимает значение «-1».
]no-highlight]
attr="d" mode="deep" groups-on-page="10" docs-in-group="3" curcateg="-1" /> </groupings> </request> <response date="20120928T103130"> <error
[no-highlight[

Описание

Описание ошибки.

Присутствует только в случае некорректной обработки поискового запроса (например, при пустом запросе, некорректных параметрах и т.п.).

В некоторых случаях является взаимоисключающим с прочими тегами группирующего тега response.

Атрибуты

code — код ошибки.]no-highlight]
code="15">Искомая комбинация слов нигде не встречается</error> <reqid
[no-highlight[

Описание

Уникальный идентификатор запроса.

Атрибуты

Отсутствуют.

]no-highlight]
>1348828873568466-1289158387737177180255457-3-011-XML</reqid> <found
[no-highlight[

Описание

Приблизительная оценка количества документов, найденных по запросу.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="phrase">206775197</found> <found
[no-highlight[

Описание

Приблизительная оценка количества документов, найденных по запросу.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="strict">206775197</found> <found
[no-highlight[

Описание

Приблизительная оценка количества документов, найденных по запросу.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="all">206775197</found> <found-human
[no-highlight[

Описание

Строка на языке, соответствующем выбранному типу поиска. Содержит сведения о количестве найденных документов и сопутствующую информацию.

Атрибуты

Отсутствуют.

]no-highlight]
>Нашлось 207 млн ответов</found-human> <misspell
[no-highlight[

Описание

Группирующий.

Содержит сведения о возможной опечатке в поисковом запросе.

Атрибуты

Отсутствуют.

]no-highlight]
> <rule
[no-highlight[

Описание

Тип ошибки, найденной в запросе.

Возможные значения:

  • «Misspell» — опечатка.
  • «KeyboardLayout» — ошибка в раскладке клавиатуры.
  • «Volapyuk» — запрос задан на русском языке в английской транслитерации. Используется, если в качестве типа поиска выбрано значение «русский (yandex.ru)».

Атрибуты

Отсутствуют.

]no-highlight]
>Misspell</rule> <source-text
[no-highlight[

Описание

Исходный текст запроса.

Фрагмент поискового запроса, предположительно содержащий ошибку, выделяется тегом hlword.

Атрибуты

Отсутствуют.

]no-highlight]
>yande<hlword>xx</hlword></source-text> <text
[no-highlight[

Описание

Исправленный текст поискового запроса.

Атрибуты

Отсутствуют.

]no-highlight]
>yandex</text> </misspell> <reask
[no-highlight[

Описание

Группирующий.

Содержит сведения об исправлении, внесенном в исходный запрос перед поиском документов.

Атрибуты

Отсутствуют.

]no-highlight]
> <rule
[no-highlight[

Описание

Тип ошибки, найденной в запросе.

Возможные значения:

  • «Misspell» — опечатка.
  • «KeyboardLayout» — ошибка в раскладке клавиатуры.
  • «Volapyuk» — запрос задан на русском языке в английской транслитерации. Используется, если в качестве типа поиска выбрано значение «русский (yandex.ru)».

Атрибуты

Отсутствуют.

]no-highlight]
>Misspell</rule> <source-text
[no-highlight[

Описание

Исходный текст запроса.

Фрагмент поискового запроса, предположительно содержащий ошибку, выделяется тегом hlword.

Атрибуты

Отсутствуют.

]no-highlight]
><hlword>yn</hlword>dex</source-text> <text-to-show
[no-highlight[

Описание

Опциональный (только для группирующего тега reask).

Содержит исправленный текст поискового запроса. В большинстве случаев совпадает со значением, передаваемым в теге text.

Атрибуты

Отсутствуют.

]no-highlight]
>yandex</text-to-show> <text
[no-highlight[

Описание

Исправленный текст поискового запроса.

Атрибуты

Отсутствуют.

]no-highlight]
>yandex</text> </reask> <results
[no-highlight[

Описание

Группирующий. Дочерние теги содержат сведения о параметрах поиска и найденных документах.

Атрибуты

Отсутствуют.

]no-highlight]
> <grouping
[no-highlight[

Описание

Группирующий. Дочерние теги содержат сведения о параметрах поиска и найденных документах.

Атрибуты

Атрибуты отражают правила группировки найденных документов.

  • mode — метод группировки;
  • attr — служебный. Зависит от значения атрибута mode;
  • groups-on-page — количество групп, возвращаемых на одной странице результатов поиска;
  • docs-in-group — количество документов, возвращаемых в одной группе;
  • curcateg — служебный. Принимает значение «-1».
]no-highlight]
attr="d" mode="deep" groups-on-page="10" docs-in-group="3" curcateg="-1"> <found
[no-highlight[

Описание

Приблизительная оценка количества сформированных групп.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="phrase">45094</found> <found
[no-highlight[

Описание

Приблизительная оценка количества сформированных групп.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="strict">45094</found> <found
[no-highlight[

Описание

Приблизительная оценка количества сформированных групп.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="all">45094</found> <found-docs
[no-highlight[

Описание

Приблизительная оценка количества документов, найденных по запросу.

Является более точной оценкой по сравнению со значением, передаваемым в теге found блока с общей информацией о результатах поиска.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="phrase">192685602</found-docs> <found-docs
[no-highlight[

Описание

Приблизительная оценка количества документов, найденных по запросу.

Является более точной оценкой по сравнению со значением, передаваемым в теге found блока с общей информацией о результатах поиска.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="strict">192685602</found-docs> <found-docs
[no-highlight[

Описание

Приблизительная оценка количества документов, найденных по запросу.

Является более точной оценкой по сравнению со значением, передаваемым в теге found блока с общей информацией о результатах поиска.

Атрибуты

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

]no-highlight]
priority="all">192685602</found-docs> <found-docs-human
[no-highlight[

Описание

Строка на языке, соответствующем выбранному типу поиска. Содержит сведения о количестве найденных документов и сопутствующую информацию.

Передаваемое значение должно использоваться при оформлении результатов поиска.

Атрибуты

Отсутствуют.

]no-highlight]
>нашёл 193 млн ответов</found-docs-human> <page
[no-highlight[

Описание

Номер возвращенной страницы результатов поиска. Нумерация начинается с нуля (первой странице соответствует значение «0»).

Атрибуты

  • first — порядковый номер первой группы с результатами поиска, отображаемой на странице;
  • last — порядковый номер последней группы с результатами поиска, отображаемой на странице.
]no-highlight]
first="1" last="10">0</page> <group
[no-highlight[

Описание

Группирующий.

Каждый тег group содержит сведения о найденной группе документов.

Атрибуты

Отсутствуют.

]no-highlight]
> <categ
[no-highlight[

Описание

Идентификационные данные о группе найденных документов.

Атрибуты

  • attr — служебный. Должен совпадать со значением, переданным в запросе;
  • name — уникальный идентификатор группы.
]no-highlight]
attr="d" name="UngroupVital223.ru" /> <doccount
[no-highlight[

Описание

Приблизительная оценка количества документов, которые использованы для формирования группы.

Документы, претендующие на включение в группу, ранжируются в соответствии с условиями запроса (параметр sortby). В зависимости от значения параметра docs-in-group в группу включается от одного до трех первых документов.

Атрибуты

Отсутствуют.

]no-highlight]
>34</doccount> <relevance
[no-highlight[

Описание

Служебный.

Атрибуты

priority — служебный.

]no-highlight]
priority="all" /> <doc
[no-highlight[

Описание

Группирующий.

Каждый тег doc содержит информацию о найденном документе.

В зависимости от значения параметра docs-in-group каждая группа может содержать от одного до трех группирующих тегов doc.

Атрибуты

id — уникальный идентификатор найденного документа.]no-highlight]
id="ZD831E1113BCFDD95"> <relevance
[no-highlight[

Описание

Служебный.

Атрибуты

priority — служебный.

]no-highlight]
priority="phrase" /> <url
[no-highlight[

Описание

Адрес найденного документа.

Атрибуты

Отсутствуют.

]no-highlight]
>https://www.yandex.ru/</url> <domain
[no-highlight[

Описание

Домен, на котором расположен найденный документ.

Атрибуты

Отсутствуют.

]no-highlight]
>www.yandex.ru</domain> <title
[no-highlight[

Описание

Заголовок найденного документа.

Слова, входящие в поисковый запрос, выделяются тегом hlword.

Атрибуты

Отсутствуют.

]no-highlight]
>&quot;<hlword>Яндекс</hlword>&quot; - поисковая система и интернет-портал</title> <headline
[no-highlight[

Описание

Опциональный. Аннотация документа.

Для формирования используется HTML-тег meta, содержащий атрибут name со значением «description».

Атрибуты

Отсутствуют.

]no-highlight]
>Поиск по всему интернету с учетом региона пользователя.</headline> <modtime
[no-highlight[

Описание

Дата и время изменения документа в формате:

<год><месяц><день>Т<час><минута><секунда>
Внимание! 

Тег является необязательным и в некоторых случаях может отсутствовать.

Атрибуты

Отсутствуют.

]no-highlight]
>20060814T040000</modtime> <size
[no-highlight[

Описание

Размер найденного документа в байтах.

Атрибуты

Отсутствуют.

]no-highlight]
>26938</size> <charset
[no-highlight[

Описание

Кодировка найденного документа.

Атрибуты

Отсутствуют.

]no-highlight]
>utf-8</charset> <passages
[no-highlight[

Описание

Группирующий тег, содержащий список пассажей документа.

Атрибуты

Отсутствуют.

]no-highlight]
> <passage
[no-highlight[

Описание

Пассаж с аннотацией к документу.

Слова, входящие в поисковый запрос, выделяются тегом hlword.

Максимальное количество пассажей, передаваемых в одном теге passages, определяется значением параметра maxpassagesпоискового запроса.

Атрибуты

Отсутствуют.

]no-highlight]
><hlword>Яндекс</hlword> — поисковая машина, способная по вашему запросу...</passage> </passages> <properties
[no-highlight[

Описание

Группирующий тег, содержащий свойства документа.

Атрибуты

Отсутствуют.

]no-highlight]
> <_PassagesType
[no-highlight[

Описание

Тип пассажа. Возможные значения:

  • «0» — стандартный пассаж (сформирован из текста документа);
  • «1» — пассаж на основе текста ссылки. Используется, если документ найден по ссылке.

Атрибуты

Отсутствуют.

]no-highlight]
>0</_PassagesType> <lang
[no-highlight[

Описание

Опциональный.

Язык документа.

Атрибуты

Отсутствуют.

]no-highlight]
>ru</lang> </properties> <mime-type
[no-highlight[

Описание

Тип документа в соответствии с RFC2046.

Атрибуты

Отсутствуют.

]no-highlight]
>text/html</mime-type> <saved-copy-url
[no-highlight[

Описание

Адрес сохраненной копии документа.

Атрибуты

Отсутствует.

]no-highlight]
>https://hghltd.yandex.net/yandbtm?text=yandex&amp;url=https%3A%2F%2Fwww.yandex.ru%2F&amp;fmode=inject&amp;mime=html&amp;l10n=ru&amp;sign=e3737561fc3d1105967d1ce619dbd3c7&amp;keyno=0</saved-copy-url> </doc> </group> </grouping> </results> </response> </yandexsearch>