Kompletna dokumentacja techniczna wszystkich endpointów REST API DataPort.pl
https://dataport.pl/api
v1
API Key (Header)
/api/v1/company/{nip}
Pobierz dane firmy po NIP
Pobiera dane firmy z GUS BIR1.1 na podstawie numeru NIP. Jeśli firma nie istnieje w lokalnej bazie, zostanie automatycznie pobrana z GUS i zapisana. Wykorzystuje inteligentny cache.
| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
nip |
string |
Tak | 10-cyfrowy numer NIP firmy (bez myślników) |
| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
format |
string |
Nie | Format odpowiedzi: simple (4 pola) lub full (8 pól). Domyślnie: simple |
| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
X-API-Key |
string |
Tak | Klucz autoryzacji API |
Accept |
string |
Nie | Typ odpowiedzi. Wartość: application/json |
simple{
"success": true,
"nip": "1234567890",
"regon": "123456789",
"nazwa": "PRZYKŁADOWA FIRMA SP. Z O.O.",
"adres": "ul. Testowa 123/45, 00-001 Warszawa"
}full{
"success": true,
"nip": "1234567890",
"regon": "123456789",
"nazwa": "PRZYKŁADOWA FIRMA SP. Z O.O.",
"ulica": "ul. Testowa",
"numer_budynku": "123",
"numer_lokalu": "45",
"kod_pocztowy": "00-001",
"miasto": "Warszawa"
}{
"success": false,
"message": "Firma nie istnieje"
}{
"success": false,
"message": "Nieprawidłowy klucz API",
"error": "INVALID_API_KEY"
}{
"success": false,
"message": "Przekroczono dzienny limit zapytań dla Twojego konta",
"error": "RATE_LIMIT_EXCEEDED",
"limit": 100,
"used": 101,
"info": "Limit dotyczy wszystkich Twoich kluczy API łącznie"
}curl -X GET "https://dataport.pl/api/api/v1/company/1234567890?format=simple" \
-H "X-API-Key: your_api_key_here" \
-H "Accept: application/json"/api/v1/company
Wyszukaj firmę po NIP (POST)
Alternatywna metoda wyszukiwania firmy po NIP używając metody POST. Zwraca te same dane co endpoint GET. Użyteczne gdy NIP jest przekazywany w body żądania.
| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
format |
string |
Nie | Format odpowiedzi: simple lub full. Domyślnie: simple |
| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
X-API-Key |
string |
Tak | Klucz autoryzacji API |
Content-Type |
string |
Tak | Typ zawartości. Wartość: application/json |
Accept |
string |
Nie | Typ odpowiedzi. Wartość: application/json |
| Nazwa | Typ | Wymagany | Opis |
|---|---|---|---|
nip |
string |
Tak | 10-cyfrowy numer NIP firmy |
{
"nip": "1234567890"
}{
"success": true,
"nip": "1234567890",
"regon": "123456789",
"nazwa": "PRZYKŁADOWA FIRMA SP. Z O.O.",
"adres": "ul. Testowa 123/45, 00-001 Warszawa"
}{
"success": false,
"message": "Firma nie istnieje"
}{
"success": false,
"message": "Pole nip jest wymagane",
"error": "VALIDATION_ERROR"
}{
"success": false,
"message": "Nieprawidłowy klucz API",
"error": "INVALID_API_KEY"
}{
"success": false,
"message": "Przekroczono dzienny limit zapytań dla Twojego konta",
"error": "RATE_LIMIT_EXCEEDED",
"limit": 100,
"used": 101
}curl -X POST "https://dataport.pl/api/api/v1/company?format=simple" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"nip":"1234567890"}'200
400
401
404
429
500