Endpointy

Przykłady używają numeru KRS 0001009332. W adresach z parametrem {krs} podstaw własny numer KRS.

Endpointy publiczne nadal można testować bez klucza. Integracje produkcyjne mogą wysyłać Authorization: Bearer rkrs_... albo X-KRS-API-Key; wtedy system policzy użycie i zastosuje limit przypisany do klucza.

Indeks i wyszukiwanie

Endpointy do szukania podmiotów, przeglądania rynku KRS i pobierania danych zbiorczych.

Metoda Adres Parametry Opis
GET /api/krs/search?q=BALTICBIKE&rejestr=P Otwórz przykład q, rejestr, page, per_page, import, refresh Wyszukuje podmioty po nazwie, numerze KRS, NIP albo REGON.
GET /api/krs/organizations?sort=entry Otwórz przykład q, rejestr, wojewodztwo, status, pkd, sort, page, per_page Zwraca katalog organizacji KRS z filtrami po województwie, statusie, PKD i sortowaniem.
GET /api/krs/events?per_page=25 Otwórz przykład q, rejestr, type, page, per_page Zwraca globalną oś zdarzeń KRS z rejestracji, wpisów, sprawozdań i wzmianek.
GET /api/krs/registry-changes?operation=introduced Otwórz przykład q, rejestr, operation, area, page, per_page Zwraca globalny indeks zmian rejestrowych z odpisów pełnych KRS.
GET /api/krs/branches?section=N Otwórz przykład q, rejestr, section, page, per_page Zwraca katalog branż PKD z liczbą podmiotów i przykładowymi firmami.
GET /api/krs/people?role=prezes%20zarz%C4%85du Otwórz przykład q, rejestr, role, page, per_page Zwraca katalog osób, wspólników i funkcji występujących w zaimportowanych odpisach KRS.
GET /api/krs/person?name=M*****%20K********%20B***** Otwórz przykład name, rejestr, page, per_page Zwraca profil wybranej osoby z listą funkcji i podmiotów z lokalnego indeksu KRS.
GET /api/krs/relations?type=pkd&value=77.21.Z Otwórz przykład type, value, page, per_page Pokazuje podmioty powiązane przez osobę albo kod PKD.
POST /api/krs/import Wymaga żądania POST krs, rejestr, _csrf Importuje aktualny odpis i sprawozdania dla wskazanego numeru KRS.

Profil firmy

Endpointy dla pojedynczego podmiotu KRS. Parametr {krs} zastąp numerem KRS z zerami wiodącymi.

Metoda Adres Parametry Opis
GET /api/krs/company/{krs}?with_full=1 Otwórz przykład rejestr, refresh, with_full Pełny profil firmy: dane, osoby, PKD, sprawozdania, finanse, zdarzenia i powiązania.
GET /api/krs/company/{krs}/report Otwórz przykład rejestr, refresh Gotowy raport organizacji z danymi rejestrowymi, finansami, ryzykiem i relacjami.
GET /api/krs/company/{krs}/contract-party Otwórz przykład rejestr Dane kontrahenta do umowy: nazwa, adres, NIP, REGON, reprezentacja.
GET /api/krs/company/{krs}/legal-status Otwórz przykład rejestr, refresh Status prawny, ostatni wpis, dokumenty finansowe i sygnały ostrzegawcze.
GET /api/krs/company/{krs}/risk Otwórz przykład rejestr, refresh Ocena ryzyka kontrahenta na podstawie danych KRS, finansów, VAT i powiązań.
GET /api/krs/company/{krs}/vat Otwórz przykład date, refresh Status VAT i rachunki z białej listy podatników.

Finanse i dokumenty

Dane finansowe i dokumenty z RDF/KRS z możliwością eksportu.

