ГарнаХата: Відкритий API

Проект «Гарнахата» надає доступ до всіх наявних даних у машинозчитуваному форматі JSON за допомогою простого відкритого API.

Для доступу до даних у форматі JSON достатньо додати параметр адресної строки "format=json" до будь-якої сторінки пошуку.

API надає доступ до двох типів об'єктів: Адрес та Власників. Об'єкти Адреса також мають інформацію про власників нерухомості за цією адресою (масив properties). У свою чергу об'єкт Власник має інформацію про Адресу, до якої відноситься цей запис про право власності.

Наразі через відкритий API доступні такі URL:

В тих випадках, де наявний параметр адресної строки "page", у результатах використовується нумерація сторінок для скорочення кількості даних, що передаються.

Інформація щодо нумерації доступна за ключем "paginator" у словнику з ключем "addresses" або "ownerships". Наприклад:

"paginator": {"per_page": 30, "count": 60, "num_pages": 2}

Це означає що за даним запитом існує 60 об'єктів, розподілених на 2 сторінки по 30 об'єктів на одну сторінку. Нумерація починається з одиниці.

Якщо у такому запиті не вказати параметр "page", то будуть передані результати для першої сторінки.

Повну схему даних об'єкта Адреса можна подивитись у тут, а схему даних об'єкта Власник тут