Сервис возвращает детальную информацию об одном или нескольких геообъектах по их идентификаторам. Полезен, когда нужно обогатить уже известные объекты дополнительными данными — геометрией, адресом, входами и т.д.
| Параметр | Тип | По умолчанию | Описание | Пример |
|---|---|---|---|---|
q |
string | — | Список ID геообъектов через запятую (в любом формате). | q=0200000001A75A2C,030000000000EB1D |
lang |
2-char | locale | Язык ответа. | lang=ru |
fields |
string | — | Поля ответа: address_details, address, pin, bbox, geometry, entrances, type, ref. |
fields=address,pin,geometry,type |
format |
enum | default |
Формат ответа: default или geojson. |
format=geojson |
query_status |
boolean | false |
Добавить в ответ статус внутренних запросов (отладка). | query_status=true |
verbose_debug |
boolean | false |
Более подробная отладочная информация. | verbose_debug=true |
extra |
boolean | false |
Добавить доп. поля: ssid, properties.location_id, properties.location_id_hex. |
extra=true |
| Поле | Тип | Описание |
|---|---|---|
request |
string | Строка исходного запроса |
results |
array | Массив объектов |
status |
object | Статус обработки (при query_status=true) |
Каждый элемент results аналогичен формату /api/search.
Запрос:
/api/items?q=0200000001A75A2C,030000000000EB1D&fields=address,pin,bbox,geometry,type
Ответ:
{
"request": "/api/items?q=0200000001A75A2C,030000000000EB1D&fields=address,pin,bbox,geometry,type",
"results": [
{
"address": "Россия, Москва, ..., Ленинградский проспект, 39 с14",
"pin": [37.538851, 55.796731],
"bbox": [37.538253, 55.796405, 37.539368, 55.79694],
"geometry": { "type": "Polygon", "coordinates": [[["..."]]] },
"type": "building"
},
{
"address": "Россия",
"pin": [97.745306, 64.686314],
"type": "country"
}
]
}
Запрос:
/api/items?q=0200000001A75A2C&fields=address,geometry,type&format=geojson
{
"openapi": "3.0.0",
"info": {
"title": "Геокодер — Items API",
"version": "3.0.0"
},
"paths": {
"/api/items": {
"get": {
"summary": "Информация об объектах по ID",
"description": "Возвращает детальные данные о геообъектах по их идентификаторам.",
"tags": ["Items"],
"parameters": [
{
"name": "q",
"in": "query",
"description": "Идентификаторы объектов через запятую",
"schema": { "type": "string", "example": "0200000001A75A2C,030000000000EB1D" }
},
{
"name": "lang",
"in": "query",
"description": "Язык ответа (2-буквенный код ISO 639-1)",
"schema": { "type": "string", "default": "loc", "example": "ru" }
},
{
"name": "fields",
"in": "query",
"description": "Список полей ответа через запятую",
"schema": {
"type": "string",
"example": "address,pin,bbox,geometry,type",
"enum": ["address_details", "address", "pin", "bbox", "geometry", "entrances", "type", "ref", "user_pin"]
}
},
{
"name": "format",
"in": "query",
"description": "Формат ответа",
"schema": { "type": "string", "enum": ["default", "geojson"], "default": "default" }
},
{
"name": "query_status",
"in": "query",
"description": "Включить статус внутренних запросов в ответ",
"schema": { "type": "boolean", "default": false }
},
{
"name": "verbose_debug",
"in": "query",
"description": "Включить расширенную отладочную информацию",
"schema": { "type": "boolean", "default": false }
},
{
"name": "extra",
"in": "query",
"description": "Включить дополнительные поля: ssid, location_id, location_id_hex",
"schema": { "type": "boolean", "default": false }
}
],
"responses": {
"200": {
"description": "Список объектов с запрошенными полями",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"request": { "type": "string" },
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": { "type": "string" },
"address_details": { "type": "object" },
"pin": { "type": "array", "items": { "type": "number" } },
"bbox": { "type": "array", "items": { "type": "number" } },
"geometry": { "type": "object" },
"entrances": { "type": "array" },
"type": { "type": "string" },
"ref": { "type": "string" }
}
}
},
"status": { "type": "object" }
}
}
}
}
},
"400": { "description": "Некорректный запрос" }
}
}
}
}
}