Перейти к содержимому
2base
Интеграция

Документация API

REST API для доступа к базе из 11 772 841 компаний и ИП. Все запросы возвращают JSON.

OpenAPI 3.0.3 GitHub

Доступ

Публичные read-only endpoints доступны без API-ключа. Телефоны и email в ответах маскируются; выгрузка открытых контактов оформляется отдельно.

curl https://2base.ru/api/v1/companies

GET /api/v1/companies

Список компаний с фильтрацией и пагинацией.

Параметры запроса

ПараметрТипОписание
pageintСтраница 1–200 (по умолч. 1)
per_pageintЗаписей на странице (по умолч. 50, макс. 100)
region_idintФильтр по ID региона
city_idintФильтр по ID города
okvedstringФильтр по коду ОКВЭД
has_phoneboolТолько с телефоном
has_emailboolТолько с email
qstringПоиск по названию/ИНН

Схематический пример ответа

Значения ниже иллюстративны; формат маски соответствует публичному ответу.

{
  "data": [
    {
      "id": 123,
      "inn": "7700000000",
      "name": "ООО «ПРИМЕР»",
      "slug": "ooo-primer",
      "status": "Действующая",
      "region_name": "Москва",
      "phone": "+7 (495) ***-**-50",
      "email": "in***@example.ru"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 1,
    "total_pages": 1
  }
}

GET /api/v1/companies/:slug

Данные компании по slug. Контакты маскируются, сайт и социальные ссылки не возвращаются.

{
  "data": {
    "id": 123,
    "inn": "7700000000",
    "name": "ООО «ПРИМЕР»",
    "slug": "ooo-primer",
    "status": "Действующая",
    "phone": "+7 (495) ***-**-50",
    "email": "in***@example.ru"
  }
}

GET /api/v1/search?q=...

Полнотекстовый поиск по названию, ИНН, ОГРН, адресу.

q — строка поиска (обязательный), per_page — результатов на странице (по умолч. 20, макс. 100)

GET /api/v1/regions

Список регионов с количеством компаний.

GET /api/v1/stats

Общая статистика платформы (количество компаний, регионов и т.д.).

GET /api/health

Проверка работоспособности приложения; endpoint находится вне группы /api/v1.

Лимиты

  • • 30 запросов / минуту на IP для группы /api/v1
  • • До 100 записей на страницу, страницы 1–200
  • • Контактные данные (телефон, email) в публичных ответах маскируются

HTTP коды ответов

200 — Успешный запрос
400 — Некорректные параметры
404 — Не найдено
429 — Превышен лимит запросов
500 — Внутренняя ошибка