GET Place

tfl.gov.uk

Summary: Gets the places that lie within a geographic region. The geographic region of interest can either be specified by using a lat/lon geo-point and a radius in metres to return places within the locus defined by the lat/lon of its centre or alternatively, by the use of a bounding box defined by the lat/lon of its north-west and south-east corners. Optionally filters on type and can strip properties for a smaller payload.
Operation ID: Place_GetByGeo
Auth: unknown

Parameters (12)

activeOnly (boolean, query, optional)

An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported)

categories (array, query, optional)

An optional list of comma separated property categories to return in the Place's property bag. If null or empty, all categories of property are returned. Pass the keyword "none" to return no properties (a valid list of categories can be obtained from the /Place/Meta/categories endpoint)

includeChildren (boolean, query, optional)

Defaults to false. If true child places e.g. individual charging stations at a charge point while be included, otherwise just the URLs of any child places will be returned

numberOfPlacesToReturn (integer, query, optional)

If specified, limits the number of returned places equal to the given value

placeGeo.lat (number, query, optional)
placeGeo.lon (number, query, optional)
placeGeo.neLat (number, query, optional)
placeGeo.neLon (number, query, optional)
placeGeo.swLat (number, query, optional)
placeGeo.swLon (number, query, optional)
radius (number, query, optional)

The radius of the bounding circle in metres when only lat/lon are specified.

type (array, query, optional)

Place types to filter on, or null to return all types

No probe data for this endpoint yet.