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

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

<a id="post-v1.0-firms-search-summaries-emails"></a>

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

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/search/summaries-emails' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "string"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/firm-search.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "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` — Ключ
- `[].value` — Значение
- `[].value[].address` — Адрес фирмы
- `[].value[].affiliated_firms` — Список связанных фирм *Доступно только платным пользователям
- `[].value[].affiliated_firms[].firm_name` — Название фирмы
- `[].value[].affiliated_firms[].inn` — ИНН
- `[].value[].affiliated_firms[].tf_firm_color` — Цвет фирмы в светофоре
- `[].value[].affiliated_firms[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].value[].ati_id` — Код в ATI.SU.
- `[].value[].bad_partner_mentions_count` — Количество упоминаний на форуме недобросовестных партнеров
- `[].value[].city` — Город, в котором расположена фирма
- `[].value[].claims_count` — Количество претензий от фирм
- `[].value[].contact_info_changed` — Дата последних изменений в истории фирмы. *Доступно только платным пользователям
- `[].value[].contact_names` — Имена контактов
- `[].value[].firm_documents` — Документы фирмы
- `[].value[].firm_documents[].creation_date` — Дата создания документа.
- `[].value[].firm_documents[].description` — Автогенерируемое описание документа.
- `[].value[].firm_documents[].link` — Ссылка на документ.
- `[].value[].firm_type` — Профиль деятельности фирмы
- `[].value[].firm_type_id` — Идентификатор профиля деятельности фирмы
- `[].value[].full_name` — Полное имя фирмы: Брэнд (Название фирмы, ОПФ)
- `[].value[].info_reference` — Ссылка на карточку фирмы
- `[].value[].inn` — Инн
- `[].value[].kpp` — Код причины постановки на учёт фирмы
- `[].value[].last_month_active_days` — Число дней со входами на сайт за последние 30 дней. *Доступно только платным пользователям
- `[].value[].location` — Структура "Город"
- `[].value[].location.city_id` — Идентификатор города
- `[].value[].location.city_name` — Название города
- `[].value[].location.city_size` — Размер города по числу жителей.
- `[].value[].location.country_code_name` — Буквенный код страны (например, RUS)
- `[].value[].location.country_id` — Идентификатор страны
- `[].value[].location.country_name` — Название страны
- `[].value[].location.fias_id` — Идентификатор населенного пункта
- `[].value[].location.full_name` — Составное название состоящее из названий города, региона и страны разделенные через запятую.
- `[].value[].location.is_regional_center` — Флаг - является ли город региональным центром
- `[].value[].location.region_id` — Идентификатор региона
- `[].value[].location.region_name` — Название региона
- `[].value[].location.short_name` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России).
- `[].value[].negative_points_sum` — Сумма отрицательных баллов
- `[].value[].ogrn` — ОГРН
- `[].value[].okpo` — Общероссийский классификатор предприятий и организаций
- `[].value[].passport_reference` — Ссылка на паспорт фирмы
- `[].value[].position_in_city` — Место в рейтинге по городу
- `[].value[].position_in_country` — Место в рейтинге по стране
- `[].value[].query_first_change_date` — Даты первого добавления искомого параметра поиска (email, phone, inn)
- `[].value[].recommendations_count` — Количество рекомендаций от фирм
- `[].value[].registration_date` — Дата регистрации на сайте, которая AddDate из firms.
- `[].value[].score` — Количество звёзд фирмы. Если число отрицательно, то это красные звёзды
- `[].value[].tf_account_color` — Цвет аккаунта в светофоре *Доступно только платным пользователям
- `[].value[].tf_firm_color` — Цвет фирмы в светофоре *Доступно только платным пользователям
- `[].value[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].value[].verified_trucks` — Количество зарегистрированных ТС
- `[].value[].web_site` — Сайт фирмы

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


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

