ДокументацияAPI
Все поля ответа
Каждое поле, которое может прийти в ответе, с типом, смыслом и примером из настоящего ответа. Все поля есть в каждом тарифе.
Поля адреса приходят в объекте details: в адресе по коду, а в поиске и по координатам — с details=true. Поля без значения в ответе нет. «Нет в примерах» — редкое поле, которого нет в наших примерах ответов.
Адрес · Коды · Регион и время · Почта · Документы · Координаты и метро · Идентификаторы · Ответы маршрутов
Адрес
Сам адрес: строка, части по уровням и тип объекта.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| address | строка | Адрес одной строкой, от региона до объекта. | "г Москва, ул Сухонская, д 11" |
| components | строки[] | Части адреса по порядку, от региона до объекта. | ["г Москва", …] |
| level | целое, 0–17 | Уровень объекта в ГАР: 1 — регион, 5 — город, 8 — улица, 10 — дом, 11 — квартира. | 10 |
| levelName | строка | Название уровня по ГАР. | "Здание (строение), сооружение" |
| kind | строка | Вид объекта: дом, корпус, строение, квартира, офис. | "Дом" |
| addressParts | объект | Адрес по частям. | {…} |
| addressParts.region | строка | Регион. | "г Москва" |
| addressParts.city | строка | Город, если он есть в адресе. | "г Москва" |
| addressParts.street | строка | Улица, если она есть в адресе. | "ул Сухонская" |
| addressParts.byLevel | объекты[] | Все части адреса с их уровнями, от региона до объекта. | […] |
| addressParts.byLevel[].level | целое, 0–17 | Уровень части. | 1 |
| addressParts.byLevel[].text | строка | Часть адреса: тип и название. | "г Москва" |
| addressParts.byLevel[].id | целое | Код части в ГАР. | 1405113 |
| addressParts.byLevel[].kind | строка | Вид части (для домов и помещений). | "Дом" |
| addressParts.byLevel[].self | true | Есть и равно true у части, которая и есть сам объект. | true |
| multiApartment | true | Многоквартирный дом. Есть только со значением true. | true |
| country | строка | Страна. | "Россия" |
Коды
Государственные коды объекта. Если у объекта своего кода нет, берём код ближайшего объекта выше по адресу (кроме кадастрового номера).
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| okato | строка | Код ОКАТО. | "45280583000" |
| oktmo | строка | Код ОКТМО. | "45362000" |
| kladr | строка | Код КЛАДР. | "77000000000283600" |
| cadastral | строка | Кадастровый номер. Только свой, никогда не от объекта выше. | "77:02:0004008:1017" |
| ifnsFl | строка | Код налоговой инспекции для физических лиц. | "7715" |
| ifnsUl | строка | Код налоговой инспекции для юридических лиц. | "7715" |
| regionCode | строка | Код региона: две первые цифры кода КЛАДР. | "77" |
Регион и время
Где объект: округ, код региона по ISO, часовой пояс, центр региона.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| federalDistrict | строка | Федеральный округ. | "Центральный" |
| isoCode | строка | Код региона по ISO 3166-2. | "RU-MOW" |
| timeZone | строка | Часовой пояс по базе IANA. | "Europe/Moscow" |
| utcOffset | строка | Смещение от UTC. | "UTC+3" |
| adminCentreSubject | true | Центр субъекта РФ. Есть только со значением true. | true |
| adminCentreMunicipality | true | Центр муниципального образования. Есть только со значением true. | true |
Почта
Индекс и почтовое отделение по справочнику Почты России.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| postalCode | строка | Почтовый индекс, 6 цифр. | "127642" |
| postOffice | объект | Почтовое отделение этого индекса. | {…} |
| postOffice.name | строка | Название отделения. | "МОСКВА 642" |
| postOffice.type | строка | Тип отделения по справочнику Почты России. | "О" |
| postOffice.date | строка | Дата записи об отделении. | "2002-04-04" |
| postOffice.oldIndex | строка | Прежний индекс отделения, если он менялся. | нет в примерах |
| postFileDate | строка | Дата справочника индексов, по которому дан ответ. | "2026-10-05" |
| postStatus | строка | Почтовый статус объекта по ГАР, если есть. | нет в примерах |
Документы и история
Каким документом адрес присвоен и изменён, прежние названия.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| assignedBy | объект «документ» | Документ, которым присвоен адрес (объект «документ» ниже). | {…} |
| lastChangedBy | объект «документ» | Последний документ об изменении адреса, если это другой документ. | {…} |
| assignedBy.name | строка | Название документа. | "О присвоении адреса объекту адр… |
| assignedBy.number | строка | Номер документа. | "10732" |
| assignedBy.date | строка | Дата документа. | "2017-04-14" |
| assignedBy.typeName | строка | Тип документа: постановление, распоряжение и т. п. | "Распоряжение" |
| assignedBy.kindName | строка | Вид документа. | "Нормативный документ" |
| assignedBy.organisation | строка | Кто принял документ. | "" |
| oldNames | объекты[] | Прежние названия объекта, сначала самые новые (у регионов, городов, улиц и других адресных объектов). | […] |
| oldNames[].name | строка | Прежнее название: тип и имя. | "пр-кт Фатыха Амирхана" |
| oldNames[].startDate | строка | С какой даты действовало название; пусто, если неизвестно. | "" |
| oldNames[].endDate | строка | До какой даты действовало название; пусто, если неизвестно. | "2016-03-25" |
| deregistered | строка | Дата снятия с учёта по ГАР, если есть. | нет в примерах |
Координаты и метро
Точка на карте, ближайшее метро, положение относительно МКАД и КАД. Координаты: © участники OpenStreetMap.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| geo | объект | Координаты объекта. | {…} |
| geo.lat | число | Широта, градусы. | 55.878344999999996 |
| geo.lon | число | Долгота, градусы. | 37.6536694 |
| geo.qc | целое | Точность: 0 — сам дом, 1 — ближайший дом, 2 — улица, 3 — населённый пункт, 4 — город, 5 — точки нет. | 0 |
| metro | объекты[] | До трёх ближайших станций метро, сначала ближайшая. | […] |
| metro[].name | строка | Станция. | "Медведково" |
| metro[].line | строка | Линия. | "Калужско-Рижская" |
| metro[].colour | строка | Цвет линии, #rrggbb. | "#ffa500" |
| metro[].distance | число | Расстояние по прямой, км. | 1.1 |
| beltway | объект | Внутри или снаружи МКАД (Москва и область) или КАД (Санкт-Петербург и область). | {…} |
| beltway.hit | строка | IN_MKAD, OUT_MKAD, IN_KAD или OUT_KAD. | "IN_MKAD" |
| beltway.distance | целое | Снаружи кольца: расстояние до кольца по прямой, целые км. | 2 |
| osmDate | строка | Дата данных OpenStreetMap, по которым даны координаты. | "2026-10-10" |
| geonameId | целое | Код населённого пункта в GeoNames. | 524901 |
Идентификаторы
Коды объекта в ГАР: по ним объект можно запросить снова.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| id | целое | Код объекта в ГАР (OBJECTID). Для /v1/details?id=. | 26847188 |
| guid | строка, GUID | GUID объекта в ГАР (OBJECTGUID). Для /v1/details?guid=. | "5ee84ac0-eb9a-4b42-b814-2f5f7c2… |
| guidActual | да/нет | GUID действующий. Всегда true: в индексе только действующие объекты. | true |
Ответ поиска
Ответ /v1/search.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| query | строка | Строка запроса, как её получил сервер. | "москва сухонская 11" |
| count | целое | Сколько адресов в ответе. | 3 |
| results | объекты[] | Найденные адреса, сначала лучшие. | […] |
| results[].id | целое | Код объекта в ГАР. | 26847188 |
| results[].guid | строка, GUID | GUID объекта в ГАР. | "5ee84ac0-eb9a-4b42-b814-2f5f7c2… |
| results[].level | целое, 0–17 | Уровень объекта. | 10 |
| results[].address | строка | Адрес одной строкой. | "г Москва, ул Сухонская, д 11" |
| results[].components | строки[] | Части адреса по порядку. | ["г Москва", …] |
| results[].details | объект details | Все поля адреса (объект details), если в запросе details=true. | {…} |
Ответ по коду
Ответ /v1/details.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| results | объекты details[] | Найденные объекты (объекты details). | […] |
| notFound | массив: целое или строка | Коды из запроса, которых нет в ГАР. | […] |
Ответ по координатам
Ответ /v1/geolocate.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| results | объекты[] | Адреса рядом с точкой, сначала ближайший. | […] |
| results[].id | целое | Код объекта в ГАР. | 26847188 |
| results[].distanceM | число | Расстояние от точки, метры (до 0,1 м). | 0.6 |
| results[].qcGeo | целое | Точность координат объекта: 0 — дом, 1 — ближайший дом, 2 — улица. | 0 |
| results[].address | строка | Адрес одной строкой. | "г Москва, ул Сухонская, д 11" |
| results[].details | объект details | Все поля адреса, если в запросе details=true. | {…} |
Ошибка
Ответ с любым статусом, кроме 200. Коды — на странице «Ошибки и лимиты».
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| error | объект | Описание ошибки. | {…} |
| error.code | строка | Код ошибки, например bad_parameter или daily_limit. | "bad_parameter" |
| error.message | строка | Пояснение для разработчика, по-английски. | "'count' must be in 1..50" |
Служебные маршруты
/health, /ready и /version: без ключа, не считаются.
| Поле | Тип | Что это | Пример |
|---|---|---|---|
| /health status | строка | ok, если сервер работает. | "ok" |
| /ready status | строка | ready, если сервер готов отвечать. | "ready" |
| /ready accessMode | строка | Режим проверки ключей на сервере. Значения: off, file, sync. | "file" |
| /ready keysVersion | целое | Версия таблицы ключей на сервере. | 1 |
| /ready syncAgeSeconds | целое или null | Сколько секунд назад сервер обновил ключи. | нет в примерах |
| /version version | строка | Версия API. | "0.2.0" |
| /version dataVersion | строка | Версия данных ГАР; то же, что в заголовке X-Data-Version. | "2026.01.02 v.219" |
| /version osmDate | строка | Дата данных OpenStreetMap. | "2026-10-10" |
| /version accessMode | строка | Режим проверки ключей на сервере. Значения: off, file, sync. | "file" |
Таблица собрана из схемы ответов API; примеры — из ответов на данных ГАР 2026.01.02 v.219.