Документація по API від AIMap
Discover APIs, integration guides, and other documentation
Отримати всі об’єкти
Востаннє оновлено 19 лютого, 2021
GET /objects/paged
Дозволяє отримати дані по усім об’єктам в базі AIMap з додатковими фільтрами.
Відповідь
-
Якщо запит успішний, повертає список об'єктів з пагінацією.
Разом із списком об’єктів, кожен запит буде повертати два значення offset і has-more. Якщо has-more true
потрібно відправити ще один запит, використовуючи offset, щоб отримати наступну сторінку з записами об’єктів. Зазвичай використовується з рекурсивними функціями, щоб отримати список з усіма об’єктами в базі.
Обов'язкові параметри
|
Як використовувати
|
Опис
|
API Token
|
Authorization: Bearer {token} header або token={token} параметр запиту
|
Використовується для автентифікації запиту. Токен можна згенерувати в кабінеті користувача тут.
|
Необов'язкові параметри
|
Як використовувати | Опис |
Ліміт
|
limit=
Параметр запиту
|
Кількість значень, які повернуться в запиті. Default 250. Максимум 1000.
|
Діапазон дат
|
date_start=""&date_end=""
Параметр запиту.
|
Дата оновлення об’єкту в базі. Формат "2021-12-23". Default актуальний рік.
|
Класифікатор AIMap
|
class=
Параметр запиту, може записуватись декілька раз.
|
Класифікатор, який ділиться на 16 основних груп.
|
Регіон
|
region=
Параметр запиту, може записуватись декілька раз.
|
Область
|
Мітсо
|
town=
Параметр запиту, може записуватись декілька раз.
|
Місто
|
Етап будівництва
|
stage_building=
Параметр запиту, може записуватись декілька раз.
|
Стадія будівництва (дозволено, завершено і тд.). Defalut дозволено.
|
Етап документації
|
stage_documentation=
Параметр запиту, може записуватись декілька раз.
|
Етап підготовки документації
|
Класс наслідків
|
cons_class=
Параметр запиту, може записуватись декілька раз.
|
1 - назначні наслідки, в яких постійно перебувають 50 людай, та тимчасово - 100
2 - середнє значення, об’єкти місцевого/регіонально значення
3 - значні наслідки, об’єкти загальнодержавного значення
|
Поля
|
prop=
Параметр запиту, може записуватись декілька раз.
|
Перелік полів, які повернуться в запиті. Детальну структуру таблиці можна побачити в кінці документу. Default "aimap_id", "name", "description", "address", "region", "town", "date_updated",
"aimap_classifier", "consequence_class", "stage_documentation", "stage_building". |
Перелік полів для параметру prop
Поле | Опис |
aimap_id | Унікальний класифікатор об'єкта |
name | Назва об'єкта |
description | Опис об'єкта |
kadastr | Кадастровий номер земельної ділянки |
lon | Довгота |
lat | Широта |
address | Повна адреса |
region | Область |
town | Місто |
street | Вулиця |
build_num | Номер будинку |
dk_018_2000 | Державний класифікатор будівель та споруд |
aimap_classifier | Класифікатор об'єктів AIMap |
consequence_class | Клас наслідків |
stage_documentation | Етап документації |
stage_building | Етап будівництва |
construction_type | Тип будівництва |
floors_number | К-сть поверхів |
object_square | Площа об'єкта |
JSON
Example GET URL:
https://api.aimapa.com/objects/paged?offset=250&limit=2
{
"objects": [
{
"address": "Україна, Кіровоградська обл., село Нагірне, вулиця Широка, ",
"aimap_classifier": "Електромережі та електростанції",
"aimap_id": "1268449",
"consequence_class": "1",
"date_added": "2021-01-06T00:00:00Z",
"description": "Нове будівництво ПЛ-10 кВ Л-173 оп.№167 ПС \"Подорожнє\" - 35/10 кВ та КТП -583 для підключення садового будинку гр. Кириченко М.В., що розташовано за адресою: вул. Широка, буд. №10-Е в с. Нагірне Світловодського району Кіровоградської області",
"name": "Нове будівництво ПЛ-10 кВ Л-173 оп.№167 ПС \"Подорожнє\" - 35/10 кВ та КТП -583 для підключення садового будинку гр. Кириченко М.В., що розташовано за адресою: вул. Широка, буд. №10-Е в с. Нагірне Світловодського району Кіровоградської області",
"region": "Кіровоградська",
"stage_building": "дозволено",
"stage_documentation": "зміна даних у декларації про початок підготовчих робіт",
"town": "село Нагірне"
},
{
"address": "Україна, Чернівецька обл., село Слобода-Банилів, вулиця Яремчука Н., ",
"aimap_classifier": "Будинки житлові котеджного типу",
"aimap_id": "1268452",
"consequence_class": "1",
"date_added": "2021-01-06T00:00:00Z",
"description": "Будівництво житлового будинку",
"name": "Будівництво житлового будинку",
"region": "Чернівецька",
"stage_building": "дозволено",
"stage_documentation": "зміна даних у декларації про початок підготовчих робіт",
"town": "село Слобода-Банилів"
}
],
"has_more": true,
"offset": 252
}