Поиск регионов по их имени

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

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

Если найдено несколько регионов, удовлетворяющих условиям поиска, возвращается информация по каждому найденному региону (но не более десяти регионов) для возможности определения нужного региона по родительским регионам.

Для методов GET regions, GET regions/{regionId} и GET regions/{regionId}/children действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество регионов, информация о которых запрошена при помощи этих методов (не более 100 000 регионов).

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

⚙️ Лимит: 50 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/regions

Query parameters

Name

Description

name*

Type: string

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

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

limit

Type: integer<int32>

Количество значений на одной странице.
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Responses

200 OK

Список найденных регионов.

Body

application/json
{
    "regions": [
        {
            "id": 0,
            "name": "string",
            "type": "OTHER",
            "parent": {
                "id": 0,
                "name": "string",
                "type": "OTHER",
                "children": [
                    null
                ]
            },
            "children": [
                null
            ]
        }
    ],
    "paging": {
        "nextPageToken": "string"
    }
}

Name

Description

regions*

Type: RegionDTO[]

Регион доставки.
Регион доставки.

paging

Type: ForwardScrollingPagerDTO

Ссылка на следующую страницу.

RegionDTO

Регион доставки.

Name

Description

id*

Type: integer<int64>

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

name*

Type: string

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

type*

Type: RegionType

Тип региона.

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

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

  • CITY — крупный город.

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

  • COUNTRY_DISTRICT — область.

  • COUNTRY — страна.

  • REGION — регион.

  • REPUBLIC_AREA — район субъекта федерации.

  • REPUBLIC — субъект федерации.

  • SUBWAY_STATION — станция метро.

  • VILLAGE — город.

  • OTHER — неизвестный регион.

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

children

Type: RegionDTO[]

Дочерние регионы.
Регион доставки.

Min items: 1

parent

Type: RegionDTO

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

Указываются родительские регионы до уровня страны.

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

RegionType

Тип региона.

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

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

  • CITY — крупный город.

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

  • COUNTRY_DISTRICT — область.

  • COUNTRY — страна.

  • REGION — регион.

  • REPUBLIC_AREA — район субъекта федерации.

  • REPUBLIC — субъект федерации.

  • SUBWAY_STATION — станция метро.

  • VILLAGE — город.

  • OTHER — неизвестный регион.

Type

Description

RegionType

Enum: OTHER, CONTINENT, REGION, COUNTRY, COUNTRY_DISTRICT, REPUBLIC, CITY, VILLAGE, CITY_DISTRICT, SUBWAY_STATION, REPUBLIC_AREA

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

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

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

ApiResponseStatusType

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

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

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

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

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

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

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

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR