Документация API
Начните использовать JARS.LT API за несколько минут
Документация API
Начните использовать JARS.LT API за несколько минут
Аутентификация#
Все API запросы требуют API ключ. Добавьте его как x-api-key заголовок:
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/companies/search?q=UAB
Базовый URL#
Все API endpoints начинаются с:
https://api.jars.lt/api/v1
Node.js SDK#
Официальный TypeScript/JavaScript SDK для удобной интеграции с JARS.LT API.
Установка
npm install @jars-lt/sdkИспользование
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);Смотреть на npmПоиск компаний#
/companies/searchПоиск компаний по названию или коду.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| q | string | Текст поиска (название или код) |
| limit | number | Количество результатов (макс: 100, по умолчанию: 20) |
| offset | number | Пропустить результаты (по умолчанию: 0) |
Пример
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/companies/search?q=Maxima&limit=5"
Ответ
{
"results": [
{
"code": "111111111",
"name": "UAB Maxima",
"address": "Vilnius, Lietuva",
"status": "Registered",
"registrationDate": "2020-01-15"
}
],
"total": 1,
"limit": 5,
"offset": 0
}Получить компанию по коду#
/companies/:codeПолучить подробную информацию о компании по коду юридического лица.
Пример
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/companies/111111111
Ответ
{
"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"
}Поиск адресов#
/addresses/searchПоиск улиц, населённых пунктов и муниципалитетов. Поддерживает поиск по нескольким словам (напр., "kaunas basanavi" или "vilnius centro").
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| q | string | Текст поиска (название улицы, населённого пункта или муниципалитета) |
| limit | number | Количество результатов (макс: 100, по умолчанию: 20) |
| offset | number | Пропустить результаты (по умолчанию: 0) |
Пример
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/addresses/search?q=kaunas+basanavi&limit=5"
Ответ
Результаты сгруппированы по типу: улицы, населённые пункты, муниципалитеты. Каждая группа включает соответствующие данные о местоположении.
{
"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
}Нормализация адреса#
/addresses/normalizeПреобразование произвольной строки адреса (с возможными опечатками) в структурированные компоненты. Использует нечёткий поиск для обработки ошибок написания.
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
| address | string | Строка адреса для нормализации (напр., "gedimno pr 28 vilnus") |
| limit | number | Максимум результатов (по умолчанию: 5, макс: 20) |
Пример
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Ответ
Возвращает подходящие адреса с оценкой уверенности. Более высокая оценка означает лучшее совпадение.
{
"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."
}
}Получить местоположение по почтовому индексу#
/addresses/postal/:codeПолучить округ, муниципалитет, населённый пункт и улицы по почтовому индексу. Поддерживает 5-значный формат (напр., "54306" или "LT-54306").
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| code | string | Почтовый индекс (5 цифр, с или без префикса "LT-") |
Пример
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/addresses/postal/54306
Ответ
Возвращает все улицы с этим почтовым индексом, вместе с информацией о населённом пункте, муниципалитете и округе.
{
"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"
}
}Проверка рабочего дня#
/workdays/checkПроверить, является ли конкретная дата рабочим днём в Литве. Возвращает информацию о выходных и государственных праздниках Литвы.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| date | string | Дата в формате YYYY-MM-DD |
Пример
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/workdays/check?date=2024-12-25"
Ответ
{
"date": "2024-12-25",
"dayOfWeek": "Wednesday",
"isWorkday": false,
"isWeekend": false,
"isHoliday": true,
"holidayName": "Kalėdos",
"holidayNameEn": "Christmas Day"
}Добавить рабочие дни#
/workdays/addДобавить количество рабочих дней к указанной дате, пропуская выходные и государственные праздники Литвы. Поддерживает отрицательные значения для вычитания.
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| date | string | Начальная дата в формате YYYY-MM-DD |
| days | number | Количество рабочих дней (может быть отрицательным) |
Пример
curl -H "x-api-key: your_api_key_here" \ "https://api.jars.lt/api/v1/workdays/add?date=2024-12-20&days=5"
Ответ
{
"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" }
]
}Получить статистику#
/usageПолучить статистику вашего API ключа и остаток квоты.
Пример
curl -H "x-api-key: your_api_key_here" \ https://api.jars.lt/api/v1/usage
Ответ
rateLimit указывает максимальное количество запросов в секунду.
{
"dataDelay": 0,
"limit": 50000,
"plan": "PROFESSIONAL",
"rateLimit": 300,
"remaining": 49997,
"requestCount": 3,
"resetDate": "2025-11-10T14:20:13.260Z",
"webhooksEnabled": true
}Лимиты запросов#
Лимиты API запросов зависят от вашего плана:
- Бесплатный: 100 запросов в месяц
- Стартовый: 5 000 запросов в месяц
- Профессиональный: 50 000 запросов в месяц
- Enterprise: 1 000 000 запросов в месяц
При превышении лимита вы получите ответ 429 Too Many Requests .
Коды ошибок#
| Код | Описание |
|---|---|
| 400 | Неверные параметры |
| 401 | Неверный API ключ |
| 404 | Компания не найдена |
| 429 | Превышен лимит запросов |
| 500 | Ошибка сервера |
Нужна помощь?#
Если у вас есть вопросы или нужна помощь с интеграцией API, свяжитесь с нами:
Связаться →