v1

latestSwagger 2.02026-07-1384122135.6 KB
StopPoint

Gets a list of StopPoints within {radius} by the specified criteria

get/StopPoint

Query parameters

stopTypesstring[] required

a list of stopTypes that should be returned (a list of valid stop types can be obtained from the StopPoint/meta/stoptypes endpoint)

radiusinteger

the radius of the bounding circle in metres (default : 200)

useStopPointHierarchyboolean

Re-arrange the output into a parent/child hierarchy

modesstring[]

the list of modes to search (comma separated mode names e.g. tube,dlr)

categoriesstring[]

an optional list of comma separated property categories to return in the StopPoint'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 /StopPoint/Meta/categories endpoint)

returnLinesboolean

true to return the lines that each stop point serves as a nested resource

location.latnumber double required
location.lonnumber double required

Response

OK

centrePointnumber[]

The centre latitude/longitude of this list of StopPoints

pageSizeinteger

The maximum size of the page in this response i.e. the maximum number of StopPoints

totalinteger

The total number of StopPoints available across all pages

pageinteger

The index of this page