House part of the address standardization

House part of the address standardization #

Service for parsing the house part of the address.

Method address #

POST /clean/house

Functionality #

Defines the house part in the source string.

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": "108811, Москва г, км Киевское шоссе 22-й, двлд. 4, стр. 2, ЭТ 8 БЛОК Г ОФ 839",
  "countryCode": "RU"
}

Response options #

ParameterDescription
originalAn incoming address string that participated in the standardization
postcodeInZIP code found in the input string
houseDetailsHouse part of the address. See the description of the structure houseDetails

Nested structures #

Description of the structure of housedetails

ParameterDescription
full_namehouse in one line
househouse
caseframe
buildstructure
literletter
lendpossession
constrconstruction
steadplot
flatapartment
officeoffice
roomroom
kabcabinet
placepremises
entrentrance
floorfloor
blockblock
pavpavilion
sekhouse section
abonsubscriber box
munitmilitary unit
codeshouse codes

Sample response data #

{
    "original": "108811, Москва г, км Киевское шоссе 22-й, двлд. 4, стр. 2, ЭТ 8 БЛОК Г ОФ 839",
    "postcodeIn": "108811",
    "houseDetails": {
        "fullName": "дом 4, строение 2, этаж 8, офис 839, блок г",
        "house": "4",
        "case": "",
        "build": "2",
        "liter": "",
        "lend": "",
        "constr": "",
        "stead": "",
        "flat": "",
        "office": "839",
        "room": "",
        "kab": "",
        "place": "",
        "entr": "",
        "floor": "8",
        "block": "г",
        "pav": "",
        "sek": "",
        "abon": "",
        "munit": "",
        "codes": null
    }
}