Address hints #

A method for quickly selecting an address from a list ranked by similarity. The minimum number of letters required to start a search is 3.

Method address #

GET /legacy/selectAddress

Functionality #

clears incoming data from extra characters to standardize the address
by address part displays a list of possible addresses, sorted by relevance

Request parameters #

Parameter	Description
letters	String for hint and parsing of the address
country	Country code in which the address is searched, in ISO 3166 format (https://www.iso.org/iso-3166-country-codes.html)

Sample request data #

# GET parameters

-X GET 
--header 'Accept: application/json' 
'https://api.apidq.ru/api/legacy/selectAddress?letters=Кировская обл, г Киров, Ленина 1'

Response options #

Here is the translation of the provided table into English:

Parameter	Description
c_k5	Found KLADR code
c_index	Found index
c_fullname	Found address (up to the street)
c_RegionName	Region name
c_RegionType	Region abbreviation
c_SubRegionName	Subregion name
c_SubRegionType	Subregion abbreviation
c_CityName	City name
c_CityType	City abbreviation
c_NPName	Locality name
c_NPType	Locality abbreviation
c_StreetName	Street name
c_StreetType	Street abbreviation
c_house	House number
c_flat	Flat number
c_HouseStatus	Parsing status of the house (description)

Sample response data #

[
    {
        "c_k5": "43000001000022500",
        "c_index": "610004",
        "c_fullname": "Кировская обл, г Киров, ул Ленина, дом 1",
        "c_RegionName": "Кировская",
        "c_RegionType": "обл",
        "c_SubRegionName": "",
        "c_SubRegionType": "",
        "c_CityName": "Киров",
        "c_CityType": "г",
        "c_NPName": "",
        "c_NPType": "",
        "c_StreetName": "Ленина",
        "c_StreetType": "ул",
        "c_house": "дом 1",
        "c_flat": "",
        "c_HouseStatus": "дом найден"
    },
    {
        "c_k5": "43000001000022400",
        "c_index": "610013",
        "c_fullname": "Кировская обл, г Киров, ул Ленина (Нововятский), дом 1",
        "c_RegionName": "Кировская",
        "c_RegionType": "обл",
        "c_SubRegionName": "",
        "c_SubRegionType": "",
        "c_CityName": "Киров",
        "c_CityType": "г",
        "c_NPName": "",
        "c_NPType": "",
        "c_StreetName": "Ленина (Нововятский)",
        "c_StreetType": "ул",
        "c_house": "дом 1",
        "c_flat": "",
        "c_HouseStatus": "дом найден"
    }
]