Request format

apikeyapikey

Required parameter

The key issued in the Developer's Dashboard.

geocodegeocode

Required parameter

Address or coordinates of the object being searched for. The specified data determines the type of geocoding:

• If an address is specified, it is converted to object coordinates. This process is called forward geocoding.
• If coordinates are specified, they are converted to the object's address. This process is called reverse geocoding.

Several formats for entering coordinates are available.

langlang

Required parameter

Language of the response and regional settings of the map.

Record format lang=language_region, where:

• language — Two-letter language code. Specified in ISO 639-1 format. Sets the language for displaying the names of geographical features.
• region — Two-letter country code. Specified in ISO 3166-1 format. Determines regional settings.

List of supported values:

• ru_RU — Russian
• uk_UA — Ukrainian;
• be_BY — Belarusian
• en_RU — response in English, Russian map features;
• en_US — response in English, American map features;
• tr_TR — Turkish (only for maps of Türkiye).

If the parameter has a locale value that is not in this list, the service selects the language closest to the one set.

Example: lang=uk_UA.

scosco

Only if the geocode parameter sets the coordinates. Order of coordinates.

Possible values:

• longlat — Longitude, latitude.
• latlong — Latitude, longitude.

Default value: longlat.

kindkind

Only if the geocode parameter sets the coordinates. The type of required toponym. List of accepted values:

• house — house
• street — street
• metro — subway station
• district — city district
• locality — locality (city, town, village, etc.)

If omitted, the API will choose the toponym type automatically.

rspnrspn

Flag indicating whether the search scope should be restricted to the specified area. The area is defined by the ll and spn or bbox parameters. Possible values:

• 0 — Do not restrict search.
• 1 — Restrict search.

Default value: 0.

llll

Longitude and latitude of the center of the search area. The span of the search area is set in the spn parameter.

spnspn

The span of the search area. The center of the area is set in the ll parameter.
Set by two numbers:

• the first is the difference between the maximum and minimum longitude of the area;
• the second is the difference between the maximum and minimum latitude.

bboxbbox

An alternative method for setting the search area.

The borders are defined as the geographical coordinates of the lower-left and upper-right corners of the area (in the order "longitude, latitude").

Record format: bbox=x1,y1~x2,y2

Ignored if the geocode parameter sets the coordinates.

formatformat

Geocoder's response format — json

resultsresults

Maximum number of objects to be returned. If the skip parameter is set, its value must be set explicitly.

Default value: 10.

Maximum value: 50.

skipskip

The number of objects to skip in the response, starting from the first one. If this parameter is set, the results parameter must also be set. The value of the skip parameter must divide evenly by the value of the results parameter.
Default value: 0.

uriuri

Additional information about the object. The parameter value is returned in the Geosuggest response. To use it in a request, specify a value instead of text and coordinates.