Поиск краткой информации о фирмах

Обращаем ваше внимание, что лимит на обращения к данным методам составляет 1000 запросов в день. При его превышении придет ошибка 400 - “error”:“invalid_input_data”,“reason”:“Превышен лимит запросов.”

Групповое получение краткой информации о фирмаx по email

post

/v1.0/firms/search/summaries-emails

withFirstChangeInfo

boolean

Флаг для вывода даты первого добавления искомого emails

Развернуть все Свернуть все

body

array

Адреса электронной почты

[string]

Адреса электронной почты

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"key":"string",

"value":[...]

{...}

"address":"string",

"affiliated_firms":[...],

{...}

"firm_name":"string",

"inn":"string",

"tf_firm_color":"string",

"tf_has_signals":false

}

"ati_id":"string",

"bad_partner_mentions_count":0,

"city":"string",

"claims_count":0,

"contact_info_changed":"1970-01-01T00:00:00.000Z",

"contact_names":[...],

"string"

"firm_documents":[...],

{...}

"creation_date":"1970-01-01T00:00:00.000Z",

"description":"string",

"link":"string"

}

"firm_type":"string",

"firm_type_id":"string",

"full_name":"string",

"info_reference":"string",

"inn":"string",

"kpp":"string",

"last_month_active_days":0,

"location":{...},

"attributes":0,

"city_id":0,

"city_name":"string",

"city_size":0,

"country_code_name":"string",

"country_id":0,

"country_name":"string",

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"full_name":"string",

"is_regional_center":false,

"region_id":0,

"region_name":"string",

"short_name":"string"

"negative_points_sum":0.5,

"ogrn":"string",

"okpo":"string",

"passport_reference":"string",

"position_in_city":0,

"position_in_country":0,

"query_first_change_date":"1970-01-01T00:00:00.000Z",

"recommendations_count":0,

"registration_date":"1970-01-01T00:00:00.000Z",

"score":0.5,

"tf_account_color":"string",

"tf_firm_color":"string",

"tf_has_signals":false,

"verified_trucks":0,

"web_site":"string"

}

]

}

]

[{...}]

key: string

Ключ

value:[{...}]

Значение

address: string

Адрес фирмы

affiliated_firms:[{...}]

Список связанных фирм

firm_name: string

Название фирмы

inn: string

ИНН

tf_firm_color: string

Цвет фирмы в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

}]

ati_id: string

Код в ATI.SU.

bad_partner_mentions_count: int32

Количество упоминаний на форуме недобросовестных партнеров

city: string

Город, в котором расположена фирма

claims_count: int32

Количество претензий от фирм

contact_info_changed: date-time

Дата последних изменений в истории фирмы.

contact_names: [string]

Имена контактов

firm_documents:[{...}]

Документы фирмы

creation_date: date-time

Дата создания документа.

description: string

Автогенерируемое описание документа.

link: string

Ссылка на документ.

}]

firm_type: string

Профиль деятельности фирмы

firm_type_id: string

Идентификатор профиля деятельности фирмы

full_name: string

Полное имя фирмы: Брэнд (Название фирмы, ОПФ)

info_reference: string

Ссылка на карточку фирмы

inn: string

Инн

kpp: string

Код причины постановки на учет фирмы

last_month_active_days: int32

Число дней со входами на сайт за последние 30 дней.

location:{...}

Структура "Город"

attributes: enum

[0, 4]

city_id: int32

Идентификатор города

city_name: string

Название города

city_size: int32

Размер города по числу жителей.

country_code_name: string

Буквенный код страны (например, RUS)

country_id: int32

Идентификатор страны

country_name: string

Название страны

fias_id: uuid

Идентификатор населенного пункта

full_name: string

Составное название состоящее из названий города, региона и страны разделенные через запятую.

is_regional_center: boolean

Флаг - является ли город региональным центром

region_id: int32

Идентификатор региона

region_name: string

Название региона

short_name: string

Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России).

}

negative_points_sum: double

Сумма отрицательных баллов

ogrn: string

ОГРН

okpo: string

Общероссийский классификатор предприятий и организаций

passport_reference: string

Ссылка на паспорт фирмы

position_in_city: int32

Место в рэйтинге по городу

position_in_country: int32

Место в рэйтинге по стране

query_first_change_date: date-time

Даты первого добавления искомого параметра поиска (email, phone, inn)

recommendations_count: int32

Количество рекомендаций от фирм

registration_date: date-time

Дата регистрации на сайте, которая AddDate из firms.

score: double

Количество звезд фирмы. Если число отрицательно, то это красные звезды

tf_account_color: string

Цвет аккаунта в светофоре

tf_firm_color: string

Цвет фирмы в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

verified_trucks: int32

Количество зарегистрированных ТС

web_site: string

Сайт фирмы

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

