Address hints #
A method for quickly selecting an address from a list ranked by similarity. The minimum number of letters required to start a search is 3.
Method address #
POST /suggest/address
Functionality #
- clears incoming data from extra characters to standardize the address
- by address part displays a list of possible addresses, sorted by relevance
Request parameters #
| Parameter | Description |
|---|---|
| query | String for hint and parsing of the address |
| countryCode | Country code in which the address is searched, in ISO 3166 format ( https://www.iso.org/iso-3166-country-codes.html) |
| count | The maximum number of addresses that are offered in the response |
| scopes | Address search sector limitation. See structure description scopes |
Nested structures #
Structure description scopes
#
| Параметр | Описание |
|---|---|
| fias | Code in the FIAS database |
| ga | GaCode - global address code |
| kladr | Code in database KLADR |
| postcode | Postal code determined by reference base in the process of standardization |
| name | City |
| regionName | Region |
| streetName | Street |
| coordinates | Coordinates. See the description of the coordinates structure |
Structure description coordinates
#
| Параметр | Описание |
|---|---|
| latitude | Latitude |
| longitude | Longitude |
| radius | Search radius in meters |
Sample request data #
{
"query": "котлас куз",
"countryCode": "RU",
"count": 10,
"scopes": [
{
"fias": "cfa3b599-159c-49f9-992e-3aa64c675ad6",
"ga": "RU0290080000000000000000000",
"osm": "",
"gar": "447206",
"kladr": "2900800000001",
"postcode": "165300",
"name": "Котлас",
"regionName": "Архангельская",
"streetName": "Кузнецова",
"coordinates": {
"latitude": 61.2431,
"longitude": 46.6537,
"radius": 100
}
}
]
}
Response options #
| Parameter | Description |
|---|---|
| suggestions | An array of objects whose structure matches the answer from the Address Standardization Method |
Sample response data #
{
"suggestions": [
{
"address": "г Москва, Варшавское ш",
"postcode": "117105",
"region": {
"fullName": "г Москва",
"name": "Москва",
"type": "г",
"codes": {
"fias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"ga": "RU0770000000000000000000000",
"osm": ""
}
},
"area": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": ""
}
},
"municipal": {
"fullName": "",
"name": "",
"type": "",
"codes": {
"fias": "",
"ga": "",
"osm": "",
"gar": "",
"kladr": ""
}
},
"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": "8fc06b0b-5de3-4a72-9e6f-9e0647a37a66",
"ga": "RU0770000000000000000000476",
"osm": ""
}
},
"houseDetails": {
"fullName": "",
"floor": "",
"house": "",
"case": "",
"build": "",
"liter": "",
"lend": "",
"block": "",
"pav": "",
"flat": "",
"office": "",
"kab": "",
"abon": "",
"plot": "",
"sek": "",
"entr": "",
"room": "",
"hostel": "",
"munit": ""
},
"coordinates": {
"latitude": 55.646,
"longitude": 37.6203
},
"country": {
"name": "Россия",
"alpha2": "RU",
"alpha3": "RUS",
"numeric": 643
},
"timezone": "UTC+3"
},
{
"address": "г Москва, 2-й Варшавский проезд",
"postcode": "115201",
"region": {
"fullName": "г Москва",
"name": "Москва",
"type": "г",
"codes": {
"fias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"ga": "RU0770000000000000000000000",
"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": "2-й Варшавский проезд",
"name": "2-й Варшавский",
"type": "проезд",
"codes": {
"fias": "b89718e1-8b56-4ba8-8383-5c7b596aee6c",
"ga": "RU0770000000000000000000475",
"osm": ""
}
},
"houseDetails": {
"fullName": "",
"floor": "",
"house": "",
"case": "",
"build": "",
"liter": "",
"lend": "",
"block": "",
"pav": "",
"flat": "",
"office": "",
"kab": "",
"abon": "",
"plot": "",
"sek": "",
"entr": "",
"room": "",
"hostel": "",
"munit": ""
},
"coordinates": {
"latitude": 55.6442,
"longitude": 37.63
},
"country": {
"name": "Россия",
"alpha2": "RU",
"alpha3": "RUS",
"numeric": 643
},
"timezone": "UTC+3"
}
]
}