This search is convenient because you don’t need to specify whether you are searching for a street, country, house, etc. One phrase with an arbitrary word order is enough for this search. This request returns results in the default format: the formatted address path, coordinates, and the map name. To get coordinates by specifying the address in any custom format, use the following request:
The required parameters are marked with an asterisk (*).
Name
Description
phrase*
Search phrase.
count*
Number of output results.
indexFrom
Sequence number of the first result.
uid
Current user ID. Deprecated, always use gis_sid.
gis_sid*
Unique ID of the user session.
search_provider*
Provider name. Possible values of search_provider are google, sygic, yandex, here, trimble.
flags
Search and format flags (see below).
searchFlags*
Additional search flags (see below).
lang
Language.
allow_irrelevant
1 - active, allow irrelevant result.
Search flags
Copied!
Flag
Description
0x100
Dump the path in the result.
0x200
Dump the map name in the result.
0x400
Dump the map coordinates in the result.
0x800
Do not create JSON. Return results as a list of objects.
Flags
Copied!
Flag
Description
0x0
Search country.
0x1
Search region.
0x2
Search city.
0x3
Search street.
0x4
Search house.
0x100
Add fields with a formatted address path to the result.
0x200
Add the map name to the result.
0x400
Add coordinates to the result.
Response
Copied!
Copied!
[
{
"items":[
{
"name":"<text>", /* name of the search item */"map":"<text>", /* map name */"x":<double>, /* longitude */"y":<double>, /* latitude */"path":"<text>", /* part of the address path, excluding the part placed in "name" */"formatted_path":"<text>"/* address string formatted according to the flags */
}
],
"country":"<text>", /* country */"region":"<text>", /* region */"city":"<text>", /* city */"street":"<text>", /* street */"house":"<text>", /* house */"flags":<uint>, /* flags */"more":<uint> /* additional results: 0 - no, 1 - yes */
}
]
The flags that show how detailed the result is:
Flag
Description
0x0
Country
0x1
Region
0x2
City
0x3
Street
0x4
House
Error codes
Copied!
Error code
Description
1
Invalid session.
4
Wrong input parameters.
6
Unknown error.
7
Access denied, unknown search provider.
If you find a mistake in the text, please select it and press Ctrl+Enter.