В методе можно передать за раз 10 адресов. При передаче большего количества - придет ошибка 400 - “error”:“invalid_input_data”,“reason”:“Размер входного массива не должен превышать 10”.

Групповое получение краткой информации о фирмаx по ИНН

post

/v1.0/firms/search/summaries

Развернуть все Свернуть все

body

array

Список ИНН

[string]

Список ИНН

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"key":"string",

"value":[...]

{...}

"address":"string",

"affiliated_firms":[...],

{...}

"firm_name":"string",

"inn":"string",

"tf_firm_color":"string",

"tf_has_signals":false

}

"ati_id":"string",

"bad_partner_mentions_count":0,

"city":"string",

"claims_count":0,

"contact_info_changed":"1970-01-01T00:00:00.000Z",

"firm_documents":[...],

{...}

"creation_date":"1970-01-01T00:00:00.000Z",

"description":"string",

"link":"string"

}

"firm_type":"string",

"firm_type_id":"string",

"full_name":"string",

"info_reference":"string",

"inn":"string",

"kpp":"string",

"last_month_active_days":0,

"location":{...},

"attributes":0,

"city_id":0,

"city_name":"string",

"city_size":0,

"country_code_name":"string",

"country_id":0,

"country_name":"string",

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"full_name":"string",

"is_regional_center":false,

"region_id":0,

"region_name":"string",

"short_name":"string"

"negative_points_sum":0.5,

"ogrn":"string",

"okpo":"string",

"passport_reference":"string",

"position_in_city":0,

"position_in_country":0,

"recommendations_count":0,

"registration_date":"1970-01-01T00:00:00.000Z",

"score":0.5,

"tf_account_color":"string",

"tf_firm_color":"string",

"tf_has_signals":false,

"verified_trucks":0,

"web_site":"string"

}

]

}

]

[{...}]

key: string

Ключ

value:[{...}]

Значение

address: string

Адрес фирмы

affiliated_firms:[{...}]

Список связанных фирм

firm_name: string

Название фирмы

inn: string

ИНН

tf_firm_color: string

Цвет фирмы в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

}]

ati_id: string

Код в ATI.SU.

bad_partner_mentions_count: int32

Количество упоминаний на форуме недобросовестных партнеров

city: string

Город, в котором расположена фирма

claims_count: int32

Количество претензий от фирм

contact_info_changed: date-time

Дата последних изменений в истории фирмы.

firm_documents:[{...}]

Документы фирмы

creation_date: date-time

Дата создания документа.

description: string

Автогенерируемое описание документа.

link: string

Ссылка на документ.

}]

firm_type: string

Профиль деятельности фирмы

firm_type_id: string

Идентификатор профиля деятельности фирмы

full_name: string

Полное имя фирмы: Брэнд (Название фирмы, ОПФ)

info_reference: string

Ссылка на карточку фирмы

inn: string

Инн

kpp: string

Код причины постановки на учет фирмы

last_month_active_days: int32

Число дней со входами на сайт за последние 30 дней.

location:{...}

Структура "Город"

attributes: enum

[0, 4]

city_id: int32

Идентификатор города

city_name: string

Название города

city_size: int32

Размер города по числу жителей.

country_code_name: string

Буквенный код страны (например, RUS)

country_id: int32

Идентификатор страны

country_name: string

Название страны

fias_id: uuid

Идентификатор населенного пункта

full_name: string

Составное название состоящее из названий города, региона и страны разделенные через запятую.

is_regional_center: boolean

Флаг - является ли город региональным центром

region_id: int32

Идентификатор региона

region_name: string

Название региона

short_name: string

}

negative_points_sum: double

Сумма отрицательных баллов

ogrn: string

ОГРН

okpo: string

Общероссийский классификатор предприятий и организаций

passport_reference: string

Ссылка на паспорт фирмы

position_in_city: int32

Место в рэйтинге по городу

position_in_country: int32

Место в рэйтинге по стране

recommendations_count: int32

Количество рекомендаций от фирм

registration_date: date-time

Дата регистрации на сайте, которая AddDate из firms.

score: double

Количество звезд фирмы. Если число отрицательно, то это красные звезды

tf_account_color: string

Цвет аккаунта в светофоре

tf_firm_color: string

Цвет фирмы в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

verified_trucks: int32

Количество зарегистрированных ТС

web_site: string

Сайт фирмы

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...

В методе можно передать за раз 10 ИНН. При передаче большего количества - придет ошибка 400 - “error”:“invalid_input_data”,“reason”:“Размер входного массива не должен превышать 10”

Получение краткой информации о фирме по номеру телефона или ИНН

get

/v1.0/firms/search/summary

phone

string

Номер телефона

inn

string

ИНН

withFirstChangeInfo

boolean

Флаг для вывода даты первого добавления искомого номера телефона

