Поиск организации

Поиск организации в базе Справочника. Поиск можно делать как по названию, так по 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 Поисковый запрос (в любом формате). Example: ``
geoId	Type: number Географический идентификатор страны. 225 для России.

Responses

200 OK

Список найденных компаний.

Body

application/json

{
  "pager": {
    "total": 0.5,
    "limit": 0.5,
    "offset": 0.5
  },
  "companies": {
    "id": 0.5,
    "name": "example",
    "rubrics": 0.5,
    "address": 0.5,
    "url": [
      "example"
    ],
    "isChain": 0.5,
    "isOnline": 0.5,
    "country": {
      "name": "example",
      "geoId": 0.5,
      "isAdvertisingDisabled": true
    }
  },
  "companieschain": {
    "id": 0.5,
    "name": "example",
    "rubrics": 0.5,
    "address": 0.5,
    "url": null,
    "isChain": 0.5,
    "isOnline": 0.5,
    "chainId": 0.5,
    "chainCountries": null
  }
}

Name	Description
companies	Type: Company Результат поиска для организации с одной физической точкой. Example `{ "id": 0.5, "name": "example", "rubrics": 0.5, "address": 0.5, "url": [ "example" ], "isChain": 0.5, "isOnline": 0.5, "country": { "name": "example", "geoId": 0.5, "isAdvertisingDisabled": true } }`
companieschain	Type: CompanyChain Результат поиска для организации входящая в сеть (несколько физических точек). Example `{ "id": 0.5, "name": "example", "rubrics": 0.5, "address": 0.5, "url": [ "example" ], "isChain": 0.5, "isOnline": 0.5, "chainId": 0.5, "chainCountries": { "name": "example", "geoId": 0.5, "isAdvertisingDisabled": true } }`
pager	Type: CompanySearchPager Пагинация ответа. Example `{ "total": 0.5, "limit": 0.5, "offset": 0.5 }`

CompanySearchPager

Пагинация ответа.

Name	Description
limit	Type: number Ограничение на количество элементов в ответе.
offset	Type: number Оффсет ответа.
total	Type: number Количество элементов в ответе.

Example

{
  "total": 0.5,
  "limit": 0.5,
  "offset": 0.5
}

Url

Все адреса (url) указанные как контактные

Type: string[]

Example

[
  "example"
]

Country

Name	Description
geoId	Type: number Географический идентификатор страны. Нужен для получения цены, запуска рекламной кампании
isAdvertisingDisabled	Type: boolean Если true то создание рекламы в данной стране невозможно
name	Type: string Страна, в которой работает организация Example: `example`

Example

{
  "name": "example",
  "geoId": 0.5,
  "isAdvertisingDisabled": true
}

Company

Результат поиска для организации с одной физической точкой.

Name	Description
address	Type: number Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1.
country	Type: Country Example `{ "name": "example", "geoId": 0.5, "isAdvertisingDisabled": true }`
id	Type: number ID организации, он же companyId.
isChain	Type: number Является ли организация сетью (сетевые организации или франшизы).
isOnline	Type: number Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)
name	Type: string Название организации Example: `example`
rubrics	Type: number Вид деятельности выбранные у организации
url	Type: Url Все адреса (url) указанные как контактные Example `[ "example" ]`

Example

{
  "id": 0.5,
  "name": "example",
  "rubrics": 0.5,
  "address": 0.5,
  "url": [
    "example"
  ],
  "isChain": 0.5,
  "isOnline": 0.5,
  "country": {
    "name": "example",
    "geoId": 0.5,
    "isAdvertisingDisabled": true
  }
}

CompanyChain

Результат поиска для организации входящая в сеть (несколько физических точек).

Name	Description
address	Type: number Адрес организации, например Россия, Москва, улица Сретенка, 24/2с1.
chainCountries	Type: Country Example `{ "name": "example", "geoId": 0.5, "isAdvertisingDisabled": true }`
chainId	Type: number ID организации, у которых несколько физических точек (сетевые или франшизы)
id	Type: number ID организации, он же companyId.
isChain	Type: number Является ли организация сетью (сетевые организации или франшизы).
isOnline	Type: number Является ли компания онлайн-организацией (организация без физической точки, но добавленная в Яндекс.Справочник)
name	Type: string Название организации. Example: `example`
rubrics	Type: number Вид деятельности выбранные у организации.
url	Type: Url Все адреса (url) указанные как контактные Example `[ "example" ]`

Example

{
  "id": 0.5,
  "name": "example",
  "rubrics": 0.5,
  "address": 0.5,
  "url": [
    "example"
  ],
  "isChain": 0.5,
  "isOnline": 0.5,
  "chainId": 0.5,
  "chainCountries": {
    "name": "example",
    "geoId": 0.5,
    "isAdvertisingDisabled": true
  }
}

Была ли статья полезна?

Бюджетный запуск

Проверка прав на организацию