Skip to content

the-clarity-project/api

master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

API для Clarity Project

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

Робота з API

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

Для роботи з API необхідно створити та використовувати ключ доступу, який передається у GET-параметрі key, наприклад: https://com.clarityapp.pro/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:

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

ФОП

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

Закупівлі

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

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

  • persons.search
  • persons.info

Інше

  • treasury.transactions

Releases

No releases published

Packages

No packages published