<a id="post-v1.0-firms-search-summaries"></a>

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

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/search/summaries' \
  -X 'POST' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json' \
  --data-raw '[
  "string"
]'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/firm-search.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "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` — Ключ
- `[].value` — Значение
- `[].value[].address` — Адрес фирмы
- `[].value[].affiliated_firms` — Список связанных фирм *Доступно только платным пользователям
- `[].value[].affiliated_firms[].firm_name` — Название фирмы
- `[].value[].affiliated_firms[].inn` — ИНН
- `[].value[].affiliated_firms[].tf_firm_color` — Цвет фирмы в светофоре
- `[].value[].affiliated_firms[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].value[].ati_id` — Код в ATI.SU.
- `[].value[].bad_partner_mentions_count` — Количество упоминаний на форуме недобросовестных партнеров
- `[].value[].city` — Город, в котором расположена фирма
- `[].value[].claims_count` — Количество претензий от фирм
- `[].value[].contact_info_changed` — Дата последних изменений в истории фирмы. *Доступно только платным пользователям
- `[].value[].firm_documents` — Документы фирмы
- `[].value[].firm_documents[].creation_date` — Дата создания документа.
- `[].value[].firm_documents[].description` — Автогенерируемое описание документа.
- `[].value[].firm_documents[].link` — Ссылка на документ.
- `[].value[].firm_type` — Профиль деятельности фирмы
- `[].value[].firm_type_id` — Идентификатор профиля деятельности фирмы
- `[].value[].full_name` — Полное имя фирмы: Брэнд (Название фирмы, ОПФ)
- `[].value[].info_reference` — Ссылка на карточку фирмы
- `[].value[].inn` — Инн
- `[].value[].kpp` — Код причины постановки на учёт фирмы
- `[].value[].last_month_active_days` — Число дней со входами на сайт за последние 30 дней. *Доступно только платным пользователям
- `[].value[].location` — Структура "Город"
- `[].value[].location.city_id` — Идентификатор города
- `[].value[].location.city_name` — Название города
- `[].value[].location.city_size` — Размер города по числу жителей.
- `[].value[].location.country_code_name` — Буквенный код страны (например, RUS)
- `[].value[].location.country_id` — Идентификатор страны
- `[].value[].location.country_name` — Название страны
- `[].value[].location.fias_id` — Идентификатор населенного пункта
- `[].value[].location.full_name` — Составное название состоящее из названий города, региона и страны разделенные через запятую.
- `[].value[].location.is_regional_center` — Флаг - является ли город региональным центром
- `[].value[].location.region_id` — Идентификатор региона
- `[].value[].location.region_name` — Название региона
- `[].value[].location.short_name` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России).
- `[].value[].negative_points_sum` — Сумма отрицательных баллов
- `[].value[].ogrn` — ОГРН
- `[].value[].okpo` — Общероссийский классификатор предприятий и организаций
- `[].value[].passport_reference` — Ссылка на паспорт фирмы
- `[].value[].position_in_city` — Место в рейтинге по городу
- `[].value[].position_in_country` — Место в рейтинге по стране
- `[].value[].recommendations_count` — Количество рекомендаций от фирм
- `[].value[].registration_date` — Дата регистрации на сайте, которая AddDate из firms.
- `[].value[].score` — Количество звёзд фирмы. Если число отрицательно, то это красные звёзды
- `[].value[].tf_account_color` — Цвет аккаунта в светофоре *Доступно только платным пользователям
- `[].value[].tf_firm_color` — Цвет фирмы в светофоре *Доступно только платным пользователям
- `[].value[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].value[].verified_trucks` — Количество зарегистрированных ТС
- `[].value[].web_site` — Сайт фирмы

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```


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

<a id="get-v1.0-firms-search-summary"></a>

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

**Пример запроса (curl):**

```bash
curl 'https://api.ati.su/v1.0/firms/search/summary?phone=string&inn=string' \
  -X 'GET' \
  -H 'Authorization: Bearer {authorizationToken}' \
  -H 'Content-Type: application/json'
```

**OpenAPI схема:** [JSON](https://ati.su/developers/raw/api/catalogs/firm-search.openapi.json)

**Пример ответа (200)**

```json
[
  {
    "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` — Адрес фирмы
- `[].affiliated_firms` — Список связанных фирм *Доступно только платным пользователям
- `[].affiliated_firms[].firm_name` — Название фирмы
- `[].affiliated_firms[].inn` — ИНН
- `[].affiliated_firms[].tf_firm_color` — Цвет фирмы в светофоре
- `[].affiliated_firms[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].ati_id` — Код в ATI.SU.
- `[].bad_partner_mentions_count` — Количество упоминаний на форуме недобросовестных партнеров
- `[].city` — Город, в котором расположена фирма
- `[].claims_count` — Количество претензий от фирм
- `[].contact_info_changed` — Дата последних изменений в истории фирмы. *Доступно только платным пользователям
- `[].contact_names` — Имена контактов
- `[].firm_documents` — Документы фирмы
- `[].firm_documents[].creation_date` — Дата создания документа.
- `[].firm_documents[].description` — Автогенерируемое описание документа.
- `[].firm_documents[].link` — Ссылка на документ.
- `[].firm_type` — Профиль деятельности фирмы
- `[].firm_type_id` — Идентификатор профиля деятельности фирмы
- `[].full_name` — Полное имя фирмы: Брэнд (Название фирмы, ОПФ)
- `[].info_reference` — Ссылка на карточку фирмы
- `[].inn` — Инн
- `[].kpp` — Код причины постановки на учёт фирмы
- `[].last_month_active_days` — Число дней со входами на сайт за последние 30 дней. *Доступно только платным пользователям
- `[].location` — Структура "Город"
- `[].location.city_id` — Идентификатор города
- `[].location.city_name` — Название города
- `[].location.city_size` — Размер города по числу жителей.
- `[].location.country_code_name` — Буквенный код страны (например, RUS)
- `[].location.country_id` — Идентификатор страны
- `[].location.country_name` — Название страны
- `[].location.fias_id` — Идентификатор населенного пункта
- `[].location.full_name` — Составное название состоящее из названий города, региона и страны разделенные через запятую.
- `[].location.is_regional_center` — Флаг - является ли город региональным центром
- `[].location.region_id` — Идентификатор региона
- `[].location.region_name` — Название региона
- `[].location.short_name` — Составное название состоящее из названия города, названия региона (если город не является областным центром) и буквенного кода страны (если страна отличается от России).
- `[].negative_points_sum` — Сумма отрицательных баллов
- `[].ogrn` — ОГРН
- `[].okpo` — Общероссийский классификатор предприятий и организаций
- `[].passport_reference` — Ссылка на паспорт фирмы
- `[].position_in_city` — Место в рейтинге по городу
- `[].position_in_country` — Место в рейтинге по стране
- `[].query_first_change_date` — Даты первого добавления искомого параметра поиска (email, phone, inn)
- `[].recommendations_count` — Количество рекомендаций от фирм
- `[].registration_date` — Дата регистрации на сайте, которая AddDate из firms.
- `[].score` — Количество звёзд фирмы. Если число отрицательно, то это красные звёзды
- `[].tf_account_color` — Цвет аккаунта в светофоре *Доступно только платным пользователям
- `[].tf_firm_color` — Цвет фирмы в светофоре *Доступно только платным пользователям
- `[].tf_has_signals` — Флаг о существовании любой информации о фирме в светофоре
- `[].verified_trucks` — Количество зарегистрированных ТС
- `[].web_site` — Сайт фирмы

**Пример ответа (400)**

```json
{
  "error": "string",
  "reason": "string"
}
```