API пошуку компаній: назва або частина коду ЄДРПОУ

Пошук за назвою, частиною назви або кодом повертає до 10 компаній з ЄДР: код ЄДРПОУ, повну і скорочену назву та стан. Далі за кодом береться повна картка.

Де застосовують: Підказки у полі «Контрагент» форми, пошук клієнта за назвою з рахунку, звірка написання назви.

Запит

GEThttps://dani.initask.com/v1/company/search

Параметр	Де	Опис
`q` обовʼязковий	запит	Назва, частина назви або код ЄДРПОУ, від 2 до 120 символів.

Приклади

curl

curl -H "Authorization: Bearer $INITASK_KEY" "https://dani.initask.com/v1/company/search?q=%D0%BF%D1%80%D0%B8%D0%B2%D0%B0%D1%82%D0%B1%D0%B0%D0%BD%D0%BA"

JavaScript

const r = await fetch("https://dani.initask.com/v1/company/search?q=%D0%BF%D1%80%D0%B8%D0%B2%D0%B0%D1%82%D0%B1%D0%B0%D0%BD%D0%BA", {
  headers: { Authorization: `Bearer ${process.env.INITASK_KEY}` },
});
const { ok, data, error } = await r.json();
console.log(r.headers.get("X-RateLimit-Remaining"), data);

Python

import os, requests

r = requests.get(
    "https://dani.initask.com/v1/company/search?q=приватбанк",
    headers={"Authorization": f"Bearer {os.environ['INITASK_KEY']}"},
    timeout=10,
)
body = r.json()
print(r.headers["X-RateLimit-Remaining"], body["data"])

Змінна INITASK_KEY містить ваш ключ. Без ключа запит теж пройде в межах 100 запитів на добу.

Відповідь

Справжня відповідь на запит /v1/company/search?q=приватбанк, масиви скорочено до трьох елементів.

{
  "ok": true,
  "data": {
    "q": "приватбанк",
    "items": [
      {
        "edrpou": "14360570",
        "name": "АКЦІОНЕРНЕ ТОВАРИСТВО КОМЕРЦІЙНИЙ БАНК \"ПРИВАТБАНК\"",
        "short_name": "АТ КБ \"ПРИВАТБАНК\"",
        "status": "active"
      },
      {
        "edrpou": "46379669",
        "name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"ПриватБанк 1\"",
        "short_name": "ТОВ \"ПриватБанк\"",
        "status": "cancelled"
      },
      {
        "edrpou": "42938090",
        "name": "ВСЕУКРАЇНСЬКА ПРОФЕСІЙНА СПІЛКА ПРАЦІВНИКІВ АКЦІОНЕРНОГО ТОВАРИСТВА КОМЕРЦІЙНОГО БАНКУ \"ПРИВАТБАНК\"",
        "short_name": "ПРОФСПІЛКА \"ПРИВАТБАНК\"",
        "status": "active"
      }
    ]
  },
  "meta": {
    "source": "reestr.initask.com",
    "cached": false
  }
}

`q`	запит, як його прочитав пошук
`items`	до 10 збігів
`items[].edrpou`	код ЄДРПОУ
`items[].name`	повна назва
`items[].short_name`	скорочена назва
`items[].status`	стан латиницею

Помилки

HTTP	error	Коли
400	`bad_request`	запит коротший за 2 символи або довший за 120
429	`rate_limited`	ліміт вичерпано, дивіться Retry-After
502, 504	`upstream_*`	джерело даних недоступне, ліміт не витрачається

Джерело і свіжість

Дані: Єдиний державний реєстр юридичних осіб (ЄДР), reestr.initask.com. Шлюз тримає відповідь у кеші 10 хв, поле meta.cached показує, звідки вона.

Питання і відповіді

Скільки результатів повертає пошук?

До 10 компаній, найточніші збіги першими. Для повної картки візьміть edrpou і викличте /v1/company/{edrpou}.

Чи шукає пошук за скороченою назвою?

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

Що буде, якщо нічого не знайдено?

Відповідь 200 з порожнім масивом items: так клієнт відрізняє порожній результат від помилки.

Повʼязані ендпоінти

Отримати ключ API

Ключ прийде листом з каси Initask. Безкоштовний ключ дає 100 запитів на добу, платний тариф додається до того самого ключа.