Geocoding. /3.0/items/geocode
Catalog of objects (3.0)
Geocoding
Performs geocoding based on the specified query and shows a paginated list of results.
query Parameters
key required | string Unique key of API user. |
locale | string Examples:
The locale from which the search is performed and the results are given.
|
q | string [ 1 .. 500 ] characters An arbitrary search string. |
type | Array of strings Examples:
The types of geo-objects among which the search is performed. When passing several types, less relevant results of some types may be crowded out by more relevant other types. Types should be comma separated. The adm_div value is an alias for all The list of available types:
|
fields | Array of strings Examples:
Additional fields to be displayed in the response should be separated by commas. Fields labeled
The list of fields with additional information on the place:
The list of command boxes:
|
search_type | string Default: "discovery" Type of search.
|
search_is_query_text_complete | boolean Specifying to the search engine that the request is complete (the user has pressed the completion button). Disables the prefix, i.e. "bank" will not be searched "banking". |
search_nearby | boolean Specifying the search engine to use search mode near the user. Greatly increases the importance of distance from the user. Popularity, advertising and other parameters are still involved in the ranking, but to a lesser extent. |
search_input_method | string Specifying the method for entering the query text to the search engine:
|
sort | string Default: "relevance" Sorting of results. Valid values:
|
sort_point | string Deprecated Examples:
The coordinates of the point from which you are sorting (the coordinates of the point in the |
location | string Examples:
User coordinates in the format |
lon | string Examples:
Longitude of the point - center of the search area. |
lat | string Examples:
Latitude of the point — center of the search area. |
point | string Examples:
A center of the search area (point coordinates in the |
radius | integer >= 0 Default: 250 Search radius in meters. |
district_id | Array of integers Examples:
The IDs of the districts, separated by commas. They are used to filter objects by district. |
building_id | Array of integers Examples:
The IDs of the buildings, separated by commas. They are used to filter objects in a building. |
city_id | Array of integers Examples:
The IDs of the cities separated by commas. They are used to filter objects by cities. |
subway | Array of integers Examples:
The IDs of the metro stations separated by commas. They are used to filter objects by metro stations. |
point1 | string Examples:
The coordinates of the upper left vertex of a rectangular area limiting the search results in the |
point2 | string Examples:
The coordinates of the lower right vertex of a rectangular area limiting the search results in the |
polygon | string Examples:
Polygon in WKT format. |
viewpoint1 | string Examples:
The coordinates of the upper left vertex of a rectangular visibility scope, in the |
viewpoint2 | string Examples:
The coordinates of the lower right vertex of a rectangular visibility scope, in the |
region_id | integer Region identifier. It is required if a geographical limit of search has not been specified. Details about the territorial division of the map into regions can be found in the description of the Regions API. |
page | integer [ 1 .. 1000000 ] Default: 1 The number of the requested page. |
page_size | integer [ 1 .. 50 ] Default: 20 Number of search results displayed on one page. |
rubric_id | Array of integers Examples:
The ID of the category. You need to pass the option |
org_id | integer Filter by the ID of the organization to which the company belongs. |
has_photos | boolean Filter by availability of photos. Takes the true or false values. |
has_rating | boolean Filter by availability of rating on flamp.ru. Takes the true or false values. |
has_reviews | boolean Filter by availability of reviews on flamp.ru. Takes the true or false values. |
has_site | boolean Filter by availability of website. Takes the true or false values. |
work_time | string Examples:
Opening hours of the company. Format: [day],[time] or now (current day and time).
|
opened_after_date | string <date> Examples:
Filters companies which have the opening date later than the passed parameter. |
has_itin | boolean Filter by availability of the individual taxpayer identification number. It takes the true or false values. |
has_trade_license | boolean Filter by availability of the trading license. Takes the true or false values. |
Responses
Response Schema: application/json
required | object (ObjMeta) Response metadata |
required | object Main result |
Response samples
- 200
- 400
- 403
- 404
- 408
- 500
{- "meta": {
- "issue_date": "string",
- "code": 200,
- "api_version": "dev"
}, - "result": {
- "total": 1,
- "items": [
- {
- "id": "141265769336625_f91d4H3777058262347790J0e8g28765",
- "type": "branch",
- "region_id": "123456",
- "segment_id": "123456",
- "parking": {
- "payment_link": "string"
}, - "delivery": [
- {
- "phone": "+7123456789"
}
], - "rubrics": [
- {
- "id": "123456",
- "parent_id": "123456",
- "kind": "string",
- "name": "string",
- "alias": "string"
}
], - "building_name": "string",
- "is_routing_available": true,
- "trade_license": {
- "type": "string",
- "type_description": "string",
- "director_name": "string",
- "license": "string",
- "start_date": "string",
- "end_date": "string",
- "legal_form": "string"
}, - "schedule": {
- "Mon": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "Sat": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "Wed": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "date_from": "string",
- "description": "string",
- "Fri": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "Thu": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "date_to": "string",
- "Tue": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "Sun": {
- "working_hours": [
- {
- "from": "09:00",
- "to": "17:00"
}
]
}, - "is_24x7": true,
- "comment": "Open 24h on holidays"
}, - "floors": {
- "underground_count": 1,
- "ground_min_count": 1,
- "ground_count": 1
}, - "purpose_name": "string",
- "address_name": "Dimitrov Avenue, 7",
- "stop_factors": [
- {
- "type": "attribute",
- "name": "Laundry",
- "tag": "hotel_details_laundry"
}
], - "order_with_cart": [
- {
- "phone": "+7123456789"
}
], - "city_alias": "novosibirsk",
- "itin": "1234567890",
- "ski_lift": {
- "type": 0,
- "status": 0
}, - "floor_id": "141832714658709",
- "links": {
- "bus_terminals": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "additional_info": "Krasnyy Prospekt, 4",
- "name": "Bus station, Novosibirsk"
}
]
}, - "branches": {
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "contacts": [
- {
- "type": null,
- "value": null,
- "text": null,
- "print_text": null,
- "comment": null,
- "url": null
}
], - "org_id": "string",
- "name": "string",
- "additional_info": "string"
}
], - "count": 1,
- "allowed_for_reviews_count": 0
}, - "landmarks": [
- {
- "id": "123456",
- "type": "station_platform",
- "distance": 0,
- "azimuth": 360,
- "subtype": "string",
- "station_id": "123456",
- "name": "string",
- "entrance_display_name": "string"
}
], - "providers": {
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "contacts": [
- {
- "type": null,
- "value": null,
- "text": null,
- "print_text": null,
- "comment": null,
- "url": null
}
], - "org_id": "string",
- "name": "string",
- "additional_info": "string"
}
], - "count": 1,
- "allowed_for_reviews_count": 0
}, - "seaports": {
- "items": [
- {
- "id": "123456",
- "name": "Marine passenger terminal",
- "additional_info": "Marine Glory square, 1"
}
], - "count": 0
}, - "servicing": {
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "contacts": [
- {
- "type": null,
- "value": null,
- "text": null,
- "print_text": null,
- "comment": null,
- "url": null
}
], - "org_id": "string",
- "name": "string",
- "additional_info": "string"
}
], - "count": 1,
- "allowed_for_reviews_count": 0
}, - "database_entrances": [
- {
- "id": "123456",
- "entity_name": "string",
- "relative_geometry": {
- "direction": 0,
- "dx": 0,
- "dy": 0
}, - "entrance_display_name": "string",
- "comment": "string",
- "geometry": {
- "points": [
- "string"
], - "vectors": [
- "string"
], - "normals": [
- "string"
]
}, - "is_primary": true,
- "name": "string",
- "apartments_info": {
- "calculated": true,
- "floors": [
- {
- "apartments": null,
- "name": null
}
]
}, - "entity_number": "string",
- "is_visible_on_map": true,
- "is_visible_in_ui": true,
- "has_poi": true,
- "building_number": "string"
}
], - "entrances": [
- {
- "id": "123456",
- "comment": "string",
- "entity_name": "string",
- "entrance_display_name": "string",
- "is_primary": true,
- "is_visible_in_ui": true,
- "geometry": {
- "points": [
- "string"
], - "vectors": [
- "string"
], - "normals": [
- "string"
]
}, - "entity_number": "string",
- "is_visible_on_map": true
}
], - "river_ports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Moscow North river terminal",
- "additional_info": "Leningrad highway, 51"
}
]
}, - "parking": [
- {
- "id": "123456",
- "purpose": "string",
- "capacity": "string",
- "is_paid": true,
- "comment": "50 rub per hour, first 2 hours free.",
- "name": "Underground Parking, Sun City"
}
], - "nearest_platforms": [
- {
- "id": "123456",
- "transition_type": "string",
- "heading_to": "Nakhabino",
- "name": "Krasniy Prospekt metro station",
- "comment": "Leninskaya line",
- "color": "#D10000",
- "route_logo": "string",
- "route_types": [
- "string"
]
}
], - "nearest_stations": [
- {
- "id": "123456",
- "route_types": [
- "string"
], - "route_logo": "string",
- "distance": 0,
- "internal_transition": true,
- "entrance": {
- "id": "123456",
- "name": "string",
- "entrance_display_name": "string",
- "geometry": {
- "centroid": "POINT(83.306820839303 54.6230101954005)",
- "hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
- "selection": "POINT(83.306820839303 54.6230101954005)"
}
}, - "name": "Krasniy Prospekt metro station",
- "color": "#D10000",
- "comment": "Leninskaya line"
}
], - "nearest_parking": [
- {
- "id": "123456"
}
], - "airports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Tolmachevo airport",
- "additional_info": "Airport, Ob-4"
}
]
}, - "railway_terminals": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Novosibirsk-Western, railway station",
- "additional_info": "Shirokaya Street, 26a"
}
]
}, - "nearest_metro": [
- {
- "id": "123456",
- "distance": 500
}
], - "attractions": [
- {
- "id": "123456",
- "subtype_name": "Fountain",
- "name": "Fountain in Narymsky public garden",
- "authors": "string",
- "dates": "string",
- "description": "string"
}
], - "hotels": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Aquarius, Motel",
- "additional_info": "Mira St, 18a bld1"
}
]
}
}, - "locale": "ru_RU",
- "full_name": "string",
- "address_comment": "office 413",
- "dates": {
- "created_at": "2012-04-18T12:08:03.273144+07:00",
- "updated_at": "2012-06-18T11:43:03.273144+07:00",
- "deleted_at": "2013-06-01T11:43:03.273144+07:00"
}, - "contact_groups": [
- {
- "schedule": {
- "Mon": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "Sat": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "Wed": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "date_from": "string",
- "description": "string",
- "Fri": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "Thu": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "date_to": "string",
- "Tue": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "Sun": {
- "working_hours": [
- {
- "from": null,
- "to": null
}
]
}, - "is_24x7": true,
- "comment": "Open 24h on holidays"
}, - "contacts": [
- {
- "type": "phone",
- "value": "Phone number in international format",
- "text": "Ivanov's e-mail",
- "print_text": "Ivanov's e-mail",
- "comment": "for business correspondence",
- "url": "string"
}
], - "name": "Service center",
- "comment": "Multichannel phone number"
}
], - "description": "string",
- "name": "the Sunny cafe",
- "context": {
- "servicing_group": "string",
- "servicing_groups": [
- "string"
], - "distance": "3483",
- "is_in_bound": "true",
- "stop_factors": [
- {
- "type": "attribute",
- "name": "Laundry",
- "tag": "hotel_details_laundry"
}
]
}, - "point": "54.991984,82.901886",
- "has_apartments_info": true,
- "address": {
- "components": [
- {
- "type": "street_number",
- "street": "Krasnyy Prospekt",
- "number": "21/2, bld 7",
- "fias_code": "dcb1bc1b-2324-449a-8b68-03e49ba1f541",
- "okato": "35",
- "oktmo": "35",
- "street_id": "123456"
}
], - "building_id": "20498230958",
- "postcode": "630007",
- "building_code": "string",
- "building_name": "Sun City",
- "landmark_name": "Zaryadye (a park in Moscow)",
- "makani": "27116 87099"
}, - "reviews": {
- "general_review_count_with_stars": 0,
- "general_review_count": 0,
- "recommendation_count": "12",
- "review_count": "32",
- "is_reviewable": true,
- "general_rating": "4.73",
- "org_review_count_with_stars": 0,
- "rating": "4.73",
- "org_rating": "4.73",
- "items": [
- {
- "review_count": 0,
- "recommendation_count": 0,
- "tag": "string",
- "is_reviewable": true,
- "rating": 5
}
], - "org_review_count": 0,
- "is_org_reviews": true
}, - "floor_plans": {
- "plans": [
- {
- "id": "123456",
- "name": "string"
}
], - "default_plan_id": "123456"
}, - "structure_info": {
- "porch_count": 0,
- "floor_type": "string",
- "is_in_emergency_state": true,
- "project_type": "string",
- "gas_type": "string",
- "elevators_count": 0,
- "apartments_count": 0,
- "chs_name": "string",
- "chs_category": "string",
- "year_of_construction": 0,
- "material": "string"
}, - "marker_alt": 0,
- "alias": "shintop_set_avtomarketov",
- "adm_div": [
- {
- "id": "123456",
- "type": "city",
- "caption": "string",
- "name": "Ust-Kamenogorsk",
- "is_default": true,
- "flags": {
- "photos": true,
- "is_default": true,
- "is_region_center": true,
- "is_district_area_center": true,
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "value": "string",
- "name": "string"
}
], - "has_model": { }
}, - "city_alias": "novosibirsk",
- "detailed_subtype": "poselok"
}
], - "name_ex": {
- "extension": "cafe",
- "legal_name": "LLC Sunny",
- "addition": "string",
- "description": "Warehouse",
- "short_name": "Sunny",
- "primary": "Sunny"
}, - "is_deleted": true,
- "sources": [
- "string"
], - "geometry": {
- "centroid": "POINT(83.306820839303 54.6230101954005)",
- "hover": "POLYGON((36.193851601974 51.7466070840044,36.1943391434488 51.7466070840044,36.1943391434488 51.7474670961949,36.193851601974 51.7474670961949,36.193851601974 51.7466070840044))",
- "selection": "POINT(83.306820839303 54.6230101954005)"
}, - "org": {
- "id": "123456",
- "name": "string",
- "branch_count": "7"
}, - "flags": {
- "photos": true,
- "is_default": true,
- "is_region_center": true,
- "is_district_area_center": true,
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "value": "string",
- "name": "string"
}
], - "has_model": { }
}, - "timezone_offset": 420,
- "full_address_name": "Novosibirsk, Dimitrov Avenue, 7",
- "external_content": [
- {
- "type": "discount",
- "value": "shintop",
- "label": "Open",
}
], - "employees_org_count": "up to 15",
- "search_attributes": {
- "suggest_parts": [
- {
- "text": "string",
- "is_suggested": true
}
], - "suggested_text": "string"
}, - "attribute_groups": [
- {
- "attributes": [
- {
- "id": "123456",
- "tag": "hotel_room_internet",
- "name": "Free Internet in the rooms",
- "icon_url": "string"
}
], - "icon_url": "string",
- "name": "Hotel",
- "is_context": true,
- "is_primary": true,
- "rubric_ids": [
- "123456"
]
}
], - "ev_charging_station": {
- "aggregate": {
- "is_busy": true,
- "connectors_free": 0,
- "connectors_total": 0,
- "power": 0,
- "is_active": true
}, - "connectors": [
- {
- "type": "string",
- "power": 0,
- "price": 0,
- "status": 0
}
]
}
}
], - "context_rubrics": [
- {
- "id": "string",
- "name": "string",
- "group": 0,
- "caption": "string"
}
], - "search_attributes": {
- "is_remote_requested": true,
- "out_viewport": [
- {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}, - {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}, - {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}, - {
- "latitude": 55.97851125831795,
- "longitude": 29.13375591576512
}
], - "drag_bound": [
- {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}
], - "is_nearby_requested": true,
- "is_partial": true
}
}
}