Поиск организации
Поиск организации в базе Справочника. Поиск можно делать как по названию, так по email, адресу, телефону или другим связанным параметрам. Также можно их объединять, например: Кафе Солнышко Челябинск ул. Ленин.
Request
GET
https://geoadv-api.yandex.ru/priority/v1/company-search
Query parameters
|
Name |
Description |
|
limit* |
Type: number Ограничение на количество ответов. |
|
offset* |
Type: number Оффсет возвращаемых ответов. |
|
text* |
Type: string Поисковый запрос (в любом формате). |
|
geoId |
Type: number Географический идентификатор страны. 225 для России. |
Responses
200 OK
Список найденных компаний.
Body
application/json
{
"pager": {
"total": 0,
"limit": 0,
"offset": 0
},
"companies": {
"id": 0,
"name": "string",
"rubrics": 0,
"address": 0,
"url": [
"string"
],
"isChain": 0,
"isOnline": 0,
"country": {
"name": "string",
"geoId": 0,
"isAdvertisingDisabled": false
}
},
"companieschain": {
"id": 0,
"name": "string",
"rubrics": 0,
"address": 0,
"url": [
"string"
],
"isChain": 0,
"isOnline": 0,
"chainId": 0,
"chainCountries": {
"name": "string",
"geoId": 0,
"isAdvertisingDisabled": false
}
}
}
|
Name |
Description |
|
companies |
Type: Company Результат поиска для организации с одной физической точкой. |
|
companieschain |
Type: CompanyChain Результат поиска для организации входящая в сеть (несколько физических точек). |
|
pager |
Type: CompanySearchPager Пагинация ответа. |
Company
Результат поиска для организации с одной физической точкой.
|
Name |
Description |
|
address |
Type: number Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1. |
|
country |
Type: Country |
|
id |
Type: number ID организации, он же companyId. |
|
isChain |
Type: number Является ли организация сетью (сетевые организации или франшизы). |
|
isOnline |
Type: number Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник) |
|
name |
Type: string Название организации |
|
rubrics |
Type: number Вид деятельности выбранные у организации |
|
url |
Type: string[] Все адреса (url) указанные как контактные |
CompanyChain
Результат поиска для организации входящая в сеть (несколько физических точек).
|
Name |
Description |
|
address |
Type: number Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1. |
|
chainCountries |
Type: Country |
|
chainId |
Type: number ID организации, у которых несколько физических точек (сетевые или франшизы) |
|
id |
Type: number ID организации, он же companyId. |
|
isChain |
Type: number Является ли организация сетью (сетевые организации или франшизы). |
|
isOnline |
Type: number Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник) |
|
name |
Type: string Название организации. |
|
rubrics |
Type: number Вид деятельности выбранные у организации. |
|
url |
Type: string[] Все адреса (url) указанные как контактные |
CompanySearchPager
Пагинация ответа.
|
Name |
Description |
|
limit |
Type: number Ограничение на количество элементов в ответе. |
|
offset |
Type: number Оффсет ответа. |
|
total |
Type: number Количество элементов в ответе. |
Country
|
Name |
Description |
|
geoId |
Type: number Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании |
|
isAdvertisingDisabled |
Type: boolean Если true то создание рекламы в данной стране невозможно |
|
name |
Type: string Страна, в которой работает организация |
No longer supported, please use an alternative and newer version.