https://github.com/movemoveapp/laravel-dadata
PHP SDK Laravel пакет работы с сервисом DaData.ru, для исправления синтаксических ошибок в информации контактных данных клиентов сайта и вывода подсказок поля форм.
https://github.com/movemoveapp/laravel-dadata
dadata laravel laravel-package movemove movemoveapp php sdk-php
Last synced: 11 months ago
JSON representation
PHP SDK Laravel пакет работы с сервисом DaData.ru, для исправления синтаксических ошибок в информации контактных данных клиентов сайта и вывода подсказок поля форм.
- Host: GitHub
- URL: https://github.com/movemoveapp/laravel-dadata
- Owner: movemoveapp
- License: mit
- Created: 2020-09-30T18:47:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-24T15:33:01.000Z (over 2 years ago)
- Last Synced: 2025-07-09T17:12:49.210Z (11 months ago)
- Topics: dadata, laravel, laravel-package, movemove, movemoveapp, php, sdk-php
- Language: PHP
- Homepage:
- Size: 146 KB
- Stars: 45
- Watchers: 3
- Forks: 31
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
DaData Laravel SDK Package
[](https://app.travis-ci.com/movemoveapp/laravel-dadata)
[](//packagist.org/packages/movemoveapp/laravel-dadata)
[](//packagist.org/packages/movemoveapp/laravel-dadata)
[](//packagist.org/packages/movemoveapp/laravel-dadata)
*DaData Laravel Package* - PHP SDK [Laravel](https://github.com/laravel/laravel) пакет для взаимодействия с API [DaData.ru](https://dadata.ru/) от [MoveMoveApp](https://movemoveapp.com/)
## Требования
- Версии PHP: 7.3, 7.4, 8.0, 8.1
- Версии Laravel: 7.x, 8.x, 9.x
- Версии Guzzle": 7.0, 7.2
## Установка
Вы можете установить пакет через composer:
```shell script
composer require movemoveapp/laravel-dadata
```
Если вы используете версию Laravel ниже **5.5**, то зарегистрируйте `DaDataServiceProvider` вручную, добавив в `config/app.php`в массиве `providers`:
```shell script
'providers' => [
// ...
MoveMoveIo\DaData\DaDataServiceProvider::class,
],
```
Публикация конфигурационного файла. Выполните `artisan` команду
```shell script
php artisan vendor:publish --provider="MoveMoveIo\DaData\DaDataServiceProvider"
```
Настройка проекта осществляется через `.env` вашего проекта. Вам необходимо указать три параметра
- `DADATA_TOKEN` - token для раоты с API DaData
- `DADATA_SECRET` - secret для работы с API DaData
- `DADATA_TIMEOUT` - максимальное время ожидания ответа от API сервисов DaData в секундах. По умолчанию это значение равно 10 секунд.
Пример `.env`
```php
DADATA_TOKEN="c32c33ebaf450067d64516fbe041d2a8a6d4211f"
DADATA_SECRET="adccd63ac28701442e26b7eef57eb5eb0a72143e"
DADATA_TIMEOUT=10
```
## Методы
- **Работа с адресами**
- [Стандартизация адреса](https://github.com/movemoveapp/laravel-dadata#%D1%81%D1%82%D0%B0%D0%BD%D0%B4%D0%B0%D1%80%D1%82%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0)
- [Подсказки по адресам](https://github.com/movemoveapp/laravel-dadata#%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BA%D0%B8-%D0%BF%D0%BE-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0%D0%BC)
- [Определение адреса по координатам](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0-%D0%BF%D0%BE-%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B0%D1%82%D0%B0%D0%BC)
- [Определение адреса по IP](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0-%D0%BF%D0%BE-ip)
- [Определение адреса по КЛАДР или ФИАС коду](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D0%B0-%D0%BF%D0%BE-%D0%BA%D0%BB%D0%B0%D0%B4%D1%80-%D0%B8%D0%BB%D0%B8-%D1%84%D0%B8%D0%B0%D1%81-%D0%BA%D0%BE%D0%B4%D1%83)
- [Определение ближайшего отделения Почты России по адресу](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B1%D0%BB%D0%B8%D0%B6%D0%B0%D0%B9%D1%88%D0%B5%D0%B3%D0%BE-%D0%BE%D1%82%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D1%87%D1%82%D1%8B-%D1%80%D0%BE%D1%81%D1%81%D0%B8%D0%B8-%D0%BF%D0%BE-%D0%B0%D0%B4%D1%80%D0%B5%D1%81%D1%83)
- [Определение отделения Почты России почтовому индексу](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BE%D1%82%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D1%87%D1%82%D1%8B-%D1%80%D0%BE%D1%81%D1%81%D0%B8%D0%B8-%D0%BF%D0%BE-%D0%BF%D0%BE%D1%87%D1%82%D0%BE%D0%B2%D0%BE%D0%BC%D1%83-%D0%B8%D0%BD%D0%B4%D0%B5%D0%BA%D1%81%D1%83)
- [Определение отделения Почты России по координатам](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BE%D1%82%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D1%8F-%D0%BF%D0%BE%D1%87%D1%82%D1%8B-%D1%80%D0%BE%D1%81%D1%81%D0%B8%D0%B8-%D0%BF%D0%BE-%D0%BA%D0%BE%D0%BE%D1%80%D0%B4%D0%B8%D0%BD%D0%B0%D1%82%D0%B0%D0%BC)
- [Определение идентификатора города в СДЭК, Boxberry и DPD](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D0%BF%D1%80%D0%B5%D0%B4%D0%B5%D0%BB%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D0%B0-%D0%B3%D0%BE%D1%80%D0%BE%D0%B4%D0%B0-%D0%B2-%D1%81%D0%B4%D1%8D%D0%BA-boxberry-%D0%B8-dpd)
- [Адрес в ФИАС по идентификатору](https://github.com/movemoveapp/laravel-dadata#%D0%B0%D0%B4%D1%80%D0%B5%D1%81-%D0%B2-%D1%84%D0%B8%D0%B0%D1%81-%D0%BF%D0%BE-%D0%B8%D0%B4%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%82%D0%BE%D1%80%D1%83)
- **Работа с именами**
- [ФИО](https://github.com/movemoveapp/laravel-dadata#%D1%84%D0%B8%D0%BE)
- [Автодополнение при вводе («подсказки»)](https://github.com/movemoveapp/laravel-dadata#%D0%B0%D0%B2%D1%82%D0%BE%D0%B4%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BF%D1%80%D0%B8-%D0%B2%D0%B2%D0%BE%D0%B4%D0%B5-%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BA%D0%B8)
- **Работа с электорнными (email) адресами**
- [Email](https://github.com/movemoveapp/laravel-dadata#email)
- [Подсказки по email](https://github.com/movemoveapp/laravel-dadata#%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BE%D0%BA%D0%B8-%D0%BF%D0%BE-email)
- **Работа с телефонными номерами**
- [Проверить телефон](https://github.com/movemoveapp/laravel-dadata#%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%B8%D1%82%D1%8C-%D1%82%D0%B5%D0%BB%D0%B5%D1%84%D0%BE%D0%BD)
- **Работа с компаниями**
- [Организация по ИНН](https://github.com/movemoveapp/laravel-dadata#%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-%D0%BF%D0%BE-%D0%B8%D0%BD%D0%BD)
- [Автодополнение при вводе («подсказки»)](https://github.com/movemoveapp/laravel-dadata#%D0%B0%D0%B2%D1%82%D0%BE%D0%B4%D0%BE%D0%BF%D0%BE%D0%BB%D0%BD%D0%B5%D0%BD%D0%B8%D0%B5-%D0%BF%D1%80%D0%B8-%D0%B2%D0%B2%D0%BE%D0%B4%D0%B5-%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BA%D0%B8-1)
- [Поиск аффилированных компаний](https://github.com/movemoveapp/laravel-dadata#%D0%BF%D0%BE%D0%B8%D1%81%D0%BA-%D0%B0%D1%84%D1%84%D0%B8%D0%BB%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%BD%D1%8B%D1%85-%D0%BA%D0%BE%D0%BC%D0%BF%D0%B0%D0%BD%D0%B8%D0%B9)
- **Работа с банками**
- [Банк по БИК, SWIFT, ИНН или регистрационному номеру](https://github.com/movemoveapp/laravel-dadata#%D0%B1%D0%B0%D0%BD%D0%BA-%D0%BF%D0%BE-%D0%B1%D0%B8%D0%BA-swift-%D0%B8%D0%BD%D0%BD-%D0%B8%D0%BB%D0%B8-%D1%80%D0%B5%D0%B3%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D0%BE%D0%BC%D1%83-%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D1%83)
- [API подсказок по банкам](https://github.com/movemoveapp/laravel-dadata#api-%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BE%D0%BA-%D0%BF%D0%BE-%D0%B1%D0%B0%D0%BD%D0%BA%D0%B0%D0%BC)
- **Работа с паспортами**
- [Проверка по реестру МВД](https://github.com/movemoveapp/laravel-dadata#%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0-%D0%BF%D0%BE-%D1%80%D0%B5%D0%B5%D1%81%D1%82%D1%80%D1%83-%D0%BC%D0%B2%D0%B4)
- [Кем выдан паспорт](https://github.com/movemoveapp/laravel-dadata#%D0%BA%D0%B5%D0%BC-%D0%B2%D1%8B%D0%B4%D0%B0%D0%BD-%D0%BF%D0%B0%D1%81%D0%BF%D0%BE%D1%80%D1%82)
## Работа с адресами
### Стандартизация адреса
`DaDataAddress::standardization(string $address)` - разбивает адрес из строки по отдельным полям (регион, город, улица, дом, квартира) согласно КЛАДР/ФИАС. Определяет почтовый индекс, часовой пояс, ближайшее метро, координаты, стоимость квартиры и другую информацию об адресе.
Основные кейсы:
- Разбивает адрес по отдельным полям (регион, город, улица, дом, квартира).
- Рассчитывает корректный индекс по данным Почты России.
- Определяет координаты.
- Показывает округ и район города, ближайшее метро, площадь и стоимость квартиры.
- Достает коды КЛАДР, ФИАС, ОКАТО, ОКТМО и ИФНС.
Пример вызова
```php
array:80 [
"source" => "мск сухонска 11/-89"
"result" => "г Москва, ул Сухонская, д 11, кв 89"
"postal_code" => "127642"
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => "Центральный"
"region_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"region_kladr_id" => "7700000000000"
"region_iso_code" => "RU-MOW"
"region_with_type" => "г Москва"
"region_type" => "г"
"region_type_full" => "город"
"region" => "Москва"
"area_fias_id" => null
"area_kladr_id" => null
"area_with_type" => null
"area_type" => null
"area_type_full" => null
"area" => null
"city_fias_id" => null
"city_kladr_id" => null
"city_with_type" => null
"city_type" => null
"city_type_full" => null
"city" => null
"city_area" => "Северо-восточный"
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => "р-н Северное Медведково"
"city_district_type" => "р-н"
"city_district_type_full" => "район"
"city_district" => "Северное Медведково"
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => "95dbf7fb-0dd4-4a04-8100-4f6c847564b5"
"street_kladr_id" => "77000000000283600"
"street_with_type" => "ул Сухонская"
"street_type" => "ул"
"street_type_full" => "улица"
"street" => "Сухонская"
"house_fias_id" => "5ee84ac0-eb9a-4b42-b814-2f5f7c27c255"
"house_kladr_id" => "7700000000028360004"
"house_type" => "д"
"house_type_full" => "дом"
"house" => "11"
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => "кв"
"flat_type_full" => "квартира"
"flat" => "89"
"flat_area" => "34.6"
"square_meter_price" => "198113"
"flat_price" => "6854710"
"postal_box" => null
"fias_id" => "5ee84ac0-eb9a-4b42-b814-2f5f7c27c255"
"fias_code" => "77000000000000028360004"
"fias_level" => "8"
"fias_actuality_state" => "0"
"kladr_id" => "7700000000028360004"
"capital_marker" => "0"
"okato" => "45280583000"
"oktmo" => "45362000"
"tax_office" => "7715"
"tax_office_legal" => "7715"
"timezone" => "UTC+3"
"geo_lat" => "55.8782557"
"geo_lon" => "37.65372"
"beltway_hit" => "IN_MKAD"
"beltway_distance" => null
"qc_geo" => 0
"qc_complete" => 0
"qc_house" => 2
"qc" => 0
"unparsed_parts" => null
"metro" => array:3 [
0 => array:3 [
"distance" => 1.1
"line" => "Калужско-Рижская"
"name" => "Бабушкинская"
]
1 => array:3 [
"distance" => 1.2
"line" => "Калужско-Рижская"
"name" => "Медведково"
]
2 => array:3 [
"distance" => 2.5
"line" => "Калужско-Рижская"
"name" => "Свиблово"
]
]
]
]
```
Описани ответа
| **Название** | **Длина** | **Описание** |
|:--------------------------|-------------:|:---------------------------------------------------------------|
| `source` | 250 | Исходный адрес одной строкой |
| `result` | 500 | Стандартизованный адрес одной строкой |
| `postal_code` | 6 | Индекс |
| `country` | 120 | Страна |
| `country_iso_code` | 2 | ISO-код страны |
| `federal_district` | 20 | Федеральный округ |
| `region_fias_id` | 36 | ФИАС-код региона |
| `region_kladr_id` | 19 | КЛАДР-код региона |
| `region_iso_code` | 6 | ISO-код региона |
| `region_with_type` | 131 | Регион с типом |
| `region_type` | 10 | Тип региона (сокращенный) |
| `region_type_full` | 50 | Тип региона |
| `region` | 120 | Регион |
| `area_fias_id` | 36 | ФИАС-код района |
| `area_kladr_id` | 19 | КЛАДР-код района |
| `area_with_type` | 131 | Район в регионе с типом |
| `area_type` | 10 | Тип района в регионе (сокращенный) |
| `area_type_full` | 50 | Тип района в регионе |
| `area` | 120 | Район в регионе |
| `city_fias_id` | 36 | ФИАС-код города |
| `city_kladr_id` | 19 | КЛАДР-код города |
| `city_with_type` | 131 | Город с типом |
| `city_type` | 10 | Тип города (сокращенный) |
| `city_type_full` | 50 | Тип города |
| `city` | 120 | Город |
| `city_area` | 120 | Административный округ (только для Москвы) |
| `city_district_fias_id` | 36 | ФИАС-код района города (заполняется, только если район есть в ФИАС) |
| `city_district_kladr_id` | 19 | КЛАДР-код района города (не заполняется) |
| `city_district_with_type` | 131 | Район города с типом |
| `city_district_type` | 10 | Тип района города (сокращенный) |
| `city_district_type_full` | 50 | Тип района города |
| `city_district` | 120 | Район города |
| `settlement_fias_id` | 36 | ФИАС-код населенного пункта |
| `settlement_kladr_id` | 19 | КЛАДР-код населенного пункта |
| `settlement_with_type` | 131 | Населенный пункт с типом |
| `settlement_type` | 10 | Тип населенного пункта (сокращенный) |
| `settlement_type_full` | 50 | Тип населенного пункта |
| `settlement` | 120 | Населенный пункт |
| `street_fias_id` | 36 | ФИАС-код улицы |
| `street_kladr_id` | 19 | КЛАДР-код улицы |
| `street_with_type` | 131 | Улица с типом |
| `street_type` | 10 | Тип улицы (сокращенный) |
| `street_type_full` | 50 | Тип улицы |
| `street` | 120 | Улица |
| `house_fias_id` | 36 | ФИАС-код дома |
| `house_kladr_id` | 19 | КЛАДР-код дома |
| `house_type` | 10 | Тип дома (сокращенный) |
| `house_type_full` | 50 | Тип дома |
| `house` | 50 | Дом |
| `block_type` | 10 | Тип корпуса/строения (сокращенный) |
| `block_type_full` | 50 | Тип корпуса/строения |
| `block` | 50 | Корпус/строение |
| `flat_type` | 10 | Тип квартиры (сокращенный) |
| `flat_type_full` | 50 | Тип квартиры |
| `flat` | 50 | Квартира |
| `flat_area` | 50 | Площадь квартиры |
| `square_meter_price` | 50 | Рыночная стоимость м² |
| `flat_price` | 50 | Рыночная стоимость квартиры |
| `postal_box` | 50 | Абонентский ящик |
| `fias_id` | 36 | ФИАС-код адреса (идентификатор ФИАС) |
| | | `HOUSE.HOUSEGUID — если дом найден в ФИАС` |
| | | `ADDROBJ.AOGUID — в противном случае` |
| `fias_code` | | Иерархический код адреса в ФИАС (СС+РРР+ГГГ+ППП+СССС+УУУУ+ДДДД) |
| `fias_level` | 2 | Уровень детализации, до которого адрес найден в ФИАС |
| `fias_actuality_state` | | Признак актуальности адреса в ФИАС |
| `kladr_id` | 19 | КЛАДР-код адреса |
| `capital_marker` | 1 | Признак центра района или региона |
| `okato` | 11 | Код ОКАТО |
| `oktmo` | 11 | Код ОКТМО |
| `tax_office` | 4 | Код ИФНС для физических лиц |
| `tax_office_legal` | 4 | Код ИФНС для организаций |
| `timezone` | 50 | Часовой пояс города для России, часовой пояс страны — для иностранных адресов. Если у страны несколько поясов, вернёт минимальный и максимальный через слеш: UTC+5/UTC+6 |
| `geo_lat` | 12 | Координаты: широта |
| `geo_lon` | 12 | Координаты: долгота |
| `beltway_hit` | 8 | Внутри кольцевой? |
| `beltway_distance` | 3 | Расстояние от кольцевой в км. Заполнено, только если beltway_hit = OUT_MKAD или OUT_KAD, иначе пустое |
| `qc_geo` | 5 | Код точности координат |
| `qc_complete` | 5 | Код пригодности к рассылке |
| `qc_house` | 5 | Признак наличия дома в ФИАС |
| `qc` | 5 | Код проверки адреса |
| `unparsed_parts` | 250 | Нераспознанная часть адреса. Для адреса «Москва, Митинская улица, 40, вход с торца» вернет «ВХОД, С, ТОРЦА» |
| `metro` | | Список ближайших станций метро (до трёх штук) |
Координаты есть у 97% домов в Москве, 91% в Санкт-Петербурге, 69% в других городах-миллиониках и 47% по остальной России. Площадь и стоимость есть у 70% квартир в России.
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ или секретный ключ или в запросе указан несуществующий ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
Пример получения сообщения исключения
```php
getMessage());
}
}
}
```
### Подсказки по адресам
`DaDataAddress::prompt(string $query, int $count, int $language, array $locations, array $locations_geo, array $locations_boost, array $from_bound, array $to_bound)` Ищет адреса по любой части адреса от региона до дома («тверская нижний 12» → «Нижегородская обл, г Нижний Новгород, ул Тверская, д 12»). Также ищет почтовому индексу («105568» → «г Москва, ул Магнитогорская»).
Основные кейсы:
- Работает по всем странам мира (по России до дома, по остальным странам — до города). Ищет и показывает результаты как на русском языке («Самара, пр-кт Металлургов»), так и на английском («Russia, gorod Samara, prospekt Metallurgov»).
- Находит актуальные адреса по историческим названиям (Свердловск → Екатеринбург) и синонимам (Питер → Санкт-Петербург).
- Ищет по частичному совпадению («москва болот» → «г Москва, Болотная наб»), но только в последнем слове запроса («мос болот» не найдет).
- Исправляет опечатки («самара авиционная») и запросы в неправильной раскладке («vjcrdf» → «москва»).
-️ Раскладывает выбранный адрес на гранулярные части (от региона до квартиры).
-️ Поддерживает гранулярные подсказки по отдельным частям адреса (регионы, города, улицы, дома).
-️ Подсказывает адреса в конкретных регионах, районах, городах и населенных пунктах. Понимает названия («Петергоф»), коды КЛАДР («7800000800000») и ФИАС («8f238984-812b-4bb1-850b-49749fb5c56d»).
-️ Учитывает, где вы находитесь (в связке с методом город по IP-адресу).
Важно знать, что использовать данный метод не рекомендуется если вы
- Хотите автоматически, без участия человека, обработать адреса из базы или файла.
- Транслитерировать строки, например `moskva suhonskaja 11 → 127642` в `г Москва, ул Сухонская, д 11`.
Подсказки не подходят для автоматической обработки адресов. Они предлагают варианты, но не гарантируют, что угадали правильно. Поэтому окончательное решение всегда должен принимать человек.
Для автоматической обработки и транслитерации используйте `DaDataAddress::standardization(string $address)` метод.
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:--------:|:------------:|:-----------------:|:--------------------------------------------|
| `query` | `string` | `false` | | Текст запроса |
| `count` | `int` | `true` | 10 | Колличество результатов. Максимум 20 |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
| `locations` | `array` | `true` | [] | [Ограничение по родителю](https://confluence.hflabs.ru/pages/viewpage.action?pageId=204669108) (страна, регион, район, город, улица) |
| `locations_geo` | `array` | `true` | [] | [Ограничение по радиусу окружности](https://confluence.hflabs.ru/pages/viewpage.action?pageId=990871806) |
| `locations_boost` | `array` | `true` | [] | [Приоритет города при ранжировании](https://confluence.hflabs.ru/pages/viewpage.action?pageId=285343795) |
| `from_bound` | `array` | `true` | [] | [Гранулярные подсказки по адресу](https://confluence.hflabs.ru/pages/viewpage.action?pageId=222888017) |
| `to_bound` | `array` | `true` | [] | [Гранулярные подсказки по адресу](https://confluence.hflabs.ru/pages/viewpage.action?pageId=222888017) |
Пример вызова
```php
array:2 [
0 => array:3 [
"value" => "г Москва, ул Хабаровская"
"unrestricted_value" => "г Москва, ул Хабаровская"
"data" => array:81 [
"postal_code" => null
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => null
"region_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"region_kladr_id" => "7700000000000"
"region_iso_code" => "RU-MOW"
"region_with_type" => "г Москва"
"region_type" => "г"
"region_type_full" => "город"
"region" => "Москва"
"area_fias_id" => null
"area_kladr_id" => null
"area_with_type" => null
"area_type" => null
"area_type_full" => null
"area" => null
"city_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"city_kladr_id" => "7700000000000"
"city_with_type" => "г Москва"
"city_type" => "г"
"city_type_full" => "город"
"city" => "Москва"
"city_area" => null
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => null
"city_district_type" => null
"city_district_type_full" => null
"city_district" => null
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => "32fcb102-2a50-44c9-a00e-806420f448ea"
"street_kladr_id" => "77000000000713400"
"street_with_type" => "ул Хабаровская"
"street_type" => "ул"
"street_type_full" => "улица"
"street" => "Хабаровская"
"house_fias_id" => null
"house_kladr_id" => null
"house_type" => null
"house_type_full" => null
"house" => null
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => null
"flat_type_full" => null
"flat" => null
"flat_area" => null
"square_meter_price" => null
"flat_price" => null
"postal_box" => null
"fias_id" => "32fcb102-2a50-44c9-a00e-806420f448ea"
"fias_code" => "7700000000000007134"
"fias_level" => "7"
"fias_actuality_state" => "0"
"kladr_id" => "77000000000713400"
"geoname_id" => "524894"
"capital_marker" => "0"
"okato" => "45263564000"
"oktmo" => "45305000"
"tax_office" => "7718"
"tax_office_legal" => "7718"
"timezone" => null
"geo_lat" => "55.821168"
"geo_lon" => "37.82608"
"beltway_hit" => null
"beltway_distance" => null
"metro" => null
"qc_geo" => "2"
"qc_complete" => null
"qc_house" => null
"history_values" => array:1 [
0 => "ул Черненко"
]
"unparsed_parts" => null
"source" => null
"qc" => null
]
]
1 => array:3 [
"value" => "г Москва, поселение Московский, г Московский, ул Хабарова"
"unrestricted_value" => "г Москва, поселение Московский, г Московский, ул Хабарова"
"data" => array:81 [
"postal_code" => null
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => null
"region_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"region_kladr_id" => "7700000000000"
"region_iso_code" => "RU-MOW"
"region_with_type" => "г Москва"
"region_type" => "г"
"region_type_full" => "город"
"region" => "Москва"
"area_fias_id" => "762758bb-18b9-440f-bc61-8e1e77ff3fd8"
"area_kladr_id" => "7701100000000"
"area_with_type" => "поселение Московский"
"area_type" => "п"
"area_type_full" => "поселение"
"area" => "Московский"
"city_fias_id" => "fbcf1fff-1d7c-445e-ad92-b71c08b8aba3"
"city_kladr_id" => "7701100200000"
"city_with_type" => "г Московский"
"city_type" => "г"
"city_type_full" => "город"
"city" => "Московский"
"city_area" => null
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => null
"city_district_type" => null
"city_district_type_full" => null
"city_district" => null
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => "4d70a35d-9246-4d9c-bcf1-90812ad056a3"
"street_kladr_id" => "77011002000003700"
"street_with_type" => "ул Хабарова"
"street_type" => "ул"
"street_type_full" => "улица"
"street" => "Хабарова"
"house_fias_id" => null
"house_kladr_id" => null
"house_type" => null
"house_type_full" => null
"house" => null
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => null
"flat_type_full" => null
"flat" => null
"flat_area" => null
"square_meter_price" => null
"flat_price" => null
"postal_box" => null
"fias_id" => "4d70a35d-9246-4d9c-bcf1-90812ad056a3"
"fias_code" => "7701100200000000037"
"fias_level" => "7"
"fias_actuality_state" => "0"
"kladr_id" => "77011002000003700"
"geoname_id" => "857690"
"capital_marker" => "0"
"okato" => "45297565001"
"oktmo" => "45952000"
"tax_office" => "7751"
"tax_office_legal" => "7751"
"timezone" => null
"geo_lat" => "55.59483"
"geo_lon" => "37.35963"
"beltway_hit" => null
"beltway_distance" => null
"metro" => null
"qc_geo" => "2"
"qc_complete" => null
"qc_house" => null
"history_values" => null
"unparsed_parts" => null
"source" => null
"qc" => null
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив данных аналагичный структуре выдачи метода `DaDataAddress::standardization(string $address)` |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
Пример получения сообщения исключения
```php
getMessage());
}
}
}
```
### Определение адреса по координатам
`DaDataAddress::geolocate(float $lat, float $lon, int $count, int $radius_meters, int $language)` Находит ближайшие адреса (дома, улицы, города) по географическим координатам. Только для России.
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:--------:|:------------:|:-----------------:|:--------------------------------------------|
| `lat` | `float` | `false` | | Географическая широта |
| `lon` | `float` | `false` | | Географическая долгота |
| `count` | `int` | `true` | 10 | Количество результатов (максимум — 20) |
| `radius_meters` | `int` | `true` | 100 | Радиус поиска в метрах (максимум – 1000) |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
Пример вызова
```php
array:2 [
0 => array:3 [
"value" => "г Москва, ул Сухонская, д 11"
"unrestricted_value" => "127642, г Москва, ул Сухонская, д 11"
"data" => array:81 [
"postal_code" => "127642"
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => null
"region_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"region_kladr_id" => "7700000000000"
"region_iso_code" => "RU-MOW"
"region_with_type" => "г Москва"
"region_type" => "г"
"region_type_full" => "город"
"region" => "Москва"
"area_fias_id" => null
"area_kladr_id" => null
"area_with_type" => null
"area_type" => null
"area_type_full" => null
"area" => null
"city_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"city_kladr_id" => "7700000000000"
"city_with_type" => "г Москва"
"city_type" => "г"
"city_type_full" => "город"
"city" => "Москва"
"city_area" => null
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => null
"city_district_type" => null
"city_district_type_full" => null
"city_district" => null
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => "95dbf7fb-0dd4-4a04-8100-4f6c847564b5"
"street_kladr_id" => "77000000000283600"
"street_with_type" => "ул Сухонская"
"street_type" => "ул"
"street_type_full" => "улица"
"street" => "Сухонская"
"house_fias_id" => "5ee84ac0-eb9a-4b42-b814-2f5f7c27c255"
"house_kladr_id" => "7700000000028360004"
"house_type" => "д"
"house_type_full" => "дом"
"house" => "11"
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => null
"flat_type_full" => null
"flat" => null
"flat_area" => null
"square_meter_price" => null
"flat_price" => null
"postal_box" => null
"fias_id" => "5ee84ac0-eb9a-4b42-b814-2f5f7c27c255"
"fias_code" => "77000000000000028360004"
"fias_level" => "8"
"fias_actuality_state" => "0"
"kladr_id" => "7700000000028360004"
"geoname_id" => "524894"
"capital_marker" => "0"
"okato" => "45280583000"
"oktmo" => "45362000"
"tax_office" => "7715"
"tax_office_legal" => "7715"
"timezone" => null
"geo_lat" => "55.878315"
"geo_lon" => "37.65372"
"beltway_hit" => null
"beltway_distance" => null
"metro" => null
"qc_geo" => "0"
"qc_complete" => null
"qc_house" => null
"history_values" => null
"unparsed_parts" => null
"source" => null
"qc" => null
]
]
1 => array:3 [
"value" => "г Москва, ул Сухонская, д 11А"
"unrestricted_value" => "127642, г Москва, ул Сухонская, д 11А"
"data" => array:81 [
"postal_code" => "127642"
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => null
"region_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"region_kladr_id" => "7700000000000"
"region_iso_code" => "RU-MOW"
"region_with_type" => "г Москва"
"region_type" => "г"
"region_type_full" => "город"
"region" => "Москва"
"area_fias_id" => null
"area_kladr_id" => null
"area_with_type" => null
"area_type" => null
"area_type_full" => null
"area" => null
"city_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"city_kladr_id" => "7700000000000"
"city_with_type" => "г Москва"
"city_type" => "г"
"city_type_full" => "город"
"city" => "Москва"
"city_area" => null
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => null
"city_district_type" => null
"city_district_type_full" => null
"city_district" => null
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => "95dbf7fb-0dd4-4a04-8100-4f6c847564b5"
"street_kladr_id" => "77000000000283600"
"street_with_type" => "ул Сухонская"
"street_type" => "ул"
"street_type_full" => "улица"
"street" => "Сухонская"
"house_fias_id" => "abc31736-35c1-4443-a061-b67c183b590a"
"house_kladr_id" => "7700000000028360005"
"house_type" => "д"
"house_type_full" => "дом"
"house" => "11А"
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => null
"flat_type_full" => null
"flat" => null
"flat_area" => null
"square_meter_price" => null
"flat_price" => null
"postal_box" => null
"fias_id" => "abc31736-35c1-4443-a061-b67c183b590a"
"fias_code" => "77000000000000028360005"
"fias_level" => "8"
"fias_actuality_state" => "0"
"kladr_id" => "7700000000028360005"
"geoname_id" => "524894"
"capital_marker" => "0"
"okato" => "45280583000"
"oktmo" => "45362000"
"tax_office" => "7715"
"tax_office_legal" => "7715"
"timezone" => null
"geo_lat" => "55.878212"
"geo_lon" => "37.652016"
"beltway_hit" => null
"beltway_distance" => null
"metro" => null
"qc_geo" => "0"
"qc_complete" => null
"qc_house" => null
"history_values" => null
"unparsed_parts" => null
"source" => null
"qc" => null
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив данных аналагичный структуре выдачи метода `DaDataAddress::standardization(string $address)` |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
Пример получения сообщения исключения
```php
getMessage());
}
}
}
```
### Определение адреса по IP
`DaDataAddress::iplocate(string $ip, int $count, int $language)` определяет город по IP адресу.
Основные кейсы:
- Поддерживает как IPv4, так и IPv6 адреса
- Возвращает детальную информацию о городе, в том числе почтовый индекс.
- "Я тебя по айпи вычислю!"
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:-----------:|:------------:|:-----------------:|:--------------------------------------------|
| `ip` | `string` | `false` | | IPv4 или IPv6 |
| `count` | `int` | `true` | 10 | Количество результатов (максимум — 20) |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
Пример вызова
```php
array:3 [
"value" => "г Краснодар"
"unrestricted_value" => "350000, Краснодарский край, г Краснодар"
"data" => array:81 [
"postal_code" => "350000"
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => "Южный"
"region_fias_id" => "d00e1013-16bd-4c09-b3d5-3cb09fc54bd8"
"region_kladr_id" => "2300000000000"
"region_iso_code" => "RU-KDA"
"region_with_type" => "Краснодарский край"
"region_type" => "край"
"region_type_full" => "край"
"region" => "Краснодарский"
"area_fias_id" => null
"area_kladr_id" => null
"area_with_type" => null
"area_type" => null
"area_type_full" => null
"area" => null
"city_fias_id" => "7dfa745e-aa19-4688-b121-b655c11e482f"
"city_kladr_id" => "2300000100000"
"city_with_type" => "г Краснодар"
"city_type" => "г"
"city_type_full" => "город"
"city" => "Краснодар"
"city_area" => null
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => null
"city_district_type" => null
"city_district_type_full" => null
"city_district" => null
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => null
"street_kladr_id" => null
"street_with_type" => null
"street_type" => null
"street_type_full" => null
"street" => null
"house_fias_id" => null
"house_kladr_id" => null
"house_type" => null
"house_type_full" => null
"house" => null
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => null
"flat_type_full" => null
"flat" => null
"flat_area" => null
"square_meter_price" => null
"flat_price" => null
"postal_box" => null
"fias_id" => "7dfa745e-aa19-4688-b121-b655c11e482f"
"fias_code" => "23000001000000000000000"
"fias_level" => "4"
"fias_actuality_state" => "0"
"kladr_id" => "2300000100000"
"geoname_id" => "542420"
"capital_marker" => "2"
"okato" => "03401000000"
"oktmo" => "03701000001"
"tax_office" => "2300"
"tax_office_legal" => "2300"
"timezone" => null
"geo_lat" => "45.0401604"
"geo_lon" => "38.9759647"
"beltway_hit" => null
"beltway_distance" => null
"metro" => null
"qc_geo" => "4"
"qc_complete" => null
"qc_house" => null
"history_values" => null
"unparsed_parts" => null
"source" => null
"qc" => null
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив данных аналагичный структуре выдачи метода `DaDataAddress::standardization(string $address)` |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
Пример получения сообщения исключения
```php
getMessage());
}
}
}
```
### Определение адреса по КЛАДР или ФИАС коду
`DaDataAddress::id(string $ip, int $count, int $language)` определяет адреса по КЛАДР или ФИАС коду.
Основные кейсы:
- Поиск по КЛАДР-код, только для России;
- ФИАС-код, только для России;
- Идентификатор OpenStreetMap, только для Белоруссии;
- Идентификатор GeoNames, для всех остальных стран.
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:-----------:|:------------:|:-----------------:|:--------------------------------------------|
| `id` | `string` | `false` | | Текст запроса |
| `count` | `int` | `true` | 10 | Количество результатов (максимум — 20) |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
Пример вызова
```php
array:1 [
0 => array:3 [
"value" => "г Москва, ул Снежная"
"unrestricted_value" => "129323, г Москва, р-н Свиблово, ул Снежная"
"data" => array:81 [
"postal_code" => "129323"
"country" => "Россия"
"country_iso_code" => "RU"
"federal_district" => "Центральный"
"region_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"region_kladr_id" => "7700000000000"
"region_iso_code" => "RU-MOW"
"region_with_type" => "г Москва"
"region_type" => "г"
"region_type_full" => "город"
"region" => "Москва"
"area_fias_id" => null
"area_kladr_id" => null
"area_with_type" => null
"area_type" => null
"area_type_full" => null
"area" => null
"city_fias_id" => "0c5b2444-70a0-4932-980c-b4dc0d3f02b5"
"city_kladr_id" => "7700000000000"
"city_with_type" => "г Москва"
"city_type" => "г"
"city_type_full" => "город"
"city" => "Москва"
"city_area" => "Северо-восточный"
"city_district_fias_id" => null
"city_district_kladr_id" => null
"city_district_with_type" => "р-н Свиблово"
"city_district_type" => "р-н"
"city_district_type_full" => "район"
"city_district" => "Свиблово"
"settlement_fias_id" => null
"settlement_kladr_id" => null
"settlement_with_type" => null
"settlement_type" => null
"settlement_type_full" => null
"settlement" => null
"street_fias_id" => "9120b43f-2fae-4838-a144-85e43c2bfb29"
"street_kladr_id" => "77000000000268400"
"street_with_type" => "ул Снежная"
"street_type" => "ул"
"street_type_full" => "улица"
"street" => "Снежная"
"house_fias_id" => null
"house_kladr_id" => null
"house_type" => null
"house_type_full" => null
"house" => null
"block_type" => null
"block_type_full" => null
"block" => null
"flat_type" => null
"flat_type_full" => null
"flat" => null
"flat_area" => null
"square_meter_price" => null
"flat_price" => null
"postal_box" => null
"fias_id" => "9120b43f-2fae-4838-a144-85e43c2bfb29"
"fias_code" => "77000000000000026840000"
"fias_level" => "7"
"fias_actuality_state" => "0"
"kladr_id" => "77000000000268400"
"geoname_id" => "524901"
"capital_marker" => "0"
"okato" => "45280580000"
"oktmo" => "45361000"
"tax_office" => "7716"
"tax_office_legal" => "7716"
"timezone" => null
"geo_lat" => "55.8523466"
"geo_lon" => "37.6469376"
"beltway_hit" => null
"beltway_distance" => null
"metro" => null
"qc_geo" => "2"
"qc_complete" => null
"qc_house" => null
"history_values" => null
"unparsed_parts" => null
"source" => null
"qc" => null
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив данных аналагичный структуре выдачи метода `DaDataAddress::standardization(string $address)` |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
Пример получения сообщения исключения
```php
getMessage());
}
}
}
```
### Определение ближайшего отделения Почты России по адресу
`DaDataAddress::postalUnitByAddress(string $address, int $count, int $language)` определяет ближайшее почтовые отделения по адресу
Если интернет-магазин доставляет покупки почтой по России, хорошо бы подсказать человеку, где и когда он может забрать посылку. В этом поможет справочник почтовых отделений — в нём есть точный адрес, координаты и часы работы отделения, а ещё отметка, если оно временно закрыто.
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:-----------:|:------------:|:-----------------:|:--------------------------------------------|
| `address` | `string` | `false` | | Адресс |
| `count` | `int` | `true` | 10 | Количество результатов (максимум — 20) |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
Пример вызова
```php
array:1 [
0 => array:3 [
"value" => "127642"
"unrestricted_value" => "г Москва, проезд Дежнёва, д 2А"
"data" => array:15 [
"postal_code" => "127642"
"is_closed" => false
"type_code" => "ГОПС"
"address_str" => "г Москва, проезд Дежнёва, д 2А"
"address_kladr_id" => "7700000000000"
"address_qc" => "0"
"geo_lat" => 55.872127
"geo_lon" => 37.651223
"schedule_mon" => "08:00-20:00"
"schedule_tue" => "08:00-20:00"
"schedule_wed" => "08:00-20:00"
"schedule_thu" => "08:00-20:00"
"schedule_fri" => "08:00-20:00"
"schedule_sat" => "09:00-18:00"
"schedule_sun" => "09:00-18:00"
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив рассмотренный ниже |
Описание вложенного массива `data`
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `postal_code` | Индекс |
| `is_closed` | `true`, если отделение закрыто, иначе `false` |
| `type_code` | Тип отделения |
| `address_str` | Адрес одной строкой |
| `address_kladr_id` | КЛАДР-код населённого пункта |
| `address_qc` | Код проверки адреса |
| `geo_lat` | Широта |
| `geo_lon` | Долгота |
| `schedule_mon` | Режим работы в понедельник |
| `schedule_tue` | Режим работы во вторник |
| `schedule_wed` | Режим работы в среду |
| `schedule_thu` | Режим работы в четверг |
| `schedule_fri` | Режим работы в пятницу |
| `schedule_sat` | Режим работы в субботу |
| `schedule_sun` | Режим работы в воскресенье |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
### Определение отделения Почты России почтовому индексу
`DaDataAddress::postalUnitById(int $code, int $count, int $language)` определяет адреса почтовых отделений почтовому коду
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:-----------:|:------------:|:-----------------:|:--------------------------------------------|
| `code` | `int` | `false` | | Индекс |
| `count` | `int` | `true` | 10 | Количество результатов (максимум — 20) |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
Пример вызова
```php
array:1 [
0 => array:3 [
"value" => "127642"
"unrestricted_value" => "г Москва, проезд Дежнёва, д 2А"
"data" => array:15 [
"postal_code" => "127642"
"is_closed" => false
"type_code" => "ГОПС"
"address_str" => "г Москва, проезд Дежнёва, д 2А"
"address_kladr_id" => "7700000000000"
"address_qc" => "0"
"geo_lat" => 55.872127
"geo_lon" => 37.651223
"schedule_mon" => "08:00-20:00"
"schedule_tue" => "08:00-20:00"
"schedule_wed" => "08:00-20:00"
"schedule_thu" => "08:00-20:00"
"schedule_fri" => "08:00-20:00"
"schedule_sat" => "09:00-18:00"
"schedule_sun" => "09:00-18:00"
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив рассмотренный ниже |
Описание вложенного массива `data`
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `postal_code` | Индекс |
| `is_closed` | `true`, если отделение закрыто, иначе `false` |
| `type_code` | Тип отделения |
| `address_str` | Адрес одной строкой |
| `address_kladr_id` | КЛАДР-код населённого пункта |
| `address_qc` | Код проверки адреса |
| `geo_lat` | Широта |
| `geo_lon` | Долгота |
| `schedule_mon` | Режим работы в понедельник |
| `schedule_tue` | Режим работы во вторник |
| `schedule_wed` | Режим работы в среду |
| `schedule_thu` | Режим работы в четверг |
| `schedule_fri` | Режим работы в пятницу |
| `schedule_sat` | Режим работы в субботу |
| `schedule_sun` | Режим работы в воскресенье |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
### Определение отделения Почты России по координатам
`DaDataAddress::postalUnitByGeoLocate(float $lat, float $lon, int $radius_meters, int $count, int $language)` определяет адреса почтовых отделений по координатам
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:-----------:|:------------:|:-----------------:|:--------------------------------------------|
| `lat` | `int` | `false` | | Широта |
| `lon` | `int` | `false` | | Долгота |
| `radius_meters` | `int` | `false` | 1000 | Радиус поиска в метрах. Максимум 1000 |
| `count` | `int` | `true` | 10 | Количество результатов (максимум — 20) |
| `language` | `int` | `true` | 1 | Язык ответа. Он может быть **русский** значение `language = 1` или **английским**, значение `language = 2`. Мы призываем использовать константы `Language::RU` или `Language::EN` |
Пример вызова
```php
array:2 [
0 => array:3 [
"value" => "127642"
"unrestricted_value" => "г Москва, проезд Дежнёва, д 2А"
"data" => array:15 [
"postal_code" => "127642"
"is_closed" => false
"type_code" => "ГОПС"
"address_str" => "г Москва, проезд Дежнёва, д 2А"
"address_kladr_id" => "7700000000000"
"address_qc" => "0"
"geo_lat" => 55.872127
"geo_lon" => 37.651223
"schedule_mon" => "08:00-20:00"
"schedule_tue" => "08:00-20:00"
"schedule_wed" => "08:00-20:00"
"schedule_thu" => "08:00-20:00"
"schedule_fri" => "08:00-20:00"
"schedule_sat" => "09:00-18:00"
"schedule_sun" => "09:00-18:00"
]
]
1 => array:3 [
"value" => "127221"
"unrestricted_value" => "г Москва, ул Полярная, д 16 к 1"
"data" => array:15 [
"postal_code" => "127221"
"is_closed" => false
"type_code" => "ГОПС"
"address_str" => "г Москва, ул Полярная, д 16 к 1"
"address_kladr_id" => "7700000000000"
"address_qc" => "0"
"geo_lat" => 55.876607
"geo_lon" => 37.637308
"schedule_mon" => "08:00-20:00"
"schedule_tue" => "08:00-20:00"
"schedule_wed" => "08:00-20:00"
"schedule_thu" => "08:00-20:00"
"schedule_fri" => "08:00-20:00"
"schedule_sat" => "09:00-18:00"
"schedule_sun" => "09:00-18:00"
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив рассмотренный ниже |
Описание вложенного массива `data`
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `postal_code` | Индекс |
| `is_closed` | `true`, если отделение закрыто, иначе `false` |
| `type_code` | Тип отделения |
| `address_str` | Адрес одной строкой |
| `address_kladr_id` | КЛАДР-код населённого пункта |
| `address_qc` | Код проверки адреса |
| `geo_lat` | Широта |
| `geo_lon` | Долгота |
| `schedule_mon` | Режим работы в понедельник |
| `schedule_tue` | Режим работы во вторник |
| `schedule_wed` | Режим работы в среду |
| `schedule_thu` | Режим работы в четверг |
| `schedule_fri` | Режим работы в пятницу |
| `schedule_sat` | Режим работы в субботу |
| `schedule_sun` | Режим работы в воскресенье |
**Exceptions**
При вызове методов, вы можете обрабатывать коды исключений и их сообщения
| **Код** | **Описание** |
|:---------------------|:--------------------------------------------------------------------------------------------|
| `400` | Некорректный запрос |
| `401` | В запросе отсутствует API-ключ |
| `403` | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс |
| `405` | Запрос сделан с методом, отличным от POST |
| `413` | Слишком большая длина запроса или слишком много условий |
| `429` | Слишком много запросов в секунду или новых соединений в минуту |
| `5xx` | Произошла внутренняя ошибка сервиса |
Более детальную информацию вы можете получить из сообщения исключения.
### Определение идентификатора города в СДЭК, Boxberry и DPD
`DaDataAddress::delivery(string $code)` помогает решить сзадачу определения идентификатора города в СДЭК, Boxberry и DPD
Службы доставки часто используют собственные идентификаторы городов, и требуют от магазина указывать их в заказе.
Метод `DaDataAddress::delivery(string $code)` определяет идентификатор города в службе доставке на основании КЛАДР-кода города.
Параметры вызова
| **Название** | **Тип** | **Optional** | **Default value** | **Описание** |
|:------------------|:-----------:|:------------:|:-----------------:|:--------------------------------------------|
| `code` | `string` | `false` | | Код |
Пример вызова
```php
array:1 [
0 => array:3 [
"value" => "3100400100000"
"unrestricted_value" => "fe7eea4a-875a-4235-aa61-81c2a37a0440"
"data" => array:5 [
"kladr_id" => "3100400100000"
"fias_id" => "fe7eea4a-875a-4235-aa61-81c2a37a0440"
"boxberry_id" => "01929"
"cdek_id" => "344"
"dpd_id" => "196006461"
]
]
]
]
```
Описание ответа
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `value` | Адрес одной строкой (как показывается в списке подсказок) |
| `unrestricted_value` | Адрес одной строкой (полный, с индексом) |
| `data` | Вложенный массив рассмотренный ниже |
Описание вложенного массива `data`
| **Название** | **Описание** |
|:--------------------------|:--------------------------------------------------------------------------------------------------------------|
| `kladr_id` | КЛАДР-код города |
| `fias_id` | ФИАС-код города |
| `boxberry_id` | Идентификатор города по справочнику Boxberry |
| `cdek_id` | Идентификатор города по справочнику СДЭК |
| `dpd_id` | Идентификатор города по справочнику DPD |
**Ex