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

Список регионов

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

Описание

georegion

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

URL ресурса:

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

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

ПараметрТипЗначение
Необязательные

count

Integer

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

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

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

page

Integer

Номер страницы результатов, которую необходимо показать в ответе.

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

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

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

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

<georegions
[no-highlight[

Значение

Список регионов.

]no-highlight]
page
[no-highlight[

Значение

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

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

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

Значение

Общее количество результатов в списке.

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

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

Значение

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

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

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

Значение

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

]no-highlight]
name
[no-highlight[

Значение

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

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

]no-highlight]
="{название_региона}" children-count
[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[

Значение

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

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

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

Значение

Общее количество результатов в списке.

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

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

Значение

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

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

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

Значение

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

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

Значение

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

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

]no-highlight]
": "{название_региона}", "childrenCount
[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 Integer

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

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

total total Integer

Общее количество результатов в списке.

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

count count Integer

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

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

georegion items

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

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

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

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

children-count childrenCount Число

Количество дочерних регионов.

Для формата 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.xml

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

<georegions page="1" total="4" count="4">
  <georegion name="Россия" children-count="11" parent-id="10001" type="COUNTRY" id="225"/>
  <georegion name="Украина" children-count="7" parent-id="166" type="COUNTRY" id="187"/>
  <georegion name="Казахстан" children-count="16" parent-id="166" type="COUNTRY" id="159"/>
  <georegion name="Беларусь" children-count="8" parent-id="166" type="COUNTRY" id="149"/>
</georegions>

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

GET https://api.content.market.yandex.ru/v1/georegion.json

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

{
  "georegions":
  {
    "page": 1,
    "count": 4,
    "total": 4,
    "items":
    [
      {
        "id": 225,
        "name": "Россия",
        "parentId": 10001,
        "childrenCount": 11,
        "type": "COUNTRY"
      },
      {
        "id": 187,
        "name": "Украина",
        "parentId": 166,
        "childrenCount": 7,
        "type": "COUNTRY"
      },
      {
        "id": 159,
        "name": "Казахстан",
        "parentId": 166,
        "childrenCount": 16,
        "type": "COUNTRY"
      },
      {
        "id": 149,
        "name": "Беларусь",
        "parentId": 166,
        "childrenCount": 8,
        "type": "COUNTRY"
      }
    ]
  }
georegion Регионы