---
metadata:
  - name: generator
    content: Diplodoc Platform v5.44.0
alternate:
  - https://yandex.ru/dev/webmaster/doc/ru/reference/regions-directory.md
keywords:
  - с
  - а
  - й
  - т
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/webmaster/doc/ru/llms.txt


# Справочник регионов

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

## Формат запроса {#client-request}

```
GET /v4/user/{[user-id](*user-id)}/hosts/{[host-id](*host-id)}/pro/regions
  ? [[filter](*filter)=<string>]
  & [[limit](*limit)=<integer>]
```

#|
||
**Параметр**
|
**Тип**
|
**Обязательно**
|
**Описание**
||
||
`user-id`
|
`int64`
|
Да
|
ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод [GET /v4/user](https://yandex.ru/dev/webmaster/doc/ru/reference/user.md).
||
||
`host-id`
|
`host id (string)`
|
Да
|
ID сайта. Чтобы получить его, используйте метод [GET /v4/user/{user‑id}/hosts](https://yandex.ru/dev/webmaster/doc/ru/reference/hosts.md).
||
||
`filter`
|
`string`
|
Нет
|
Подстрочный фильтр по названию региона. Регистр и язык учитываются так, как в данных источника.
||
||
`limit`
|
`integer`
|
Нет
|
Максимальное количество записей в выдаче.
||
|#

### Заголовки запроса {#headers}

Для запроса необходимо указать два HTTP-заголовка:

1. `Authorization`

   ```
   Authorization: OAuth {[ваш_токен](*oauth-token)}
   ```

1. `Accept`

   ```
   Accept: [application/json](*accept)
   ```

### Пример запроса {#example-request}

```
GET https://api.webmaster.yandex.net/v4/user/{[user-id](*user-id)}/hosts/{[host-id](*host-id)}/pro/regions?[filter](*filter)=%D0%91%D0%B0%D1%88%D0%BA&[limit](*limit)=123
```

## Формат ответа {#response-format}

#### Пример

```json
{
  "regions": [
    {
      "id": 11111,
      "name": "Республика Башкортостан"
    }
  ]
}
```

#|
||
**Параметр**
|
**Тип**
|
**Обязательно**
|
**Описание**
||
||
`id`
|
`integer`
|
Да
|
Числовой идентификатор региона.
||
||
`name`
|
`string`
|
Да
|
Название региона.
||
|#

## Коды ответа {#errors}

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

#|
||
**Код**
|
**Причина**
|
**Описание**
||
||
200
|
OK
|
Успешно.
||
||
400
|
[WRONG_REGIONS](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#wrong-region)
|
Регионы некорректны.

```json
{
  "code": "WRONG_REGIONS",
  "message": "Region ids must be positive"
}
```
||
||
400
|
[EMPTY_PATHS](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#empty-paths)
|
Пустые пути.

```json
{
  "code": "EMPTY_PATHS",
  "message": "Paths cannot be empty"
}
```
||
||
400
|
[EMPTY_DATES](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#empty-dates)
|
Пустые даты.

```json
{
  "code": "EMPTY_DATES",
  "message": "Dates cannot be empty"
}
```
||
||
400
|
[SOME_DATES_ARE_UNAVAILABLE](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#some-dates-unavailable)
|
Некоторые даты недоступны (слишком старые или еще не обработаны).

```json
{
  "code": "SOME_DATES_ARE_UNAVAILABLE",
  "message": "Some dates are unavailable. Examples: [2024-01-01, 2024-01-02, 2024-01-03]",
  "[unavailable_dates](*unavailable_dates)": ["2024-01-01", "2024-01-03"]
}
```
||
||
400
|
[URLS_ARE_CORRUPTED](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#urls-corrupted)
|
Некоторые переданные пути/URL некорректны.

```json
{
  "code": "URLS_ARE_CORRUPTED",
  "message": "Some urls are corrupted or invalid for the specified host"
}
```
||
||
403
|
[LIMITS_EXCEEDED](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#limits-exceeded)
|
Превышены лимиты расширенного доступа.

```json
{
  "code": "LIMITS_EXCEEDED",
  "message": "PRO feature limits exceeded"
}
```
||
||
413
|
[PAYLOAD_TOO_LARGE](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md#payload-too-large)
|
Превышен размер запроса по количеству дат и URL.

```json
{
  "code": "PAYLOAD_TOO_LARGE",
  "message": "Amount of dates and urls is too large. Limit: 100",
  "[limit](*limit-1)": 100
}
```
||
|#

#### Узнайте больше

- [Коды ошибок и статусы](https://yandex.ru/dev/webmaster/doc/ru/reference/errors.md)

[*oauth-token]: [OAuth-токен](https://yandex.ru/dev/webmaster/doc/ru/tasks/how-to-get-oauth.md) для доступа к API.

[*accept]: Указывает, что ответ должен быть в формате JSON.

[*user-id]: Тип: `int64`. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод [GET /v4/user](https://yandex.ru/dev/webmaster/doc/ru/reference/user.md).

[*host-id]: Тип: `string`. ID сайта. Чтобы получить его, используйте метод [GET&nbsp;/v4/user/{user&#x2011;id}/hosts](https://yandex.ru/dev/webmaster/doc/ru/reference/hosts.md).

[*filter]: Подстрочный фильтр по названию региона. Регистр и язык учитываются так, как в данных источника.

[*limit]: Максимальное количество записей в выдаче.

[*limit-1]: Тип: `integer`. Максимально допустимый суммарный размер (дат + URL).

[*unavailable_dates]: Тип: `string`. Полный список недоступных дат.