Search for businesses

The API returns a list of organizations that best match the query. For example, for the query "pharmacies in Moscow", the list of results will not show all pharmacies in the city, but the ones that the API considers the best matches.

The example below shows a request and the format of the response from the service.

Request

https://search-maps.yandex.ru/v1/?text=Auto repair, Moscow, 2nd Vyazovskiy proezd 4a&type=biz&lang=en_US&results=1&apikey=<API key>

Response format

Attention. We only guarantee support for the fields that are described in the example below. We do not recommend using other fields that are found in the response but are not covered in the documentation. Such fields might not be supported in the future.
{
  "type": "FeatureCollection",
  "properties": {
    "ResponseMetaData": {
      "SearchRequest": {
        "request": "Auto repair, Moscow, 2nd Vyazovskiy proezd 4a",
        "results": 1,
        "skip": 0,
        "boundedBy": [
          [
            37.04842675, 
            55.43644829
          ],
          [
            38.17590226,
            56.04690124
          ]
        ]
      },
      "SearchResponse": {
        "found": 36,
        "boundedBy": [
          [
            37.76257841,
            55.71649343
          ],
          [
            37.76644117, 
            55.72008348 
          ]
        ],
        "display": "multiple"
      }
    }
  },
  "features": [
    {
      "type": "Feature",
      "properties": {
        "CompanyMetaData": {
          "id": "1186386819",
          "name": "Auto repair 24 hours",
          "address": "Russia, Moscow, 2nd Vyazovskiy proezd 4a 5",
          "url": "http://автосервис-ювао.рф/",
          "Categories": [
            {
              "class": "auto repair",
              "name": "Auto repair, auto shop"
            }, {
              "class": "tire fitting",
              "name": "Tire service"
            }, {
              "class": "car wash",
              "name": "Car wash"
            }
          ],
          "Phones": [
            {
              "type": "phone",
              "formatted": "+7 (495) 778-44-45"
            }, {
              "type": "phone",
              "formatted": "+7 (499) 372-00-60",
            }
          ],
          "Hours": {
            "Availabilities": [
              {
                "Everyday": true,
                "TwentyFourHours": true
              }
            ],
            "text": "24 hours, every day",
          }
        },  
        "description": "Russia, Moscow, 2nd Vyazovskiy proezd 4a building 5",
        "name": "24-hour auto shop",
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          37.764661,
          55.719081
        ]
      }
    }
  ]
}  
type *
Always has the value FeatureCollection. This ensures compatibility (partially) with GeoJSON format.

Required field.

properties
Container for metadata describing the request and response.
ResponseMetaData *
Metadata describing the request and response. Required field.
SearchRequest *
Metadata describing the request. Required field.
request *
Request string. Required field.
results
Maximum number of results to be returned.
skip
Number of results to skip.
boundedBy

Boundaries of the area that the objects to search for are presumably located in. Boundaries are set as the coordinates of the upper-left and lower-right corners of the area. Coordinates are set in the order “longitude, latitude”.

The boundaries of the area are automatically defined by the service.

SearchResponse *

Metadata describing the response. Required field.

found *
The number of objects found. Required field.
boundedBy

Boundaries of the viewport for found objects. Contains the coordinates of the lower-left and upper-right corners of the area. Coordinates are set in the order “longitude, latitude”.

display

Recommendations for displaying search results. Possible values:

  • “single” — Recommends displaying only the first object found.
  • “multiple” — Recommends displaying all found objects.
features *
Container for search results. Required field.
type *

Always has the value Feature. This ensures compatibility (partially) with GeoJSON format.

Required field.

properties *
Information about the found object. Required field.
CompanyMetaData

Contains information about a particular business: the address, contact information, business hours, type of business, and so on.

id *

Business ID. Required field.

name *
Name of the business. Required field.
address

Address of the business.

url
Website of the business.
Categories
A list of categories that the business belongs in (for example, hair salon, hotel, or store).
class
Class of the category.
name *
Name of the category. Required field.
Phones
A list of the phone numbers and other contact information for the business.
type
Type of contact information (for example, phone or fax).
formatted *
The full telephone number (or fax) with the country code and area or city code. Required field.
Hours
The business hours.
Availabilities
Description of the hours. May contain fields:
  • Weekdays|Weekend|Everyday|Sunday|Monday — Business days.
  • TwentyFourHours|Intervals — Business hours.
Everyday

The business is open every day.

TwentyFourHours
The business is open 24 hours a day.
text *
Description of the business hours as any text. Required field.
description
Text that is recommended to set as a subheader when displaying the found business.
name

Text that is recommended to set as the title when displaying the found business.

geometry *

Description of the found object's geometry. Required field.

type *
Geometry type. Required field.
coordinates *

Coordinates of the business in the sequence “longitude, latitude”. Required field.

Required