Руководство разработчика
Ресурсы API

Текстовый поиск региона

Краткое содержание

Описание

georegion/suggest

Возвращает список регионов, подходящих под заданные условия поиска. Поиск производится по названиям регионов.

Можно задать поиск по полному или частичному названию региона. В случае указания частичного названия в выходных данных возвращается список регионов, название которых начинается с этого частичного названия.

URL ресурса:

https://api.content.market.yandex.ru/v1/georegion/suggest.[format]

Входные данные

ПараметрТипЗначение
Обязательные
part_name Строка

Полное или частичное название региона.

Необязательные
count Число

Количество выводимых результатов.

Значение по умолчанию: 10.

Максимальное возможное значение: 10.

Выходные данные

Если под заданные условия поиска не подходит ни один регион, в ответе возвращается пустой список.

Структура выходных данных:

<georegions
[no-highlight[

Значение

Список регионов, подходящих под условия поиска.

]no-highlight]
page
[no-highlight[

Значение

Номер выводимой страницы результатов.

Для данного ресурса параметр всегда равен 1.

Для формата XML является атрибутом.

]no-highlight]
="{номер_страницы}" total
[no-highlight[

Значение

Количество выводимых результатов.

Для данного ресурса значение совпадает со значением параметра count.

Для формата XML является атрибутом.

]no-highlight]
="{количество_выводимых_результатов}" count
[no-highlight[

Значение

Количество выводимых результатов.

Для данного ресурса значение совпадает со значением параметра total.

Для формата XML является атрибутом.

]no-highlight]
="{количество_результатов_на_странице}"> <georegion
[no-highlight[

Значение

Описание региона / регионов.

]no-highlight]
name
[no-highlight[

Значение

Название региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{название_региона}" parent-id
[no-highlight[

Значение

Идентификатор родительского региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{идентификатор_региона}" type
[no-highlight[

Значение

Тип региона.

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

  • CONTINENT — континент;

  • REGION — регион;

  • COUNTRY — страна;

  • COUNTRY_DISTRICT — федеральный округ;

  • SUBJECT_FEDERATION — субъект федерации;

  • CITY — город;

  • VILLAGE — поселок, село, деревня;

  • CITY_DISTRICT — район города;

  • METRO_STATION — станция метро;

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{тип_региона}" id
[no-highlight[

Значение

Идентификатор региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
="{идентификатор_региона}"/> ... </georegions>
{
  "georegions
[no-highlight[

Значение

Список регионов, подходящих под условия поиска.

]no-highlight]
": { "page
[no-highlight[

Значение

Номер выводимой страницы результатов.

Для данного ресурса параметр всегда равен 1.

Для формата XML является атрибутом.

]no-highlight]
": {номер_страницы}, "total
[no-highlight[

Значение

Количество выводимых результатов.

Для данного ресурса значение совпадает со значением параметра count.

Для формата XML является атрибутом.

]no-highlight]
": {количество_результатов}, "count
[no-highlight[

Значение

Количество выводимых результатов.

Для данного ресурса значение совпадает со значением параметра total.

Для формата XML является атрибутом.

]no-highlight]
": {количество_резудьтатов_на_странице}, "items
[no-highlight[

Значение

Описание региона / регионов.

]no-highlight]
": [ { "name
[no-highlight[

Значение

Название региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": "{название_региона}", "parentId
[no-highlight[

Значение

Идентификатор родительского региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": {идентификатор_региона}, "type
[no-highlight[

Значение

Тип региона.

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

  • CONTINENT — континент;

  • REGION — регион;

  • COUNTRY — страна;

  • COUNTRY_DISTRICT — федеральный округ;

  • SUBJECT_FEDERATION — субъект федерации;

  • CITY — город;

  • VILLAGE — поселок, село, деревня;

  • CITY_DISTRICT — район города;

  • METRO_STATION — станция метро;

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": "{тип_региона}", "id
[no-highlight[

Значение

Идентификатор региона.

Для формата XML является атрибутом параметра georegion.

]no-highlight]
": {идентификатор_региона} }, ... ] } }

Описание параметров:

Параметр для формата XMLПараметр для формата JSONТипЗначение
georegions georegions

Список регионов, подходящих под условия поиска.

Параметры, вложенные в georegions
page page Число

Номер выводимой страницы результатов.

Для данного ресурса параметр всегда равен 1.

Для формата XML является атрибутом.

total total Число

Количество выводимых результатов.

Для данного ресурса значение совпадает со значением параметра count.

Для формата XML является атрибутом.

count count Число

Количество выводимых результатов.

Для данного ресурса значение совпадает со значением параметра total.

Для формата XML является атрибутом.

georegion items

Описание региона / регионов.

Параметры, вложенные в georegion/items
name name String

Название региона.

Для формата XML является атрибутом параметра georegion.

parent-id parentId Число

Идентификатор родительского региона.

Для формата XML является атрибутом параметра georegion.

type type Enum

Тип региона.

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

  • CONTINENT — континент;

  • REGION — регион;

  • COUNTRY — страна;

  • COUNTRY_DISTRICT — федеральный округ;

  • SUBJECT_FEDERATION — субъект федерации;

  • CITY — город;

  • VILLAGE — поселок, село, деревня;

  • CITY_DISTRICT — район города;

  • METRO_STATION — станция метро;

  • OTHER — другой тип населенного пункта.

Для формата XML является атрибутом параметра georegion.

id id Число

Идентификатор региона.

Для формата XML является атрибутом параметра georegion.

Описания ошибок

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.

Примеры

Пример запроса:

GET https://api.content.market.yandex.ru/v1/georegion/suggest.xml?part_name=мо&count=5

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

<georegions page="1" total="5" count="5">
  <georegion name="Москва" parent-id="1" type="CITY" id="213"/>
  <georegion name="Монтевидео" parent-id="21289" type="CITY" id="21290"/>
  <georegion name="Монровия" parent-id="21278" type="CITY" id="21280"/>
  <georegion name="Монако" parent-id="10070" type="CITY" id="10465"/>
  <georegion name="Могадишо" parent-id="21227" type="CITY" id="37179"/>
</georegions>

Пример запроса:

GET https://api.content.market.yandex.ru/v1/georegion/suggest.json?part_name=мо&count=5

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

{
  "georegions":
  {
    "page": 1,
    "count": 5,
    "total": 5,
    "items":
    [
      {
        "id": 213,
        "name": "Москва",
        "parentId": 1,
        "type": "CITY"
      },
      {
        "id": 21290,
        "name": "Монтевидео",
        "parentId": 21289,
        "type": "CITY"
      },
      {
        "id": 21280,
        "name": "Монровия",
        "parentId": 21278,
        "type": "CITY"
      },
      {
        "id": 10465,
        "name": "Монако",
        "parentId": 10070,
        "type": "CITY"
      },
      {
        "id": 37179,
        "name": "Могадишо",
        "parentId": 21227, 
        "type": "CITY"
      }
    ]
  }
}
georegion/suggest Регионы Текстовый поиск