API для Clarity Project

Clarity Project — система аналітики відкритих даних, що поєднує інформацію з понад 120 відкритих державних реєстрів.

Робота з API

Всі методи API викликаються за допомогою GET-запиту вигляду https://clarity-project.info/api/api.method?key=xxx&param=value, та повертають відповідь у форматі JSON.

Для роботи з API необхідно створити та використовувати ключ доступу, який передається у GET-параметрі key, наприклад: https://clarity-project.info/api/edr.info/14360570?key=f8028-7a2b9-50ab3-2505b

У випадку помилки, повертається об'єкт з ключом error, що містить опис помилки, наприклад:

{
  "error": {
    "code": 401,
    "text": "Invalid API key "
  },
  "stats": {
    "query_time": null
  }
}

У випадку успішного запиту у ключі stats повертається статистика запиту, а у ключі quota — ліміти запитів.

{
  // ...
  "stats": {
    "query_time": 0.689716100692749
  },
  "quota": {
    "used": 173717,
    "max": -1,
    "key_used": 17615
  }
}

Створення ключа доступу

Управляти ключами доступу можна на сторінці налаштувань акаунту.

Методи API:

Юридичні особи та ФОП

• edr.info/{edrpou} - повертає інформацію по юридичній особі або ФОП за їх кодом ЄДРПОУ/РНОКПП;
• edr.search - пошук юридичних осіб/ФОП;
• edr.changes - повертає стрічку змін в інформації про юридичні особи;
• edrpou.history - повертає історію змін з ЄДР для юридичної особи;
• edr.info/{edrpou}/licenses - повертає ліцензії обраної юо/фоп;
• edr.info/{edrpou}/persons - повертає пов'язаних осіб;
• edr.info/{edrpou}/treasury - повертає інформацію по транзакціям Казначейства;
• edr.info/{edrpou}/vehicles - інформація про автотранспорт у користуванні;
• edr.finances/{edrpou} - фінансові звіти юридичних осіб;
• edr.history - повертає історію змін;
• edr.relations - повертає зв'язки;

Податки

• tax.info/{edrpou} - повертає інформацію про платника податків за кодом ЄДРПОУ/РНОКПП;

ФОП

• fop.byname - повертає перелік ФОП за точним збігом по ПІБ;
• fop.info - повертає інформацію по ФОП за його id;

Закупівлі

• tender.search - пошук закупівель;
• tender.ids - пошук ідентифікаторів закупівель;

Фізичні особи

• persons.search - пошук за ПІБ;
• persons.info - інформація за ПІБ;

Інше

• treasury.transactions