Dadata API class
Kind: global class
- Dadata
- new Dadata(apiKey)
- .fio(params) ⇒
promise.<Array.<object>> - .address(params) ⇒
promise.<Array.<object>> - .party(params) ⇒
promise.<Array.<object>> - .bank(params) ⇒
promise.<Array.<object>> - .email(params) ⇒
promise.<Array.<object>>
API constructor
| Param | Type | Description |
|---|---|---|
| apiKey | string |
Ключ dadata.ru |
Подсказки по ФИО
Kind: instance method of Dadata
See: Документация
| Param | Type | Default | Description |
|---|---|---|---|
| params | object |
Параметры | |
| params.query | string |
Запрос | |
| [params.count] | number |
10 |
Кол-во возвращаемых результатов |
| [params.parts] | Array.<string> |
|
Подсказки по части ФИО (NAME, SURNAME, PATRONYMIC) |
| [params.gender] | string |
"UNKNOWN" |
Пол |
Подсказки по адресу
Kind: instance method of Dadata
See: Документация
| Param | Type | Default | Description |
|---|---|---|---|
| params | object |
Параметры | |
| params.query | string |
Запрос | |
| [params.count] | number |
10 |
Кол-во возвращаемых результатов |
| [params.locations=] | object |
Ограничение поиска адреса | |
| params.location.region_fias_id | number |
Ограничение по ФИАС коду региона | |
| params.location.area_fias_id | number |
Ограничение по ФИАС коду области | |
| params.location.city_fias_id | number |
Ограничение по ФИАС коду города | |
| params.location.settlement_fias_id | number |
Ограничение по ФИАС коду населенного пункта | |
| params.location.street_fias_id | number |
Ограничение по ФИАС коду улицы |
Подсказки по организациям
Kind: instance method of Dadata
See: Документация
| Param | Type | Default | Description |
|---|---|---|---|
| params | object |
Параметры | |
| params.query | string |
Запрос | |
| [params.count] | number |
10 |
Кол-во возвращаемых результатов |
| [params.status] | Array.<string> |
|
Фильтр по статусу организации (ACTIVE - активные, LIQUIDATING - ликвидируемые, LIQUIDATED - ликвидированные) |
| [params.type] | string |
null |
Фильтр по юридическим лицам (LEGAL) или индивидуальным предпринимателям (INDIVIDUAL) |
| params.locations | Array.<object> |
Фильтр по региону | |
| params.locations.kladr_id | number |
Двухзначный код региона по КЛАДР |
Подсказки по банкам
Kind: instance method of Dadata
See: Документация
| Param | Type | Default | Description |
|---|---|---|---|
| params | object |
Параметры | |
| params.query | string |
Запрос | |
| [params.count] | number |
10 |
Кол-во возвращаемых результатов |
| [params.status] | Array.<string> |
|
Фильтр по статусу (ACTIVE - активные, LIQUIDATING - ликвидируемые, LIQUIDATED - ликвидированные) |
| [params.type] | string |
null |
Фильтр по типу банковской организации BANK - банк, NKO - небанковская кредитная организация, BANK_BRANCH - филиал банка, NKO_BRANCH - филиал небанковской кредитной организации, RKC - РКЦ / ГРКЦ, OTHER - другое |
Подсказки по email
Kind: instance method of Dadata
See: Документация
| Param | Type | Default | Description |
|---|---|---|---|
| params | object |
Параметры | |
| params.query | string |
Запрос | |
| [params.count] | number |
10 |
Кол-во возвращаемых результатов |