Address standardization #
The address bar parsing service analyzes the incoming content for the presence of address elements. The found address elements are compared with the address reference directories, and when a sufficient match is found, the only sought and granular address is displayed.
Method address #
GET /legacy/searchAddressDetail
Functionality #
- clears the incoming data from unnecessary characters to standardize the address;
- determines the coordinates of the address (if available in the reference directory);
- determines the index of the house;
- complements the missing address levels (region, district);
- defines identifiers in various reference bases.
Request parameters #
| Parameter | Description |
|---|---|
| addr | String for parsing 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/searchAddressDetail?addr=санкт-петербург гороховая улица, 44'
Response options #
| Parameter | Description |
|---|---|
| c_ischeck | Verification status |
| c_index_in | Index in the input string |
| c_zipcode | Found index |
| c_address_original | Input address |
| c_address_full | Found address (up to the street) |
| c_kladr | Found KLADR code |
| c_region_name | Region name |
| c_region_abbr | Region abbreviation |
| c_district_name | District name |
| c_district_abbr | District abbreviation |
| c_city_name | City name |
| c_city_abbr | City abbreviation |
| c_community_name | Community name |
| c_community_abbr | Community abbreviation |
| c_street_name | Street name |
| c_street_abbr | Street abbreviation |
| c_json_kvant | Detailed information about the residential part. See the description of the c_json_kvant structure |
| c_house_str | House number |
| c_addr_lost | Unparsed part of the input string |
| c_status_error | Quality code |
| c_house_error | Parsing status of the house (code) |
| c_house_error_desc | Parsing status of the house (description) |
| c_kladr19 | 19-digit KLADR code |
| c_gninmb | IFNS code |
| c_okato | OKATO code |
| c_oktmo | OKTMO code |
| c_aoguid | FIAS code up to the street |
| c_aolevel | FIAS level |
| c_houseguid | House identifier |
| c_timezone | Time zone |
| c_coordinate | Address coordinates. See the description of the coordinates structure |
Nested structures #
Description of the structure c_json_kvant
#
| Parameter | Description |
|---|---|
| house | house |
| case | frame |
| build | structure |
| liter | letter |
| lend | possession |
| constr | construction |
| stead | plot |
| flat | apartment |
| office | office |
| room | room |
| kab | cabinet |
| place | premises |
| entr | entrance |
| floor | floor |
| block | block |
| pav | pavilion |
| sek | house section |
| abon | subscriber box |
| munit | military unit |
Description of the structure c_coordinate
#
| Parameter | Description |
|---|---|
| c_lat | Latitude |
| c_lon | Longitude |
| c_level | Level |
Sample response data #
[
{
"c_ischeck": "1",
"c_index_in": "",
"c_zipcode": "190031",
"c_address_original": "санкт-петербург гороховая улица, 44",
"c_address_full": "г Санкт-Петербург, ул Гороховая",
"c_kladr": "78000000000031400",
"c_region_name": "Санкт-Петербург",
"c_region_abbr": "г",
"c_district_name": "",
"c_district_abbr": "",
"c_city_name": "",
"c_city_abbr": "",
"c_community_name": "",
"c_community_abbr": "",
"c_street_name": "Гороховая",
"c_street_abbr": "ул",
"c_json_kvant": {
"house": "44"
},
"c_house_str": "дом 44",
"c_addr_lost": "",
"c_status_error": "000035",
"c_house_error": "3",
"c_house_error_desc": "дом найден по КЛАДР/ФИАС",
"c_kladr19": "",
"c_gninmb": "",
"c_okato": "",
"c_oktmo": "40302000",
"c_aoguid": "7daba2d5-ccdd-4a51-b55c-1f73f67fe4a5",
"c_aolevel": "7",
"c_houseguid": "",
"c_timezone": "",
"c_coordinate": {
"c_lon": "30.3102",
"c_lat": "59.9356",
"c_level": "7"
}
}
]