Dokumentacja API
Zacznij używać JARS.LT API w kilka minut
Dokumentacja API
Zacznij używać JARS.LT API w kilka minut
Uwierzytelnianie#
Wszystkie żądania API wymagają klucza API. Dodaj go jako x-api-key nagłówek:
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/companies/search?q=UAB
Bazowy URL#
Wszystkie endpointy API zaczynają się od:
https://api.jars.lt/api/v1
Node.js SDK#
Oficjalny SDK TypeScript/JavaScript do łatwej integracji z JARS.LT API.
Instalacja
npm install @jars-lt/sdkUżycie
import { JarsClient } from '@jars-lt/sdk';
const client = new JarsClient({
apiKey: 'your_api_key_here'
});
// Search companies
const companies = await client.searchCompanies({ q: 'UAB Maxima' });
// Get company by code
const company = await client.getCompany('123456789');
// Search addresses
const addresses = await client.searchAddresses({ q: 'vilnius gedimino' });
// Normalize address (with typos)
const normalized = await client.normalizeAddress('gedimno pr 28 vilnus');
// Check workday
const workday = await client.checkWorkday('2024-12-25');
// Add workdays
const result = await client.addWorkdays('2024-01-15', 5);Zobacz na npmWyszukiwanie firm#
/companies/searchWyszukaj firmy według nazwy lub kodu.
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| q | string | Tekst wyszukiwania (nazwa lub kod) |
| limit | number | Liczba wyników (maks: 100, domyślnie: 20) |
| offset | number | Pomiń wyniki (domyślnie: 0) |
Przykład
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/companies/search?q=Maxima&limit=5"
Odpowiedź
{
"results": [
{
"code": "111111111",
"name": "UAB Maxima",
"address": "Vilnius, Lietuva",
"status": "Registered",
"registrationDate": "2020-01-15"
}
],
"total": 1,
"limit": 5,
"offset": 0
}Pobierz firmę według kodu#
/companies/:codePobierz szczegółowe informacje o firmie według kodu podmiotu prawnego.
Przykład
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/companies/111111111
Odpowiedź
{
"code": "111111111",
"name": "UAB Maxima",
"address": "Vilnius, Lietuva",
"status": "Registered",
"registrationDate": "2020-01-15",
"email": "info@maxima.lt",
"phone": "+370 5 123 4567",
"website": "https://maxima.lt"
}Wyszukiwanie adresów#
/addresses/searchWyszukiwanie ulic, miejscowości i gmin. Obsługuje wyszukiwanie wielowyrazowe (np. "kaunas basanavi" lub "vilnius centro").
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| q | string | Tekst wyszukiwania (nazwa ulicy, miejscowości lub gminy) |
| limit | number | Liczba wyników (maks: 100, domyślnie: 20) |
| offset | number | Pomiń wyniki (domyślnie: 0) |
Przykład
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/addresses/search?q=kaunas+basanavi&limit=5"
Odpowiedź
Wyniki są grupowane według typu: ulice, miejscowości, gminy. Każda grupa zawiera odpowiednie dane o lokalizacji.
{
"streets": [
{
"code": 1231645,
"name": "J. Basanavičiaus",
"typeAbbr": "al.",
"settlementId": "58437361-d62a-4714-9b74-f07ae0b9d66b",
"buildings": [
{ "number": "3", "postalCode": "LT-50282" },
{ "number": "4", "postalCode": "LT-50290" }
],
"settlement": {
"name": "Kaunas",
"typeAbbr": "m."
}
}
],
"settlements": [],
"municipalities": [],
"total": 1,
"limit": 5,
"offset": 0
}Normalizacja adresu#
/addresses/normalizeKonwertuj dowolny ciąg adresu (z możliwymi literówkami) na ustrukturyzowane komponenty adresu. Używa dopasowania rozmytego do obsługi błędów pisowni.
Treść żądania
| Parametr | Typ | Opis |
|---|---|---|
| address | string | Ciąg adresu do normalizacji (np. "gedimno pr 28 vilnus") |
| limit | number | Maksymalna liczba wyników (domyślnie: 5, maks: 20) |
Przykład
curl -X POST -H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"address": "gedimno pr 28 vilnus", "limit": 3}' \
https://api.jars.lt/api/v1/addresses/normalizeOdpowiedź
Zwraca pasujące adresy z wynikami pewności. Wyższy wynik oznacza lepsze dopasowanie.
{
"results": [
{
"confidence": 0.87,
"formatted": "Gedimino pr. 28, Vilnius, Vilniaus m. sav., LT-01104",
"components": {
"street": { "code": 105641, "name": "Gedimino", "type": "prospektas", "typeAbbr": "pr." },
"building": { "number": "28", "postalCode": "LT-01104" },
"settlement": { "code": 101580, "name": "Vilnius", "type": "miestas", "typeAbbr": "m." },
"municipality": { "code": 58, "name": "Vilniaus m.", "typeAbbr": "sav." },
"county": { "code": 9, "name": "Vilniaus" },
"postalCode": "LT-01104"
}
}
],
"query": "gedimno pr 28 vilnus",
"parsed": {
"tokens": ["gedimno", "vilnus"],
"building": "28",
"streetType": "pr."
}
}Pobierz lokalizację według kodu pocztowego#
/addresses/postal/:codePobierz powiat, gminę, miejscowość i ulice według kodu pocztowego. Obsługuje 5-cyfrowy format (np. "54306" lub "LT-54306").
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| code | string | Kod pocztowy (5 cyfr, z lub bez prefiksu "LT-") |
Przykład
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/addresses/postal/54306
Odpowiedź
Zwraca wszystkie ulice z tym kodem pocztowym, wraz z informacjami o miejscowości, gminie i powiecie.
{
"postalCode": "LT-54306",
"streets": [
{
"code": 1873961,
"name": "Viesulo",
"type": "gatvė",
"typeAbbr": "g."
}
],
"settlement": {
"code": 88888,
"name": "Kaunas",
"type": "miestas",
"typeAbbr": "m."
},
"municipality": {
"code": 15,
"name": "Kauno m."
},
"county": {
"code": 4,
"name": "Kauno"
}
}Sprawdź dzień roboczy#
/workdays/checkSprawdź, czy konkretna data jest dniem roboczym na Litwie. Zwraca informacje o weekendach i litewskich świętach państwowych.
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| date | string | Data w formacie YYYY-MM-DD |
Przykład
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/workdays/check?date=2024-12-25"
Odpowiedź
{
"date": "2024-12-25",
"dayOfWeek": "Wednesday",
"isWorkday": false,
"isWeekend": false,
"isHoliday": true,
"holidayName": "Kalėdos",
"holidayNameEn": "Christmas Day"
}Dodaj dni robocze#
/workdays/addDodaj liczbę dni roboczych do podanej daty, pomijając weekendy i litewskie święta państwowe. Obsługuje wartości ujemne do odejmowania dni roboczych.
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| date | string | Data początkowa w formacie YYYY-MM-DD |
| days | number | Liczba dni roboczych do dodania (może być ujemna) |
Przykład
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/workdays/add?date=2024-12-20&days=5"
Odpowiedź
{
"startDate": "2024-12-20",
"workdaysAdded": 5,
"resultDate": "2024-12-30",
"resultIsWorkday": true,
"skippedDays": [
{ "date": "2024-12-21", "reason": "weekend" },
{ "date": "2024-12-22", "reason": "weekend" },
{ "date": "2024-12-25", "reason": "holiday", "holidayName": "Kalėdos" },
{ "date": "2024-12-26", "reason": "holiday", "holidayName": "Antra Kalėdų diena" },
{ "date": "2024-12-28", "reason": "weekend" },
{ "date": "2024-12-29", "reason": "weekend" }
]
}Pobierz statystyki#
/usagePobierz statystyki swojego klucza API i pozostały limit.
Przykład
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/usage
Odpowiedź
rateLimit wskazuje maksymalną liczbę zapytań na sekundę.
{
"dataDelay": 0,
"limit": 50000,
"plan": "PROFESSIONAL",
"rateLimit": 300,
"remaining": 49997,
"requestCount": 3,
"resetDate": "2025-11-10T14:20:13.260Z",
"webhooksEnabled": true
}Limity zapytań#
Limity zapytań API zależą od Twojego planu:
- Darmowy: 100 zapytań miesięcznie
- Początkujący: 5 000 zapytań miesięcznie
- Profesjonalny: 50 000 zapytań miesięcznie
- Korporacyjny: 1 000 000 zapytań miesięcznie
Po przekroczeniu limitu otrzymasz odpowiedź 429 Too Many Requests .
Kody błędów#
| Kod | Opis |
|---|---|
| 400 | Nieprawidłowe parametry |
| 401 | Nieprawidłowy klucz API |
| 404 | Firma nie znaleziona |
| 429 | Przekroczono limit zapytań |
| 500 | Błąd serwera |
Potrzebujesz pomocy?#
Jeśli masz pytania lub potrzebujesz pomocy z integracją API, skontaktuj się z nami:
Kontakt →