Геокодирование. /3.0/items/geocode
Каталог объектов (3.0)
Геокодинг
Осуществляет геокодирование по заданному запросу и выдаёт список результатов, разбитых на страницы.
query Parameters
key required | string Уникальный ключ пользователя API. |
locale | string Examples:
Локаль, с которой производится поиск и отдаются результаты.
|
q | string [ 1 .. 500 ] characters Произвольная поисковая строка. |
type | Array of strings Examples:
Типы гео-объектов, среди которых производится поиск. При передаче нескольких типов менее релевантные результаты одних типов могут вытесниться более релевантными других типов. Типы перечисляются через запятую. Значение Список доступных типов:
|
fields | Array of strings Examples:
Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую. Поля с пометкой
Список полей с дополнительной информацией о месте:
Список служебных полей:
|
search_type | string Default: "discovery" Тип производимого поиска.
|
search_is_query_text_complete | boolean Указание поисковому движку, что запрос является законченным (пользователь нажал на кнопку заверешения ввода). Отключает префиксность, т.е. по "банк" не будет находиться "банкомат". |
search_nearby | boolean Указание поисковому движку использовать режима поиска рядом с пользователем. Сильно повышает значимость расстояния от пользователя. В ранжирование всё ещё участвует популярность, реклама и другие параметры, но в меньшей степени. |
search_input_method | string Указание поисковому движку способа ввода текста запроса:
|
sort | string Default: "relevance" Сортировка результатов. Допустимые значения:
|
sort_point | string Deprecated Examples:
Координаты точки, от которой производится сортировка (координаты точки в формате |
location | string Examples:
Координаты пользователя в формате |
lon | string Examples:
Долгота точки — центра области поиска. |
lat | string Examples:
Широта точки — центра области поиска. |
point | string Examples:
Центр области поиска (координаты точки в формате |
radius | integer >= 0 Default: 250 Радиус поиска в метрах. |
district_id | Array of integers Examples:
Идентификаторы районов, разделённые запятыми. Используется для фильтрации объектов по району. |
building_id | Array of integers Examples:
Идентификаторы зданий, разделённые запятыми. Используется для фильтрации объектов в здании. |
city_id | Array of integers Examples:
Идентификаторы городов, разделённые запятыми. Используется для фильтрации объектов по городу. |
subway | Array of integers Examples:
Идентификаторы станций метро, разделённые запятыми. Используется для фильтрации объектов по станциям метро. |
point1 | string Examples:
Координаты левой верхней вершины прямоугольной области в формате |
point2 | string Examples:
Координаты правой нижней вершины прямоугольной области в формате |
polygon | string Examples:
Полигон в формате WKT. |
viewpoint1 | string Examples:
Координаты левой верхней вершины прямоугольной области видимости в формате |
viewpoint2 | string Examples:
Координаты правой нижней вершины прямоугольной области видимости в формате |
region_id | integer Идентификатор региона. Обязателен, если не задано географическое ограничение поиска. Подробности про территориальное деление карты на регионы можно посмотреть в описании Regions API. |
page | integer [ 1 .. 1000000 ] Default: 1 Номер запрашиваемой страницы. |
page_size | integer [ 1 .. 50 ] Default: 20 Количество результатов поиска, выводимых на одной странице. |
rubric_id | Array of integers Examples:
Идентификатор категории. Необходимо передать параметр |
org_id | integer Фильтр по идентификатору организации, к которой относится компания. |
has_photos | boolean Фильтр по наличию фотографий. Принимает значения: true или false. |
has_rating | boolean Фильтр по наличию рейтинга на flamp.ru. Принимает значения: true или false. |
has_reviews | boolean Фильтр по наличию отзывов на flamp.ru. Принимает значения: true или false. |
has_site | boolean Фильтр по наличию сайта. Принимает значения: true или false. |
work_time | string Examples:
Время работы организации. Формат: [day],[time] или now (текущий день и время).
|
opened_after_date | string <date> Examples:
Фильтрует компании у которых дата открытия позже чем переданный параметр. |
has_itin | boolean Фильтр по наличию индивидуального номера налогоплательщика. Принимает значения: true или false. |
has_trade_license | boolean Фильтр по наличию торговой лицензии. Принимает значения true или false. |
Responses
Response Schema: application/json
required | object (ObjMeta) Метаданные ответа |
required | object Основной результат |
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": "Кругосуточно в праздничные дни"
}, - "floors": {
- "underground_count": 1,
- "ground_min_count": 1,
- "ground_count": 1
}, - "purpose_name": "string",
- "address_name": "Димитрова проспект, 7",
- "stop_factors": [
- {
- "type": "attribute",
- "name": "Прачечная",
- "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": "Красный проспект, 4",
- "name": "Автовокзал, г. Новосибирск"
}
]
}, - "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": "Морской вокзал",
- "additional_info": "Морской Славы площадь, 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": "Московский Северный речной вокзал",
- "additional_info": "Ленинградское шоссе, 51"
}
]
}, - "parking": [
- {
- "id": "123456",
- "purpose": "string",
- "capacity": "string",
- "is_paid": true,
- "comment": "50 р. в час, первые 2 часа бесплатно.",
- "name": "Подземная парковка Сан Сити"
}
], - "nearest_platforms": [
- {
- "id": "123456",
- "transition_type": "string",
- "heading_to": "Нахабино",
- "name": "Метро Красный проспект",
- "comment": "Ленинская линия",
- "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": "Метро Красный проспект",
- "color": "#D10000",
- "comment": "Ленинская линия"
}
], - "nearest_parking": [
- {
- "id": "123456"
}
], - "airports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Толмачёво, аэропорт",
- "additional_info": "Аэропорт, Обь-4"
}
]
}, - "railway_terminals": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Новосибирск-Западный, железнодорожный вокзал",
- "additional_info": "Широкая, 26а"
}
]
}, - "nearest_metro": [
- {
- "id": "123456",
- "distance": 500
}
], - "attractions": [
- {
- "id": "123456",
- "subtype_name": "Фонтан",
- "name": "Фонтан в Нарымском сквере",
- "authors": "string",
- "dates": "string",
- "description": "string"
}
], - "hotels": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Водолей, мотель",
- "additional_info": "Мира, 18а к1"
}
]
}
}, - "locale": "ru_RU",
- "full_name": "string",
- "address_comment": "офис 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": "Кругосуточно в праздничные дни"
}, - "contacts": [
- {
- "type": "phone",
- "value": "Телефон в международном формате",
- "text": "e-mail Иванова",
- "print_text": "e-mail Иванова",
- "comment": "для деловой переписки",
- "url": "string"
}
], - "name": "Сервисный центр",
- "comment": "Многокональный телефон"
}
], - "description": "string",
- "name": "Солнышко, кафе",
- "context": {
- "servicing_group": "string",
- "servicing_groups": [
- "string"
], - "distance": "3483",
- "is_in_bound": "true",
- "stop_factors": [
- {
- "type": "attribute",
- "name": "Прачечная",
- "tag": "hotel_details_laundry"
}
]
}, - "point": "54.991984,82.901886",
- "has_apartments_info": true,
- "address": {
- "components": [
- {
- "type": "street_number",
- "street": "Красный проспект",
- "number": "21/2 корп. 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": "Сан Сити",
- "landmark_name": "Зарядье (парк в Москве)",
- "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": "Усть-Каменогорск",
- "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": "кафе",
- "legal_name": "ООО Солнышко",
- "addition": "string",
- "description": "Склад",
- "short_name": "Солнышко",
- "primary": "Солнышко"
}, - "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": "Новосибирск, Димитрова проспект, 7",
- "external_content": [
- {
- "type": "discount",
- "value": "shintop",
- "label": "Открыть",
}
], - "employees_org_count": "до 15",
- "search_attributes": {
- "suggest_parts": [
- {
- "text": "string",
- "is_suggested": true
}
], - "suggested_text": "string"
}, - "attribute_groups": [
- {
- "attributes": [
- {
- "id": "123456",
- "tag": "hotel_room_internet",
- "name": "Бесплатный интернет в номерах",
- "icon_url": "string"
}
], - "icon_url": "string",
- "name": "Гостиница",
- "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
}
}
}