Address standardization

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 #

POST /clean/address

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 #

ParametrDescription
queryString for parsing the address
countryCodeCountry code in which the address is searched, in ISO 3166 format (https://www.iso.org/iso-3166-country-codes.html)

Sample request data #

{
  "query": "санкт-петербург козлова 30",
  "countryCode": "RU"
}

Response options #

ParameterDescription
originalAn incoming address string that participated in the standardization
addressParsed and standardized address string
postcodeInZIP code found in the input string
postcodePostal code determined from the reference base in the process of standardization
regionRegion, region. See the description of the addressLevel structure
areaDistrict of the region. See the description of the addressLevel structure
cityTown. See the description of the addressLevel structure
cityAreaA district of the city. See the description of the addressLevel structure
settlementLocality. See the description of the addressLevel structure
planStructurePlanning structure (microdistrict). See the description of the addressLevel structure
streetStreet. See the description of the addressLevel structure
houseDetailsHouse part of the address. See the description of the structure houseDetails
coordinatesGeographical coordinates. See the description of the structure coordinates
countryCountry. See the description of the country structure
validSign of correctness of the address
qualityAddress quality code. See Address Quality Code

Nested structures #

Description of the addresslevel structure

ParameterDescription
fullNameName and type of addressable element
nameName of the addressable element
typeAddressable element type
codesString for parsing the address

Description of the codes structure

ParameterDescription
fiasFIAS code
gaGaCode - global address code
osmOpenStreetMap code

Description of the structure of housedetails

ParameterDescription
houseHouse
caseframe
buildstructure
literletter
vladpossession
blockblock
pompremises
pavpavilion
uchplot
obschhostel
komroom
flatapartment
officeoffice
kabcabinet

Description of the coordinates structure

ParameterDescription
latitudeLatitude
longitudeLongitude

Country structure description

ParameterDescription
nameCountry name
alpha2Country code, in ISO 3166-1 alpha-2 format
alpha3Country code, in ISO 3166-1 alpha-3 format
numericCountry code, in ISO 3166-1 numeric format

Sample response data #

{
  "original": "санкт-петербург козлова 30",
  "address": "г Санкт-Петербург, ул Козлова",
  "postcodeIn": "",
  "postcode": "198260",
  "region": {
    "fullName": "г Санкт-Петербург",
    "name": "Санкт-Петербург",
    "type": "г",
    "codes": {
      "fias": "c2deb16a-0330-4f05-821f-1d09c93331e6",
      "ga": "RU0780000000000000000000000",
      "osm": ""
    }
  },
  "area": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "city": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "cityArea": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "settlement": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "planStructure": {
    "fullName": "",
    "name": "",
    "type": "",
    "codes": {
      "fias": "",
      "ga": "",
      "osm": ""
    }
  },
  "street": {
    "fullName": "ул Козлова",
    "name": "Козлова",
    "type": "ул",
    "codes": {
      "fias": "bcd993d5-11bb-49ba-957d-7f68ec1b3a70",
      "ga": "RU0780000000000000000000556",
      "osm": ""
    }
  },
  "houseDetails": {
    "fullName": "дом 30",
    "floor": "",
    "house": "30",
    "case": "",
    "build": "",
    "liter": "",
    "lend": "",
    "block": "",
    "pav": "",
    "flat": "",
    "office": "",
    "kab": "",
    "abon": "",
    "plot": "",
    "sek": "",
    "entr": "",
    "room": "",
    "hostel": "",
    "munit": ""
  },
  "coordinates": {
    "latitude": 59.8388,
    "longitude": 30.2184
  },
  "country": {
    "name": "Россия",
    "alpha2": "RU",
    "alpha3": "RUS",
    "numeric": 643
  },
  "valid": true,
  "quality": {
    "unique": 0,
    "actuality": 0,
    "undefined": 0,
    "level": 7,
    "house": 0,
    "geo": 7
  }
}