CURL

Копировать

Пример ответа

Ответ

200 Success

Развернуть все Свернуть все

Пример

Модель

[...]

{...}

"address":"string",

"affiliated_firms":[...],

{...}

"firm_name":"string",

"inn":"string",

"tf_firm_color":"string",

"tf_has_signals":false

}

"ati_id":"string",

"bad_partner_mentions_count":0,

"city":"string",

"claims_count":0,

"contact_info_changed":"1970-01-01T00:00:00.000Z",

"contact_names":[...],

"string"

"firm_documents":[...],

{...}

"creation_date":"1970-01-01T00:00:00.000Z",

"description":"string",

"link":"string"

}

"firm_type":"string",

"firm_type_id":"string",

"full_name":"string",

"info_reference":"string",

"inn":"string",

"kpp":"string",

"last_month_active_days":0,

"location":{...},

"attributes":0,

"city_id":0,

"city_name":"string",

"city_size":0,

"country_code_name":"string",

"country_id":0,

"country_name":"string",

"fias_id":"3fa85f64-5717-4562-b3fc-2c963f66afa6",

"full_name":"string",

"is_regional_center":false,

"region_id":0,

"region_name":"string",

"short_name":"string"

"negative_points_sum":0.5,

"ogrn":"string",

"okpo":"string",

"passport_reference":"string",

"position_in_city":0,

"position_in_country":0,

"query_first_change_date":"1970-01-01T00:00:00.000Z",

"recommendations_count":0,

"registration_date":"1970-01-01T00:00:00.000Z",

"score":0.5,

"tf_account_color":"string",

"tf_firm_color":"string",

"tf_has_signals":false,

"verified_trucks":0,

"web_site":"string"

}

]

[{...}]

address: string

Адрес фирмы

affiliated_firms:[{...}]

Список связанных фирм

firm_name: string

Название фирмы

inn: string

ИНН

tf_firm_color: string

Цвет фирмы в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

}]

ati_id: string

Код в ATI.SU.

bad_partner_mentions_count: int32

Количество упоминаний на форуме недобросовестных партнеров

city: string

Город, в котором расположена фирма

claims_count: int32

Количество претензий от фирм

contact_info_changed: date-time

Дата последних изменений в истории фирмы.

contact_names: [string]

Имена контактов

firm_documents:[{...}]

Документы фирмы

creation_date: date-time

Дата создания документа.

description: string

Автогенерируемое описание документа.

link: string

Ссылка на документ.

}]

firm_type: string

Профиль деятельности фирмы

firm_type_id: string

Идентификатор профиля деятельности фирмы

full_name: string

Полное имя фирмы: Брэнд (Название фирмы, ОПФ)

info_reference: string

Ссылка на карточку фирмы

inn: string

Инн

kpp: string

Код причины постановки на учет фирмы

last_month_active_days: int32

Число дней со входами на сайт за последние 30 дней.

location:{...}

Структура "Город"

attributes: enum

[0, 4]

city_id: int32

Идентификатор города

city_name: string

Название города

city_size: int32

Размер города по числу жителей.

country_code_name: string

Буквенный код страны (например, RUS)

country_id: int32

Идентификатор страны

country_name: string

Название страны

fias_id: uuid

Идентификатор населенного пункта

full_name: string

Составное название состоящее из названий города, региона и страны разделенные через запятую.

is_regional_center: boolean

Флаг - является ли город региональным центром

region_id: int32

Идентификатор региона

region_name: string

Название региона

short_name: string

}

negative_points_sum: double

Сумма отрицательных баллов

ogrn: string

ОГРН

okpo: string

Общероссийский классификатор предприятий и организаций

passport_reference: string

Ссылка на паспорт фирмы

position_in_city: int32

Место в рэйтинге по городу

position_in_country: int32

Место в рэйтинге по стране

query_first_change_date: date-time

Даты первого добавления искомого параметра поиска (email, phone, inn)

recommendations_count: int32

Количество рекомендаций от фирм

registration_date: date-time

Дата регистрации на сайте, которая AddDate из firms.

score: double

Количество звезд фирмы. Если число отрицательно, то это красные звезды

tf_account_color: string

Цвет аккаунта в светофоре

tf_firm_color: string

Цвет фирмы в светофоре

tf_has_signals: boolean

Флаг о существовании любой информации о фирме в светофоре

verified_trucks: int32

Количество зарегистрированных ТС

web_site: string

Сайт фирмы

}]

400 Bad Request

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

401 Unauthorized

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

402 Client Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

403 Forbidden

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

404 Not Found

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

500 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

504 Server Error

Развернуть все Свернуть все

Пример

Модель

{...}

"error":"string",

"reason":"string"

}

{...}

error: string

reason: string

}

Загрузка...

Развернуть все Свернуть все

Загрузка...