/3.0/items/geocode/byip
Catalog of objects (3.0)
Geocoding by IP
Performs geocoding by IP. If the IP-address matches the coordinate, but the geo object is not found at this point, the coordinate is returned.
query Parameters
ip required | string Example: ip=194.226.82.50 IP-address. IPv4 and IPv6 notations are allowed. |
key required | string Unique key of API user. |
locale | string Examples:
The locale from which the search is performed and the results are given.
|
type | Array of strings Examples:
Types of geoobjects to search among. When passing multiple types, the less relevant results of some types may be replaced by the more relevant results of other types. The types are separated by commas. The value 'adm_div `is an alias for all 'adm_div' types.* 'simultaneously. 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:
|
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. |
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. |
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. |
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. |
Responses
Response Schema: application/json
required | object (ObjMeta) Response metadata |
required | object Main result |
Response samples
- 200
- 400
- 403
- 404
- 500
{- "meta": {
- "code": 200,
- "api_version": "dev",
- "issue_date": "string"
}, - "result": {
- "total": 1,
- "items": [
- {
- "id": "141265769336625_f91d4H3777058262347790J0e8g28765",
- "type": "branch",
- "region_id": "123456",
- "segment_id": "123456",
- "locale": "ru_RU",
- "description": "string",
- "attribute_groups": [
- {
- "name": "Hotel",
- "is_context": true,
- "is_primary": true,
- "rubric_ids": [
- "123456"
], - "attributes": [
- {
- "id": "123456",
- "name": "Free Internet in the rooms",
- "icon_url": "string",
- "tag": "hotel_room_internet"
}
], - "icon_url": "string"
}
], - "adm_div": [
- {
- "id": "123456",
- "type": "city",
- "flags": {
- "is_district_area_center": true,
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "value": "string",
- "name": "string"
}
], - "has_model": { },
- "photos": true,
- "is_default": true,
- "is_region_center": true
}, - "city_alias": "novosibirsk",
- "detailed_subtype": "poselok",
- "caption": "string",
- "name": "Ust-Kamenogorsk",
- "is_default": true
}
], - "itin": "1234567890",
- "reviews": {
- "review_count": "32",
- "recommendation_count": "12",
- "items": [
- {
- "is_reviewable": true,
- "rating": 5,
- "review_count": 0,
- "recommendation_count": 0,
- "tag": "string"
}
], - "org_review_count": 0,
- "general_rating": "4.73",
- "rating": "4.73",
- "general_review_count": 0,
- "org_rating": "4.73",
- "is_reviewable": true,
- "is_org_reviews": true,
- "general_review_count_with_stars": 0,
- "org_review_count_with_stars": 0
}, - "building_name": "string",
- "name_ex": {
- "short_name": "Sunny",
- "primary": "Sunny",
- "extension": "cafe",
- "legal_name": "LLC Sunny",
- "addition": "string",
- "description": "Warehouse"
}, - "trade_license": {
- "type": "string",
- "license": "string",
- "start_date": "string",
- "end_date": "string",
- "legal_form": "string",
- "type_description": "string",
- "director_name": "string"
}, - "delivery": [
- {
- "phone": "+7123456789"
}
], - "floors": {
- "ground_count": 1,
- "underground_count": 1,
- "ground_min_count": 1
}, - "rubrics": [
- {
- "id": "123456",
- "name": "string",
- "alias": "string",
- "parent_id": "123456",
- "kind": "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)"
}, - "full_address_name": "Novosibirsk, Dimitrov Avenue, 7",
- "has_apartments_info": true,
- "parking": {
- "payment_link": "string"
}, - "search_attributes": {
- "suggested_text": "string",
- "suggest_parts": [
- {
- "text": "string",
- "is_suggested": true
}
]
}, - "address_name": "Dimitrov Avenue, 7",
- "address_comment": "office 413",
- "full_name": "string",
- "structure_info": {
- "porch_count": 0,
- "chs_name": "string",
- "material": "string",
- "chs_category": "string",
- "floor_type": "string",
- "gas_type": "string",
- "apartments_count": 0,
- "elevators_count": 0,
- "project_type": "string",
- "year_of_construction": 0,
- "is_in_emergency_state": true
}, - "order_with_cart": [
- {
- "phone": "+7123456789"
}
], - "city_alias": "novosibirsk",
- "external_content": [
- {
- "type": "discount",
- "label": "Open",
- "value": "shintop"
}
], - "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"
}, - "point": "54.991984,82.901886",
- "is_routing_available": true,
- "floor_plans": {
- "plans": [
- {
- "id": "123456",
- "name": "string"
}
], - "default_plan_id": "123456"
}, - "contact_groups": [
- {
- "schedule": {
- "is_24x7": true,
- "comment": "Open 24h on holidays",
- "Fri": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Tue": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Wed": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Sun": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "date_from": "string",
- "Mon": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Thu": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "Sat": {
- "working_hours": [
- {
- "to": null,
- "from": null
}
]
}, - "description": "string",
- "date_to": "string"
}, - "contacts": [
- {
- "type": "phone",
- "url": "string",
- "value": "Phone number in international format",
- "text": "Ivanov's e-mail",
- "print_text": "Ivanov's e-mail",
- "comment": "for business correspondence"
}
], - "name": "Service center",
- "comment": "Multichannel phone number"
}
], - "timezone_offset": 420,
- "employees_org_count": "up to 15",
- "floor_id": "141832714658709",
- "marker_alt": 0,
- "flags": {
- "is_district_area_center": true,
- "temporary_closed": "string",
- "temporary_closed_parameters": [
- {
- "type": "string",
- "value": "string",
- "name": "string"
}
], - "has_model": { },
- "photos": true,
- "is_default": true,
- "is_region_center": true
}, - "sources": [
- "string"
], - "ev_charging_station": {
- "connectors": [
- {
- "type": "string",
- "power": 0,
- "price": 0,
- "status": 0
}
], - "aggregate": {
- "connectors_total": 0,
- "power": 0,
- "is_active": true,
- "is_busy": true,
- "connectors_free": 0
}
}, - "stop_factors": [
- {
- "type": "attribute",
- "name": "Laundry",
- "tag": "hotel_details_laundry"
}
], - "org": {
- "id": "123456",
- "name": "string",
- "branch_count": "7"
}, - "ski_lift": {
- "type": 0,
- "status": 0
}, - "purpose_name": "string",
- "links": {
- "parking": [
- {
- "id": "123456",
- "name": "Underground Parking, Sun City",
- "purpose": "string",
- "capacity": "string",
- "is_paid": true,
- "comment": "50 rub per hour, first 2 hours free."
}
], - "attractions": [
- {
- "id": "123456",
- "authors": "string",
- "dates": "string",
- "description": "string",
- "subtype_name": "Fountain",
- "name": "Fountain in Narymsky public garden"
}
], - "nearest_parking": [
- {
- "id": "123456"
}
], - "providers": {
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null,
- "comment": null
}
], - "org_id": "string",
- "name": "string"
}
], - "count": 1,
- "allowed_for_reviews_count": 0
}, - "hotels": {
- "items": [
- {
- "id": "123456",
- "name": "Aquarius, Motel",
- "additional_info": "Mira St, 18a bld1"
}
], - "count": 0
}, - "branches": {
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null,
- "comment": null
}
], - "org_id": "string",
- "name": "string"
}
], - "count": 1,
- "allowed_for_reviews_count": 0
}, - "nearest_metro": [
- {
- "id": "123456",
- "distance": 500
}
], - "nearest_stations": [
- {
- "id": "123456",
- "comment": "Leninskaya line",
- "distance": 0,
- "internal_transition": true,
- "entrance": {
- "id": "123456",
- "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": "string"
}, - "name": "Krasniy Prospekt metro station",
- "color": "#D10000",
- "route_types": [
- "string"
], - "route_logo": "string"
}
], - "database_entrances": [
- {
- "id": "123456",
- "entity_number": "string",
- "apartments_info": {
- "calculated": true,
- "floors": [
- {
- "name": null,
- "apartments": null
}
]
}, - "name": "string",
- "has_poi": true,
- "entrance_display_name": "string",
- "is_visible_on_map": true,
- "is_primary": true,
- "comment": "string",
- "entity_name": "string",
- "relative_geometry": {
- "dx": 0,
- "dy": 0,
- "direction": 0
}, - "is_visible_in_ui": true,
- "building_number": "string",
- "geometry": {
- "points": [
- "string"
], - "vectors": [
- "string"
], - "normals": [
- "string"
]
}
}
], - "airports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Tolmachevo airport",
- "additional_info": "Airport, Ob-4"
}
]
}, - "river_ports": {
- "items": [
- {
- "id": "123456",
- "name": "Moscow North river terminal",
- "additional_info": "Leningrad highway, 51"
}
], - "count": 0
}, - "landmarks": [
- {
- "id": "123456",
- "type": "station_platform",
- "name": "string",
- "entrance_display_name": "string",
- "distance": 0,
- "azimuth": 360,
- "subtype": "string",
- "station_id": "123456"
}
], - "nearest_platforms": [
- {
- "id": "123456",
- "route_types": [
- "string"
], - "transition_type": "string",
- "heading_to": "Nakhabino",
- "name": "Krasniy Prospekt metro station",
- "comment": "Leninskaya line",
- "color": "#D10000",
- "route_logo": "string"
}
], - "servicing": {
- "items": [
- {
- "id": "123_24J2I19H1J0fghdw7GJ0JJ16153",
- "additional_info": "string",
- "contacts": [
- {
- "type": null,
- "url": null,
- "value": null,
- "text": null,
- "print_text": null,
- "comment": null
}
], - "org_id": "string",
- "name": "string"
}
], - "count": 1,
- "allowed_for_reviews_count": 0
}, - "entrances": [
- {
- "id": "123456",
- "entity_number": "string",
- "is_visible_on_map": true,
- "entity_name": "string",
- "is_visible_in_ui": true,
- "is_primary": true,
- "comment": "string",
- "entrance_display_name": "string",
- "geometry": {
- "points": [
- "string"
], - "vectors": [
- "string"
], - "normals": [
- "string"
]
}
}
], - "railway_terminals": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Novosibirsk-Western, railway station",
- "additional_info": "Shirokaya Street, 26a"
}
]
}, - "bus_terminals": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "additional_info": "Krasnyy Prospekt, 4",
- "name": "Bus station, Novosibirsk"
}
]
}, - "seaports": {
- "count": 0,
- "items": [
- {
- "id": "123456",
- "name": "Marine passenger terminal",
- "additional_info": "Marine Glory square, 1"
}
]
}
}, - "address": {
- "makani": "27116 87099",
- "components": [
- {
- "type": "street_number",
- "street_id": "123456",
- "street": "Krasnyy Prospekt",
- "number": "21/2, bld 7",
- "fias_code": "dcb1bc1b-2324-449a-8b68-03e49ba1f541",
- "okato": "35",
- "oktmo": "35"
}
], - "building_id": "20498230958",
- "postcode": "630007",
- "building_code": "string",
- "building_name": "Sun City",
- "landmark_name": "Zaryadye (a park in Moscow)"
}, - "name": "the Sunny cafe",
- "is_deleted": true,
- "schedule": {
- "is_24x7": true,
- "comment": "Open 24h on holidays",
- "Fri": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Tue": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Wed": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Sun": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "date_from": "string",
- "Mon": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Thu": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "Sat": {
- "working_hours": [
- {
- "to": "17:00",
- "from": "09:00"
}
]
}, - "description": "string",
- "date_to": "string"
}, - "context": {
- "stop_factors": [
- {
- "type": "attribute",
- "name": "Laundry",
- "tag": "hotel_details_laundry"
}
], - "servicing_group": "string",
- "servicing_groups": [
- "string"
], - "distance": "3483",
- "is_in_bound": "true"
}, - "alias": "shintop_set_avtomarketov"
}
], - "context_rubrics": [
- {
- "id": "string",
- "caption": "string",
- "name": "string",
- "group": 0
}
], - "search_attributes": {
- "out_viewport": [
- {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}, - {
- "longitude": 29.13375591576512,
- "latitude": 55.97851125831795
}
], - "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_partial": true,
- "is_remote_requested": true,
- "is_nearby_requested": true
}
}
}