Справочники
Справочники помогают заполнять фильтры в UI и интеграциях без хардкода списков. Поиск компаний по-прежнему идёт через /companies — эндпоинты /dictionaries/* только отдают допустимые значения.
Авторизация не требуется.
Эндпоинты
| Метод | Путь | Источник | Назначение |
|---|---|---|---|
GET | /dictionaries/sectors | dictionaries.sectors | Канонический список отраслей |
GET | /dictionaries/regions | FIAS/GAR | Субъекты РФ (~90), сгруппированы по типу |
GET | /dictionaries/regions/{region_code} | FIAS/GAR | Один субъект по коду (64, 77, …) |
GET | /dictionaries/localities | FIAS/GAR | Города и НП по региону и/или поиску |
Базовый URL: https://app.strokka.com/api/v1
Подробные схемы — в API Reference.
Общее поле filterValue
В каждом элементе справочника есть filterValue — рекомендуемая строка для фильтра:
| Поле фильтра | Эндпоинт | Пример filterValue |
|---|---|---|
sector | /dictionaries/sectors | Информационные технологии |
region, location | /dictionaries/regions | Саратовская область |
city, location | /dictionaries/localities | г. Балаково |
filterValue совпадает с каноническим форматом в карточках компаний: для регионов — displayName, для городов — label из GAR. Для фильтра удобен оператор eq; contains тоже работает, если значение совпадает со справочником.
Отрасли (/dictionaries/sectors)
Канонические названия секторов из таблицы dictionaries.sectors в strokka_db. Список совпадает с тем, что используется при классификации компаний.
Поля ответа
| Поле | Описание |
|---|---|
id | Идентификатор в справочнике |
name | Полное название отрасли |
filterValue | То же, что name — для filter[sector][contains] |
Пример
Code
Code
Фильтр по сектору
Code
Раньше для IT часто искали подстроку информ. Со справочником надёжнее брать filterValue целиком из /dictionaries/sectors.
Гео: регионы и населённые пункты
Данные из FIAS/GAR (addresses.gar_objects).
Регион
| Поле | Описание |
|---|---|
id | object_id в GAR |
regionCode | Код субъекта (64, 77, …) |
name | Короткое имя (Саратовская, Москва) |
typeName | Тип (обл., респ., г., край, …) |
label | Техническая подпись GAR (обл. Саратовская) — для справки |
displayName | Каноническое имя для UI и карточек (Саратовская область) |
filterValue | То же, что displayName — для filter[region] / filter[location] |
Населённый пункт
| Поле | Описание |
|---|---|
id, regionCode, name, typeName | Идентификаторы и короткое имя |
label | Каноническая подпись GAR (г. Балаково, с. Ивановка) |
displayName | То же, что label |
level | GAR: 5 — город, 6 — населённый пункт |
filterValue | То же, что label — для filter[city] / filter[location] |
В базе компаний регион и город приводятся к единому формату из справочника (Саратовская область, г. Саратов), а не к сокращениям GAR вроде обл. Саратовская. Берите в фильтр именно filterValue из API.
Список регионов
Code
Фрагмент ответа:
Code
Плоский список — в items; для выпадающих списков удобнее groups.
Один регион по коду
Code
Города региона (без поиска)
Без q возвращаются только города (GAR level 5), не все ~160k НП:
Code
Автокомплит города в регионе
Code
С параметром q по умолчанию ищутся уровни 5 и 6.
Глобальный поиск НП
Code
Обязателен region_code или q (минимум 2 символа в q).
Параметры /dictionaries/localities
| Параметр | Описание |
|---|---|
region_code | Код субъекта из regionCode |
q | Поиск по названию (мин. 2 символа) |
levels | Уровни GAR (5, 5,6). Без q — 5; с q — 5,6 |
limit | 1–200, по умолчанию 50 |
offset | Смещение для пагинации |
Связка со фильтрами компаний
Типичный сценарий для UI:
- Загрузите справочники:
GET /dictionaries/sectors,GET /dictionaries/regions - Пользователь выбирает отрасль →
filterValueвfilter[sector][contains] - Выбирает регион →
filterValueвfilter[region][contains] - Для города:
GET /dictionaries/localities?region_code=64&q=… - Примените фильтры к
GETилиPOST /companies
Сектор + регион + город
Code
POST с JSON
Code
Операторы и логика AND/OR — в разделе Фильтры.
Ошибки
| Код | Когда |
|---|---|
404 | Неизвестный region_code в /dictionaries/regions/{code} |
422 | Нет region_code и q в /localities; q короче 2 символов; неверный levels |
См. также
- Фильтры — операторы для
sector,region,city,location - Фильтрация выборки — пошаговые сценарии
- API Reference — OpenAPI для
/dictionaries/*
Связаться