Metoda Adres Parametry Opis
GET /api/krs/company/{krs}/financial-timeline Otwórz przykład refresh Oś dokumentów finansowych według lat i okresów obrotowych.
GET /api/krs/company/{krs}/financial-year/{year} Otwórz przykład refresh Szczegół jednego roku finansowego: metryki, dokumenty i linki RDF.
GET /api/krs/company/{krs}/finances Otwórz przykład refresh Podsumowanie finansów, metryk i dostępnych dokumentów.
GET /api/krs/company/{krs}/reports.csv Otwórz przykład brak Eksport listy sprawozdań finansowych do CSV.
GET /api/krs/company/{krs}/export?with_full=1 Otwórz przykład with_full Eksport kompletnego pakietu danych firmy w JSON.
GET /api/krs/company/{krs}/extract/current Otwórz przykład refresh Surowy odpis aktualny z oficjalnego API KRS.
GET /api/krs/company/{krs}/extract/full Otwórz przykład refresh Surowy odpis pełny z oficjalnego API KRS.

Powiązania, zdarzenia i akta

Endpointy dla grafu relacji, historii wpisów, akt i wzmianek.

Metoda Adres Parametry Opis
GET /api/krs/company/{krs}/relation-graph Otwórz przykład limit, company_limit Graf powiązań firmy przez osoby i PKD.
GET /api/krs/company/{krs}/events Otwórz przykład history_limit, refresh Oś zdarzeń jednej firmy: rejestracja, wpisy, sprawozdania i wzmianki.
GET /api/krs/company/{krs}/history Otwórz przykład limit, refresh Historia zmian z odpisu pełnego.
GET /api/krs/company/{krs}/registry-changes Otwórz przykład refresh Zmiany rejestrowe uporządkowane według wpisów i obszarów danych.
GET /api/krs/company/{krs}/registry-files Otwórz przykład refresh Indeks akt rejestrowych i sygnatur z odpisu pełnego.
GET /api/krs/company/{krs}/mentions Otwórz przykład refresh Wzmianki o dokumentach z aktualnego odpisu KRS.
GET /api/krs/company/{krs}/transformations Otwórz przykład refresh Przekształcenia i historia powstania podmiotu.

Dane rozszerzone

Integracje uzupełniające profil firmy o dane z innych publicznych rejestrów.

Metoda Adres Parametry Opis
GET /api/krs/company/{krs}/public-aid Otwórz przykład refresh Pomoc publiczna z rejestru SUDOP, gdy dostępny jest NIP podmiotu.
GET /api/krs/company/{krs}/beneficial-owners Otwórz przykład refresh Beneficjenci rzeczywiści z CRBR, gdy dostępny jest NIP podmiotu.
GET /api/krs/company/{krs}/msig Otwórz przykład refresh, limit Wpisy z Monitora Sądowego i Gospodarczego powiązane z KRS.
GET /api/krs/company/{krs}/notices Otwórz przykład mode, page, per_page Przetargi i ogłoszenia powiązane z firmą po NIP, REGON lub nazwie.
GET /api/krs/company/{krs}/people.csv Otwórz przykład brak Eksport osób i organów do CSV.
GET /api/krs/company/{krs}/pkd.csv Otwórz przykład brak Eksport działalności PKD do CSV.

Importer wsadowy

Cron może zasilać lokalny indeks pojedynczym numerem, listą, plikiem CSV/TXT albo zakresem numerów KRS. Tryb --dry-run pokazuje plan bez odpytywania oficjalnego API.

PrzykładZastosowanie
php cron/import_krs.php --krs=0001009332 Import jednej firmy razem ze sprawozdaniami RDF i metrykami finansowymi.
php cron/import_krs.php --file=/home/import/krs.csv --limit=500 --skip-existing --delay-ms=300 Import pliku CSV/TXT bez ponownego pobierania firm już zapisanych w bazie.
php cron/import_krs.php --range=0001009300-0001009350 --dry-run Sprawdzenie planu importu dla zakresu numerów KRS.
php cron/import_krs.php --help Lista wszystkich opcji importera.