Swagger API Личный кабинет Центр поддержки
  • Languages English

POST Method of 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

Functionality #

  • clears incoming data from unnecessary characters to standardize the address
  • by part of the address displays a list of possible addresses, sorted by relevance

Method address #

http://5.188.130.172:8080/api/v1/address/suggest

Request parameters #

parameterdescription
queryString for hint and address parsing
countryCodeCountry code in which the address is searched, in ISO 3166 format (https://www.iso.org/iso-3166-country-codes.html)
countThe maximum number of addresses that are offered in the response

Request example #

curl --location --request POST 'http://5.188.130.172:8080/api/v1/address/suggest' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "москва варш",
    "countryCode": "RU",
    "count": 2
}'

Responce parameters #

sectionparameter(s)description
addressa string with a parsed and standardized address
postcodecountry code in which the address is searched, in ISO 3166 format (https://www.iso.org/iso-3166-country-codes.html)
cityAreathe maximum number of addresses that are offered in the response
regionSee the description of the addressLevel structureregion
areaSee the description of the addressLevel structurearea
citySee the description of the addressLevel structurecity
settlementSee the description of the addressLevel structurelocality
planStructureSee the description of the addressLevel structureplanning structure of the (district).
streetSee the description of the addressLevel structurestreet
houseDetailsSee the description of the houseDetails structurethe house part of the address.
coordinatesSee the description of the coordinates structurecoordinates
countrySee the description of the country structurecountry

ADDRESSLEVEL structure description #

parameterdescription
fullNameName and type of the address element
nameName of the address element
typeThe type of the address element
codesThe string to parse address

HOUSEDETAILS structure description #

parameterdescription
househouse
casehousing
buildbuild
literliter
vladownership
blockblock
pomspace
pavpavilion
uchland plot
obschdorm
komroom
flatflat
officeoffice
kabcabinet

COORDINATES structure description #

parameterdescription
latitudelatitude
longitudelongitude

COUNTRY structure description #

parameterdescription
nameName of the country
alpha2Country code, in ISO 3166-1 alpha-2 format
alpha3The country code in the ISO 3166-1 alpha-3
numericThe country code in the ISO 3166-1 numeric

Responce example #

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214

{
  "suggestions": [
    {
      "address": "г Москва,Варшавское ш",
      "postcode": "115127",
      "region": {
        "fullName": "Москва г",
        "name": "Москва",
        "type": "г",
        "codes": {
          "fias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
          "ga": "",
          "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": "8fc06b0b-5de3-4a72-9e6f-9e0647a37a66",
          "ga": "",
          "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": "",
        "numeric": 0
      }
    },
    {
      "address": "г Москва,Варшавский 1-й проезд",
      "postcode": "115201",
      "region": {
        "fullName": "Москва г",
        "name": "Москва",
        "type": "г",
        "codes": {
          "fias": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
          "ga": "",
          "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": "проезд Варшавский 1-й",
        "name": "Варшавский 1-й",
        "type": "проезд",
        "codes": {
          "fias": "09ffd474-1ca8-42e1-8217-876300fd7c2c",
          "ga": "",
          "osm": ""
        }
      },
      "houseDetails": {
        "fullName": "",
        "floor": "",
        "house": "",
        "case": "",
        "build": "",
        "liter": "",
        "lend": "",
        "block": "",
        "pav": "",
        "flat": "",
        "office": "",
        "kab": "",
        "abon": "",
        "plot": "",
        "sek": "",
        "entr": "",
        "room": "",
        "hostel": "",
        "munit": ""
      },
      "coordinates": {
        "latitude": 55.6501,
        "longitude": 37.6264
      },
      "country": {
        "name": "Россия",
        "alpha2": "RU",
        "alpha3": "",
        "numeric": 0
      }
    }
  ]
}