Регионы РФ
Справочник регионов Российской Федерации: федеральные округа, коды регионов и наименования. Используется для фильтрации контрагентов и форм выгрузки по региону.
GET
https://kontrchk.ru/api/v2/dict_regions
- Справочник не требует параметра ogrn или inn — достаточно API-ключа.
- Ответ кэшируется на сервере (TTL до 7 суток).
- Используйте коды из справочника в фильтрах соответствующих методов API.
Параметры запроса
| Параметр | Тип | Описание | |
|---|---|---|---|
key
|
string | обязательный |
API-ключ. Также можно передать в заголовке X-API-Key. |
Пример запроса
URL
https://kontrchk.ru/api/v2/dict_regions?key=ВАШ_КЛЮЧ
cURL
curl -s -H "Accept: application/json" "https://kontrchk.ru/api/v2/dict_regions?key=ВАШ_КЛЮЧ"
Ответ
Успешный ответ
Пример JSON
{
"data": [
{
"name": "Центральный",
"regions": [
{
"code": "77",
"name": "Москва"
},
{
"code": "50",
"name": "Московская область"
}
]
}
]
}
Ошибка
| Поле | Тип | Описание |
|---|---|---|
success
|
boolean |
Признак ошибки: false. |
error
|
string |
Текст ошибки. |
Пример JSON
{
"success": false,
"error": "Invalid API key"
}