API danych o przedsiębiorcach i spółkach

Uwierzytelnianie

Każde zapytanie wymaga nagłówka Authorization z kluczem w schemacie Bearer. Klucz wygenerujesz w panelu, w zakładce API. Klucz widzisz w całości tylko raz, w chwili wygenerowania. U siebie przechowujemy wyłącznie jego skrót, więc zapisz go w bezpiecznym miejscu. Zgubiony klucz unieważnisz i wygenerujesz nowy w tym samym miejscu panelu.

Authorization: Bearer <klucz>

Odpowiedzi mają format JSON w kodowaniu UTF-8.

Limity i nagłówki

Każde zapytanie zużywa jedno zapytanie z miesięcznego limitu planu. Stan limitu podajemy w nagłówkach każdej odpowiedzi.

Nagłówek	Znaczenie
X-Limit-Miesiac	Liczba zapytań w miesiącu w Twoim planie (20 000 w planie Firma, 200 000 w planie Instytucja).
X-Limit-Zostalo	Liczba zapytań, które zostały do końca bieżącego miesiąca.

Błędy

Kod	Kiedy	Co zrobić
401	Brak klucza albo klucz nieprawidłowy.	Sprawdź nagłówek Authorization i klucz w panelu.
403	Twój plan nie obejmuje API.	Przejdź na plan Firma albo Instytucja w cenniku.
429	Limit zapytań w miesiącu wyczerpany.	Poczekaj na nowy miesiąc albo przejdź na plan Instytucja.

Ochrona osób po sprzeciwie

Osoby, które złożyły sprzeciw wobec publikacji profilu, nie są zwracane przez API, ani na liście, ani pod adresem profilu.

Lista osób

GET /api/v1/osoby

Wyszukuje osoby po imieniu i nazwisku. Zwraca 20 wyników na stronę.

Parametr	Wymagany	Opis
q	tak	Imię i nazwisko osoby.
wojewodztwo	nie	Slug województwa, zawęża wyniki.
strona	nie	Numer strony wyników, domyślnie 1.

Przykład zapytania

curl "https://przedsiebiorcy.com.pl/api/v1/osoby?q=<imie+nazwisko>&wojewodztwo=<slug>&strona=1" \
  -H "Authorization: Bearer <klucz>"

Przykład odpowiedzi

[
  {
    "slug": "<slug>",
    "imie": "<imie>",
    "nazwisko": "<nazwisko>",
    "miasto": "<miasto>",
    "wojewodztwo": "<wojewodztwo>",
    "liczba_spolek": 0,
    "wartosc_udzialow_min": 0,
    "wartosc_udzialow_max": 0,
    "data_danych": "<data danych>"
  }
]

Profil osoby

GET /api/v1/osoby/{slug}

Zwraca dane osoby jak na liście, a do tego jej role w spółkach i opis.

Parametr	Wymagany	Opis
slug	tak	Slug osoby z listy osób, część adresu.

Przykład zapytania

curl "https://przedsiebiorcy.com.pl/api/v1/osoby/<slug>" \
  -H "Authorization: Bearer <klucz>"

Przykład odpowiedzi

{
  "slug": "<slug>",
  "imie": "<imie>",
  "nazwisko": "<nazwisko>",
  "miasto": "<miasto>",
  "wojewodztwo": "<wojewodztwo>",
  "liczba_spolek": 0,
  "wartosc_udzialow_min": 0,
  "wartosc_udzialow_max": 0,
  "data_danych": "<data danych>",
  "role": [
    {
      "spolka": "<nazwa spolki>",
      "rola": "<rola>",
      "od": "<data od>",
      "do": "<data do>",
      "udzial_procent": 0
    }
  ],
  "opis": "<opis>"
}

Lista spółek

GET /api/v1/spolki

Wyszukuje spółki po nazwie, numerze NIP albo numerze KRS.

Parametr	Wymagany	Opis
q	tak	Nazwa spółki, NIP albo KRS.

Przykład zapytania

curl "https://przedsiebiorcy.com.pl/api/v1/spolki?q=<nazwa+albo+NIP+albo+KRS>" \
  -H "Authorization: Bearer <klucz>"

Przykład odpowiedzi

[
  {
    "slug": "<slug>",
    "nazwa": "<nazwa spolki>",
    "krs": "<numer KRS>",
    "nip": "<numer NIP>",
    "regon": "<numer REGON>",
    "forma": "<forma prawna>",
    "miasto": "<miasto>",
    "wojewodztwo": "<wojewodztwo>",
    "status": "<status>"
  }
]

Dane spółki

GET /api/v1/spolki/{slug}

Zwraca dane spółki jak na liście, a do tego osoby z rolami i udziałami oraz sprawozdania finansowe.

Parametr	Wymagany	Opis
slug	tak	Slug spółki z listy spółek, część adresu.

Przykład zapytania

curl "https://przedsiebiorcy.com.pl/api/v1/spolki/<slug>" \
  -H "Authorization: Bearer <klucz>"

Przykład odpowiedzi

{
  "slug": "<slug>",
  "nazwa": "<nazwa spolki>",
  "krs": "<numer KRS>",
  "nip": "<numer NIP>",
  "regon": "<numer REGON>",
  "forma": "<forma prawna>",
  "miasto": "<miasto>",
  "wojewodztwo": "<wojewodztwo>",
  "status": "<status>",
  "osoby": [
    {
      "rola": "<rola>",
      "udzial_procent": 0
    }
  ],
  "sprawozdania": [
    {
      "rok": 0,
      "przychody": 0,
      "zysk_netto": 0,
      "kapital_wlasny": 0
    }
  ]
}

Webhook alertów w planie Firma

W planie Firma możesz ustawić w panelu adres, na który wysyłamy alerty o obserwowanych osobach i spółkach. Każdy alert to zapytanie POST z treścią w formacie JSON. Wysyłamy je przy takich zdarzeniach jak:

• nowa spółka obserwowanej osoby,
• zmiana roli w spółce,
• nowe sprawozdanie finansowe,
• zmiana udziałów.

Adres webhooka zmienisz albo wyłączysz w panelu w dowolnej chwili.