Autentifikacija#

Visi API užklausos reikalauja API rakto. Pridėkite jį kaip x-api-key header:

curl -H "x-api-key: your_api_key_here" \
  https://api.jars.lt/api/v1/companies/search?q=UAB

Bazinis URL#

Visi API endpoint'ai prasideda:

https://api.jars.lt/api/v1

Node.js SDK#

Oficialus TypeScript/JavaScript SDK patogiai integracijai su JARS.LT API.

Diegimas

npm install @jars-lt/sdk

Naudojimas

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);

Įmonių paieška#

Ieškoti įmonių pagal pavadinimą arba kodą.

Parametrai

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  "https://api.jars.lt/api/v1/companies/search?q=Maxima&limit=5"

Atsakymas

{
  "results": [
    {
      "code": "111111111",
      "name": "UAB Maxima",
      "address": "Vilnius, Lietuva",
      "status": "Registered",
      "registrationDate": "2020-01-15"
    }
  ],
  "total": 1,
  "limit": 5,
  "offset": 0
}

Gauti įmonę pagal kodą#

Gauti detalią informaciją apie įmonę pagal juridinio asmens kodą.

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  https://api.jars.lt/api/v1/companies/111111111

Atsakymas

{
  "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"
}

Adresų paieška#

Ieškoti gatvių, gyvenviečių ir savivaldybių. Palaiko kelių žodžių paiešką (pvz., "kaunas basanavi" arba "vilnius centro").

Parametrai

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  "https://api.jars.lt/api/v1/addresses/search?q=kaunas+basanavi&limit=5"

Atsakymas

Rezultatai grupuojami pagal tipą: gatvės, gyvenvietės, savivaldybės. Kiekviena grupė turi atitinkamus vietos duomenis.

{
  "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
}

Normalizuoti adresą#

Konvertuoti laisvos formos adreso eilutę (su galimomis klaidomis) į struktūrizuotus adreso komponentus. Naudoja fuzzy atitikimą rašybos klaidoms tvarkyti.

Užklausos turinys

Pavyzdys

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/normalize

Atsakymas

Grąžina atitinkančius adresus su pasitikėjimo balais. Didesnis balas rodo geresnį atitikimą.

{
  "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."
  }
}

Gauti vietovę pagal pašto kodą#

Gauti apskritį, savivaldybę, gyvenvet ę ir gatves pagal pašto indeksą. Palaiko 5 skaitmenų formatą (pvz., "54306" arba "LT-54306").

Parametrai

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  https://api.jars.lt/api/v1/addresses/postal/54306

Atsakymas

Grąžina visos gatvės su šiuo pašto kodu, kartu su gyvenvietės, savivaldybės ir apskrities informacija.

{
  "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"
  }
}

Patikrinti darbo dieną#

Patikrinti, ar konkreti data yra darbo diena Lietuvoje. Grąžina informaciją apie savaitgalius ir Lietuvos valstybines šventes.

Parametrai

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  "https://api.jars.lt/api/v1/workdays/check?date=2024-12-25"

Atsakymas

{
  "date": "2024-12-25",
  "dayOfWeek": "Wednesday",
  "isWorkday": false,
  "isWeekend": false,
  "isHoliday": true,
  "holidayName": "Kalėdos",
  "holidayNameEn": "Christmas Day"
}

Pridėti darbo dienas#

Pridėti darbo dienų skaičių prie nurodytos datos, praleidžiant savaitgalius ir Lietuvos valstybines šventes. Palaiko neigiamas reikšmes atimti darbo dienas.

Parametrai

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  "https://api.jars.lt/api/v1/workdays/add?date=2024-12-20&days=5"

Atsakymas

{
  "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" }
  ]
}

Gauti statistiką#

Gauti savo API rakto statistiką ir likutį.

Pavyzdys

curl -H "x-api-key: your_api_key_here" \
  https://api.jars.lt/api/v1/usage

Atsakymas

rateLimit nurodo maksimalų užklausų per sekundę skaičių.

{
  "dataDelay": 0,
  "limit": 50000,
  "plan": "PROFESSIONAL",
  "rateLimit": 300,
  "remaining": 49997,
  "requestCount": 3,
  "resetDate": "2025-11-10T14:20:13.260Z",
  "webhooksEnabled": true
}

Rate Limits#

API užklausų limitai priklauso nuo jūsų plano:

• Nemokamas: 100 užklausų per mėnesį
• Pradedantysis: 5,000 užklausų per mėnesį
• Profesionalus: 50,000 užklausų per mėnesį
• Enterprise: 1,000,000 užklausų per mėnesį

Viršijus limitą, gausite 429 Too Many Requests atsakymą.

Klaidų kodai#