Request format
The service is accessed using a GET request to the address https://search-maps.yandex.ru/v1/. Required request parameters are text, lang, and apikey.
In the response, the server returns the found objects sorted by relevance to the query. A maximum of 500 objects can be retrieved per search query.
https://search-maps.yandex.ru/v1/
? [apikey=<key>]
& [text=<search query>]
& [type=<object types>]
& [lang=<response language>]
& [ll=<search area center>]
& [spn=<search area size>]
& [bbox=<search area coordinates>]
& [rspn=<do not search outside the search area>]
& [results=<number of results in the response>]
& [skip=<number of results to skip>]
& [callback=<function name>]apikey | The key for accessing the service. You can get and manage keys in the Developer's Dashboard. |
text | Text of the search query. For example, the name of a geographical feature, address, coordinates, business name, or phone number. Examples (without URL encoding):
|
type | Types of results returned. Possible values:
Example:
|
lang | Preferred response language. Set as the locale ID in the format lang=language_region, where
Supported values:
If the parameter has a locale value that is not in this list, the service selects the language closest to the one set. Example: |
ll | The center of the search area. Defined by the longitude and latitude, separated by a comma. The longitude and latitude are indicated in degrees, represented as decimals. It is used together with the spn parameter, which defines the size of the search area. It is ignored during reverse geocoding. Example: |
spn | The size of the search area. Defined using the span of the longitude and latitude, separated by a comma. The spans are indicated in degrees, represented as decimals. It is used together with the ll parameter, which defines the center of the search area. It is ignored during reverse geocoding. Example: |
bbox | An alternative method for setting the search area (see The borders of the search area are defined as the geographical coordinates of the lower-left and upper-right corners of the area (in the order "longitude, latitutude"). Note. If bboxand ll+spn are both set at the same time, the bbox parameter takes priority.Example: |
rspn | Indicates “strict” restriction of the search area. If nothing was found in the search area (set using the ll + spn or bbox parameters), the service tries to find results outside of it. You can use the Possible values:
|
results | The number of objects to return. By default, 10. The maximum value is 500. Example: |
skip | The number of objects to skip in the response (starting from the first one). The maximum value is 1000. Example: |
callback | The name of the JavaScript function to pass the response to (by JSONP convention). Example: |
apikey | The key for accessing the service. You can get and manage keys in the Developer's Dashboard. |
text | Text of the search query. For example, the name of a geographical feature, address, coordinates, business name, or phone number. Examples (without URL encoding):
|
type | Types of results returned. Possible values:
Example:
|
lang | Preferred response language. Set as the locale ID in the format lang=language_region, where
Supported values:
If the parameter has a locale value that is not in this list, the service selects the language closest to the one set. Example: |
ll | The center of the search area. Defined by the longitude and latitude, separated by a comma. The longitude and latitude are indicated in degrees, represented as decimals. It is used together with the spn parameter, which defines the size of the search area. It is ignored during reverse geocoding. Example: |
spn | The size of the search area. Defined using the span of the longitude and latitude, separated by a comma. The spans are indicated in degrees, represented as decimals. It is used together with the ll parameter, which defines the center of the search area. It is ignored during reverse geocoding. Example: |
bbox | An alternative method for setting the search area (see The borders of the search area are defined as the geographical coordinates of the lower-left and upper-right corners of the area (in the order "longitude, latitutude"). Note. If bboxand ll+spn are both set at the same time, the bbox parameter takes priority.Example: |
rspn | Indicates “strict” restriction of the search area. If nothing was found in the search area (set using the ll + spn or bbox parameters), the service tries to find results outside of it. You can use the Possible values:
|
results | The number of objects to return. By default, 10. The maximum value is 500. Example: |
skip | The number of objects to skip in the response (starting from the first one). The maximum value is 1000. Example: |
callback | The name of the JavaScript function to pass the response to (by JSONP convention). Example: |