Address standardization in the format of the legacy API CheckAddress

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/checkAddress

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 #

ParameterDescription
addrString for parsing the address
countryCountry 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/checkAddress?addr=санкт-петербург гороховая улица, 44'

Response options #

ParameterDescription
c_ischeckVerification status
c_index_inIndex in the input string
c_index_outFound index
c_addr_inInput address
c_addr_outFound address (up to the street)
c_kladrFound KLADR code
c_json_kvantDetailed information about the residential part. See the description of the c_json_kvant structure
c_house_strHouse number
c_status_errorQuality code
c_house_error_descParsing status of the house (description)
c_addr_lostUnparsed part of the input string
c_kladr1919-digit KLADR code
c_gninmbIFNS code
c_okatoOKATO code
c_oktmoOKTMO code
c_aoguidFIAS code up to the street
c_aolevelFIAS level
c_houseguidHouse identifier
c_timezoneTime zone
c_coordinateAddress coordinates. See the description of the coordinates structure

Nested structures #

Description of the structure c_json_kvant #

ParameterDescription
househouse
caseframe
buildstructure
literletter
lendpossession
constrconstruction
steadplot
flatapartment
officeoffice
roomroom
kabcabinet
placepremises
entrentrance
floorfloor
blockblock
pavpavilion
sekhouse section
abonsubscriber box
munitmilitary unit

Description of the structure c_coordinate #

ParameterDescription
c_latLatitude
c_lonLongitude
c_levelLevel

Sample response data #

[
    {
        "c_ischeck": "1",
        "c_index_in": "",
        "c_index_out": "190031",
        "c_addr_in": "санкт-петербург гороховая улица, 44",
        "c_addr_out": "г Санкт-Петербург, ул Гороховая",
        "c_kladr": "78000000000031400",
        "c_json_kvant": {
            "house": "44"
        },
        "c_kvant": "house:44",     
		"c_house_str": "дом 44",
        "c_house_error_desc": "дом найден по КЛАДР/ФИАС",
        "c_status_error": "000035",
        "c_addr_lost": "",
        "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"
        }
    }
]