API — Поиск
Поиск компаний и индивидуальных предпринимателей по наименованию, учредителям, руководителям, кодам ОКВЭД-2, датам регистрации или обновления.
Формат запроса
Используются POST- или GET-запросы следующего вида
https://api.ofdata.ru/v2/search?key=API-ключ&параметры запроса
| Параметр запроса | Описание |
|---|---|
by |
Обязательный параметр
Определяет тип поиска, принимает следующие значения:
by=name для поиска по наименованию компании или ФИО предпринимателя,by=founder-name для поиска по ФИО учредителя или наименованию компании-учредителя,by=leader-name для поиска по ФИО руководителя,by=okved для поиска по коду ОКВЭД-2 основного вида деятельности,by=reg-date для поиска по дате регистрации,by=upd-date для поиска по дате обновления выписки ЕГРЮЛ или ЕГРИП. |
obj |
Обязательный параметр
Определяет область поиска, принимает следующие значения:
obj=org для поиска по компаниям,obj=ent для поиска по индивидуальным предпринимателям. |
query |
Обязательный параметр
Текст поискового запроса. Минимальное количество символов для поиска по наименованию или ФИО: 4. Для поиска по дате регистрации или обновления, используйте формат даты YYYY-MM-DD .
|
region |
Код региона компании или ИП, состоящий из 2 цифр. |
okved |
Код основного вида деятельности компании или ИП согласно ОКВЭД-2. Параметр не применяется при поиске типа by=okved .
|
opf |
Код организационно-правовой формы компании, состоящий из 2 или 5 цифр согласно классификатору ОКОПФ. Параметр не применяется при поиске типа by=name и при поиске по предпринимателям obj=ent .
|
active |
При указании параметра active=true в результатах поиска будут только активные компании или ИП.
|
limit |
Ограничение количества результатов поиска на одну страницу. Значение по умолчанию: 100, максимальное значение: 100. |
page |
Номер страницы. Если количество результатов поиска превышает значение limit , результаты будут разбиты на несколько страниц и вы сможете использовать данный параметр для просмотра нужной страницы.
|
Примеры запросов
https://api.ofdata.ru/v2/search?key=API-ключ&by=name&obj=org&query=пао ростелеком
https://api.ofdata.ru/v2/search?key=API-ключ&by=name&obj=ent&query=морозов андрей®ion=40
https://api.ofdata.ru/v2/search?key=API-ключ&by=founder-name&obj=org&query=нуралиев борис
https://api.ofdata.ru/v2/search?key=API-ключ&by=leader-name&obj=org&query=греф герман оскарович®ion=77
https://api.ofdata.ru/v2/search?key=API-ключ&by=okved&obj=org&query=63.11&opf=12300&active=true
https://api.ofdata.ru/v2/search?key=API-ключ&by=reg-date&obj=org&query=2021-12-09&okved=63.11
https://api.ofdata.ru/v2/search?key=API-ключ&by=upd-date&obj=org&query=2022-01-27
Примечания
- API-ключ вы можете найти в личном кабинете после регистрации.
- Вы можете использовать как защищенное https://SSL-соединение, так и незащищенноеhttp://соединение. Например, если при интеграции с 1С вы получаете "Ошибка инициализации SSL-соединения", воспользуйтесь незащищенным соединением через 80-й порт.
- Максимальное количество результатов поиска по наименованию составляет 100 записей, для остальных типов поиска количество результатов не ограничено.
- Результаты поиска сортируются по ОГРН или ОГРНИП, кроме поиска по наименованию/учредителям/руководителям, в этом случае результаты будут отсортированы по релевантности.
- При поиске по учредителям/руководителям результаты будут дополнены списками учредителей и руководителей найденных компаний.
- Справочники ОКВЭД 2, ОКФС и ОКОПФ вы можете скачать здесь.
Формат ответа
Для поиска по компаниям
{
}
data: {
Результаты поиска
СтрВсего: <INTEGER>,
Количество страниц с результатами поиска
СтрТекущ: <INTEGER>,
Номер текущей страницы
Записи: [ {
Компании
ОГРН: <STRING>,
ОГРН
ИНН: <STRING>,
ИНН
КПП: <STRING>,
КПП
НаимСокр: <STRING>,
Сокращенное наименование
НаимПолн: <STRING>,
Полное наименование
ДатаРег: <STRING>,
Дата регистрации
Статус: <STRING>,
Статус
ДатаЛикв: <STRING>,
Дата ликвидации
РегионКод: <STRING>,
Код региона РФ
ЮрАдрес: <STRING>,
Юридический адрес
ОКВЭД: <STRING>
Основной вид деятельности согласно ОКВЭД
}, ... ],
},
meta: {
Информация о результате запроса
status: <STRING>,
Статус ответа, принимает значения "ok" или "error"
today_request_count: <INTEGER>,
Количество успешно обработанных запросов с вашим API-ключом за сегодняшний день
balance: <FLOAT>,
Остаток вашего баланса, руб.
message: <STRING>
Сообщение, поясняющее результат запроса, отсутствует в случае успешной обработки запроса и получении ответа, содержащего требуемые данные
}
Для поиска по индивидуальным предпринимателям
{
}
data: {
Результаты поиска
СтрВсего: <INTEGER>,
Количество страниц с результатами поиска
СтрТекущ: <INTEGER>,
Номер текущей страницы
Записи: [ {
Индивидуальные предприниматели
ОГРНИП: <STRING>,
ОГРНИП
ИНН: <STRING>,
ИНН
ФИО: <STRING>,
Ф. И. О.
Тип: <STRING>,
Наименование типа ИП
ДатаРег: <STRING>,
Дата регистрации
Статус: <STRING>,
Статус
ДатаПрекращ: <STRING>,
Дата прекращения деятельности
РегионКод: <STRING>,
Код региона РФ
ОКВЭД: <STRING>
Основной вид деятельности согласно ОКВЭД
}, ... ],
},
meta: {
Информация о результате запроса
status: <STRING>,
Статус ответа, принимает значения "ok" или "error"
today_request_count: <INTEGER>,
Количество успешно обработанных запросов с вашим API-ключом за сегодняшний день
balance: <FLOAT>,
Остаток вашего баланса, руб.
message: <STRING>
Сообщение, поясняющее результат запроса, отсутствует в случае успешной обработки запроса и получении ответа, содержащего требуемые данные
}