Response format

https://suggest-maps.yandex.ru/v1/suggest?apikey=YOUR_API_KEY&text=burj&print_address=1&attrs=uri

In this case, the geosuggest response will look like this:

{
  "results": [
    {
      "title": {
        "text": "Burj Khalifa, Zaabeel, Dubai",
        "hl": [{
          "begin": 0,
          "end": 10
        },
        {
          "begin": 18,
          "end": 20
        }]
      },
      "subtitle": {
        "text": "Dubai"
      },
      "tags": [
        "house"
      ],
      "distance": {
        "text": "7141.91 km",
        "value": 7141908.95
      },
      "address": {
        "formatted_address": "Burj Khalifa, Zaabeel, Dubai",
        "component": [
          {
            "name": "United Arab Emirates",
            "kind": [
              "COUNTRY"
            ]
          },
          {
            "name": "Emirate Dubai",
            "kind": [
              "PROVINCE"
            ]
          },
          {
            "name": "Dubai",
            "kind": [
              "PROVINCE"
            ]
          },
          {
            "name": "Dubai",
            "kind": [
              "LOCALITY"
            ]
          },
          {
            "name": "Zaabeel",
            "kind": [
              "STREET"
            ]
          },
          {
            "name": "1",
            "kind": [
              "HOUSE"
            ]
          }
        ]
      },
      "uri": "ymapsbm1://geo?data=Cgg1MzA2MzU1OBIy0JzQvtGB0LrQvtCy0YHQutCw0Y8g0L7QsdC70LDRgdGC0YwsINCc0YvRgtC40YnQuCA,"
    }
  ]
}

Response parametersResponse parameters

results

Request results in the form of an array of objects. If nothing was found, the parameter may be omitted.

title

Object name.

text

Object name.

hl

Highlights the fragment of the text string in the interface that matches the user request.

begin

Start of the range of symbol indexes in the text string for highlighting.

end

Start of the range of symbol indexes in the text string for highlighting.

Indexes are specified as numbers of the UTF-16 encoded 16-bit code units in the string.

subtitle

Additional object name.

text

Object name.

hl

Highlights the fragment of the text string in the interface that matches the user request.

tags

Object type:

• companies from Business Directory use the business tag

  Additional tags related to the company's business type

  • airport terminal
  • airports
  • animation
  • attraction
  • auto
  • baggage room
  • banks
  • bars
  • beach
  • bench
  • bike
  • bike rent
  • boat station
  • buddhism
  • bus station
  • bus stop
  • cableway
  • cafe
  • car park
  • catholic church
  • catholic church
  • cemetery
  • childrens playground
  • christmastree
  • cinemas
  • clothes shop
  • college
  • concert hall
  • confectionary
  • currency exchange
  • dance pavilion
  • dental
  • drugstores
  • dry cleaning
  • emergency point tr
  • fallback fun
  • fallback outdoor
  • fallback services
  • fast food
  • festival
  • fire station
  • fireworks launching
  • fitness
  • flower shop
  • forest
  • fountain
  • furniture store
  • garden
  • gasstation
  • government
  • hairdressers
  • haulier
  • helicopter
  • highspeed tram stop
  • hotels
  • hypermarket
  • industrial enterprise
  • information
  • information desk
  • landmark
  • laundry
  • malls
  • medicine
  • memorable event
  • metro
  • monument
  • mosque
  • mountain
  • office
  • office service
  • orthodox church
  • park
  • pet playground
  • petshop
  • photo
  • picnic
  • pier
  • playground
  • police
  • police post
  • port
  • post office
  • protestant church
  • racing
  • railway station
  • railway terminal
  • restaurants
  • rezervation
  • sanatorium
  • scene
  • security post
  • skating rink
  • software
  • spa
  • sportcenter
  • spring
  • stadium
  • stenograffia
  • supermarket
  • sushi
  • swimming pool
  • synagogue
  • tailor
  • taxi
  • theatre
  • tire fitting
  • trade point
  • tram stop
  • trash
  • travel agency
  • tribune
  • viewpoint
  • waterfall
  • waterpark
  • wc
  • yandex shop
  • zoo

• geographical objects use different tags

  tags for toponym

  • street
  • metro
  • district
  • locality
  • area
  • province
  • country
  • hydro
  • railway
  • station
  • route
  • vegetation
  • airport
  • other
  • house

distance

Distance to the object in meters.

• Calculated based on user coordinates indicated in the request
• Or the center of the search window if user coordinates are not set

text

Localized representation

value

Distance in meters.

address

Object's address.

formatted_address

Object's address.

component

Address components.

name

Address component name.

kind

Address component type. Two components with the same kindparameter values but different namevalues may be returned.

Possible values

• country — country
• region — region
• province — province
• area — regional district
• locality — locality
• district — district, microdistrict, village
• street — street
• house — house
• hydro — river, lake, reservoir, etc.
• station — public transport stop
• metro_station — metro station
• railway_station — railway station
• route — metro line, highway, railway line
• vegetation — forest, park, garden, etc.
• airport — airport
• other — other
• entrance — entrance
• level — floor
• apartment — apartment
• unknown — none of the above

uri

Additional information about the object that can be used in a request to the Geocoder API — to do this, specify the value of the uri parameter instead of text and coordinates.

Error messagesError messages