- Previous: GET /v1/location
- Up: Central Index API
- Next: GET /v1/lookup/category
GET /v1/location/context
HTTP Method: GET
Path: /v1/location/context
Authentication: API Key required
Description: Given a location id or a lat/long pair, a location resolution and a radius, obtain a list of locations of the same resolution within the given radius.
Parameters:
parameter | type | description | Required | Example |
location_id | string | a Central Index location_id |
no | GBN33RD |
latitude | float | A latitude |
no | 53.678 |
longitude | float | A longitude | no | -1.567 |
radius | integer | Radius in kilometres | yes | 20 |
resolution | collection | One or more (comma-separated) of "district", "neighbourhood", "town", "region", "county", "province" | yes | |
country | string | Two-letter ISO-3166 country code | yes | GB |
Sample Response:
{ "success": true, "msg": "ok", "data": [ { "_id": "GB41713", "_rev": "3-1171c981fefbdac1d82e04aa842a2564", "name": "East Finchley", "formal_name": "East Finchley,London", "latitude": 51.589500427246094, "longitude": -0.17018400132656097, "resolution": "district", "country": "gb", "population": 0, "description": "", "timezone": "Europe/London", "parent_town": [ "GB14648" ], "parent_county": [ "GB14648" ], "parent_province": [ "GB41673" ], "parent_neighbourhood": [ "GB12335,GB12513,GB12328" ], "parent_region": [ "GB13660,GB13666" ], "parent_district": [], "postalcode": [], "language": "en", "type": "postal" }, { "_id": "GB41717", "_rev": "3-d74d81258a1d01387706da6c8079ad48", "name": "Finchley", "formal_name": "Finchley,London", "latitude": 51.60139846801758, "longitude": -0.19174399971961975, "resolution": "district", "country": "gb", "population": 0, "description": "", "timezone": "Europe/London", "parent_town": [ "GB14648" ], "parent_county": [ "GB14648" ], "parent_province": [ "GB41673" ], "parent_neighbourhood": [ "GB12328,GB12513,GB12319,GB12332,GB12517,GB12520" ], "parent_region": [ "GB13660,GB13666" ], "parent_district": [], "postalcode": [], "language": "en", "type": "postal" } ] }
- Previous: GET /v1/location
- Up: Central Index API
- Next: GET /v1/lookup/category
Docs Navigation
- Introduction
- Getting Started
- Using IODocs
- Responses
- Creating a sample request
- Sample Libraries
- Central Index API
- What data do we store in an entity?
- GET /v1/advertiser/updated
- GET /v1/autocomplete/category
- GET /v1/autocomplete/keyword
- GET /v1/autocomplete/location
- GET /v1/entity
- GET /v1/entity/advertisers
- GET /v1/entity/advertisers/inventorycheck
- GET /v1/entity/by_supplier_id
- GET /v1/entity/search/keyword/bynearest
- GET /v1/entity/search/what
- GET /v1/entity/search/what/bylocation
- GET /v1/entity/search/what/byboundingbox
- GET /v1/entity/search/what/bynearest
- GET /v1/entity/search/who
- GET /v1/entity/search/who/bylocation
- GET /v1/entity/search/who/byboundingbox
- GET /v1/entity/search/who/bynearest
- GET /v1/location
- GET /v1/location/context
- GET /v1/lookup/category
- GET /v1/match/byphone
- GET /v1/stats/entity/by_date
- GET /v1/syndication_log/by_entity_id
- GET /v1/token/add
- GET /v1/token/report
- GET /v1/token/claim
- GET /v1/token/message
- GET /v1/tools/docs
- GET /v1/user/by_email
- PUT /v1/business
- PUT /v1/business/json
- PUT /v1/entityserve
- POST /v1/entity/advertiser/cancel
- POST /v1/entity/advertiser/create
- POST /v1/entity/advertiser/renew
- POST /v1/entity/advertiser/upsell
- POST /v1/entity/category
- POST /v1/entity/claim
- POST /entity/claim/cancel
- POST /v1/entity/claim/reseller
- POST /v1/entity/description
- POST /v1/entity/document
- POST /v1/entity/email
- POST /v1/entity/fax
- POST /v1/entity/featured_message
- POST /v1/entity/geopoint
- POST /v1/entity/image
- POST /v1/entity/image/by_url
- POST /v1/entity/list
- POST /v1/entity/logo
- POST /v1/entity/logo/by_url
- POST /v1/entity/name
- POST /v1/entity/opening_times
- POST /v1/entity/payment_type
- POST /v1/entity/phone
- POST /v1/entity/postal_address
- POST /v1/entity/socialmedia
- POST /v1/entity/special_offer
- POST /v1/entity/tag
- POST /v1/entity/testimonial
- POST /v1/entity/video/youtube
- POST /v1/entity/website
- POST /v1/syndication/cancel
- POST /v1/syndication/create
- POST /v1/signal
- POST /v1/user
- DELETE /v1/entity/category
- DELETE /v1/entity/description
- DELETE /v1/entity/image
- DELETE /v1/entity/phone
- DELETE /v1/entity/logo
- DELETE /v1/entity/website
- syndication api