Dla programistów

Dokumentacja API

REST, odpowiedzi w JSON. Uwierzytelnianie kluczem w nagłówku. Klucz kupisz w cenniku.

Uwierzytelnianie

Do każdego żądania dołącz nagłówek z kluczem:

Authorization: Bearer TWOJ_KLUCZ_API

Limity (na minutę / dobę / miesiąc) oraz zakres uprawnień są przypisane do klucza. Nagłówki odpowiedzi X-RateLimit-* pokazują pozostały limit.

Punkty końcowe bazowy adres: https://krs.coreinfra.eu/api/v1

GEThttps://krs.coreinfra.eu/api/v1/status

Stan usługi i liczba podmiotów. Bez klucza.

GEThttps://krs.coreinfra.eu/api/v1/search?q=fraza&limit=20&offset=0

Wyszukiwarka firm po nazwie (tryb boolean).

GEThttps://krs.coreinfra.eu/api/v1/company/{krs}

Pełne dane firmy: rejestr, adres, PKD, reprezentacja.

GEThttps://krs.coreinfra.eu/api/v1/relations/{krs}

Graf powiązań i firmy z tymi samymi osobami.

GEThttps://krs.coreinfra.eu/api/v1/statements/{krs}

Karta sprawozdawczości — lata złożeń (bez kwot).

GEThttps://krs.coreinfra.eu/api/v1/person/{slug}

Funkcje pełnione przez osobę (jeśli nie ukryta).

GEThttps://krs.coreinfra.eu/api/v1/export?q=fraza&limit=1000

Zbiorczy eksport wyników w JSON.

Przykład

# wyszukiwanie
curl -H "Authorization: Bearer TWOJ_KLUCZ" \
     "https://krs.coreinfra.eu/api/v1/search?q=orlen&limit=5"

# dane jednej firmy
curl -H "Authorization: Bearer TWOJ_KLUCZ" \
     "https://krs.coreinfra.eu/api/v1/company/0000006447"

Kody odpowiedzi

200	OK — dane w treści
400	Błędne parametry żądania
401	Brak lub nieprawidłowy klucz
403	Klucz bez uprawnienia / spoza dozwolonego IP / wygasły
404	Podmiot nie występuje w bazie serwisu
429	Przekroczony limit — sprawdź nagłówek Retry-After