Via Profit / DaData API
Via Profit / DaData - Dadata.ru service API
Table of Contents
Overview
This package is an implementation of the API for the service Dadata.ru. To use this module, you will need to register on Dadata.ru and get the API key
and Secret key
.
Why
Despite the fact that in npmjs.com some api modules for data are already present, this package differs from the others in that it is written in typescript and contains all the types for the API response with comments.
You can import the types of all responses separately too:
import type { AddressResponse, EntityResponse } from '@via-profit/dadata';
Installation
Just install the package use npm
# with npm
$ npm install @via-profit/dadata
Getting Started
You need to import the module, create an instance of the class, and call one of the possible methods.
import DaData from '@via-profit/dadata';
const dadata = new DaData({
apiKey: 'your-api-key',
apiSecret: 'your-secret-key',
});
// Search the bank suggestions
const bankSuggestions = await dadata.bankLookup({
query: 'alfa'
});
// Email autocomplete
const emailSuggestions = await dadata.emailLookup({
query: 'example@'
});
API
Method | Description | Reference |
---|---|---|
addressLookup |
Finds address. Defines the coordinates of the address (house, street, city). | Link |
reverseGeocoding |
Finds the nearest addresses (houses, streets, cities) by geographical coordinates. The addresses in the response are in the order of distance from the specified coordinates. | Link |
emailLookup |
Auto-completion of an email address. | Link |
resolveIPAddress |
Determines the city by IP address in Russia. Supports both ipv4 and ipv6 addresses. |
Link |
entityLookup |
Looking for companies and individual entrepreneurs. | Link |
bankLookup |
Looking for credit organizations. | Link |
nameLookup |
Suggests the full name in one line or separately the last name, first name, patronymic. | Link |