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 #
| Parametr | Description |
|---|---|
| query | String for parsing the address |
| countryCode | Country 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 #
| Parameter | Description |
|---|---|
| original | An incoming address string that participated in the standardization |
| address | Parsed and standardized address string |
| addressFull | Parsed and standardized address string with house part |
| postcodeIn | ZIP code found in the input string |
| postcode | Postal code determined from the reference base in the process of standardization |
| region | Region, region. See the description of the addressLevel structure |
| area | District of the region. See the description of the addressLevel structure |
| municipal | Municipal entity. See the description of the addressLevel structure |
| city | Town. See the description of the addressLevel structure |
| cityArea | A district of the city. See the description of the addressLevel structure |
| settlement | Locality. See the description of the addressLevel structure |
| planStructure | Planning structure (microdistrict). See the description of the addressLevel structure |
| street | Street. See the description of the addressLevel structure |
| houseDetails | House part of the address. See the description of the structure houseDetails |
| coordinates | Geographical coordinates. See the description of the structure coordinates |
| country | Country. See the description of the country structure |
| valid | Sign of correctness of the address |
| quality | Address quality code. See Address Quality Code |
| timezone | Time zone |
Nested structures #
Description of the addresslevel structure
| Parameter | Description |
|---|---|
| fullName | Name and type of addressable element |
| name | Name of the addressable element |
| type | Addressable element type |
| codes | String for parsing the address |
Description of the codes structure
| Parameter | Description |
|---|---|
| fias | FIAS code |
| ga | GaCode - global address code |
| osm | OpenStreetMap code |
Description of the structure of housedetails
| Parameter | Description |
|---|---|
| full_name | house in one line |
| 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 |
| codes | house codes |
Description of the coordinates structure
| Parameter | Description |
|---|---|
| latitude | Latitude |
| longitude | Longitude |
Country structure description
| Parameter | Description |
|---|---|
| name | Country name |
| alpha2 | Country code, in ISO 3166-1 alpha-2 format |
| alpha3 | Country code, in ISO 3166-1 alpha-3 format |
| numeric | Country code, in ISO 3166-1 numeric format |
Sample response data #
{
"original": "санкт-петербург козлова 30",
"addressFull": "г Санкт-Петербург, ул Козлова, дом 30",
"address": "г Санкт-Петербург, ул Козлова",
"postcodeIn": "",
"postcode": "198260",
"region": {
"fullName": "г Санкт-Петербург",
"name": "Санкт-Петербург",
"type": "г",
"codes": {
"fias": "c2deb16a-0330-4f05-821f-1d09c93331e6",
"ga": "RU0780000000000000000000000",
"osm": "R337422",
"gar": "1414662",
"kladr": "7800000000000"
}
},
"area": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"municipal": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"city": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"cityArea": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"settlement": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"planStructure": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"street": {
"fullName": "ул Козлова",
"name": "Козлова",
"type": "ул",
"codes": {
"fias": "bcd993d5-11bb-49ba-957d-7f68ec1b3a70",
"ga": "RU0780000000000000000000556",
"osm": "W4456380",
"gar": "1422469",
"kladr": "78000000000055600"
}
},
"houseDetails": {
"fullName": "дом 30",
"house": "30",
"case": "",
"build": "",
"liter": "",
"lend": "",
"constr": "",
"stead": "",
"flat": "",
"office": "",
"room": "",
"kab": "",
"place": "",
"entr": "",
"floor": "",
"block": "",
"pav": "",
"sek": "",
"abon": "",
"munit": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"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
},
"timezone": "UTC+3"
}