Bus stops
England
Wales
Scotland
gethttps://crystalroof.co.uk/customer-api/transport/closest-bus-stops/v1/{location}
Description
This method returns the closest bus stops to a specified location, with distances measured in meters.
Available values:
- atcoCode: A twelve-character NaPTAN identifier intended for use in computer systems.
- naptanCode: A short (seven or eight-digit) identifier suitable for displaying on stops and referring to the stop in public-facing systems. This has been designed to be suitable for use in SMS and other delivery channels requiring direct reference to a stop identifier by the public. In most areas, it uses a character set optimised for a mobile device keypad.
- plateCode: Unique asset code identifier of stop point. This element supports the general exchange of stop data and is not currently part of the NaPTAN database.
- name: Name of the stop area.
- shortName: A short version of the common name, compacted to fit within the specified length limit for the stop’s administrative area. The short name is specified only if it differs from the common name.
- street: Name of the street where the stop point of Place is. This must still be given even if the stop is named after the street.
- suburb: Name of the suburb where the Place is.
- town: Name of town where the stop point of the Place is.
- localityCentre: Whether the stop point of the Place is at the centre of a town or not. A value of true indicates that the stop is one of the central stops in the NptgLocality and that a journey enquiry to the locality could sensibly start or end at this stop. More than one stop point can be designated as a locality centre for a given NptgLocality.
- localityName: Unique NPTG name of the locality. Should be a valid place name subject to the same restrictions on characters as a NaPTAN common name.
- stopType: NaPTAN stop type.
- busStopType: NaPTAN bus stop subtype.
- bearing: Direction in which a vehicle is pointing when stopped at the stopping point on the road.
- timingStatus: Expected status of the bus stop in bus service registrations.
Available stop type values:
- BCT: Bus / Coach / Trolley Stop.
- BCS: Bus / Coach bay / stand / stance within Bus / Coach Stations.
- BCE: Bus / Coach Station Entrance.
- BCQ: Bus Coach Station Variable Bay.
- BST: Bus Coach Station Access Area.
Available bus stop type values:
- MKD: Bus / Coach Stop.
- CUS: Custom / Unmarked stop.
- HAR: Hail & Ride zone.
- FLX: Flexible Zone.
Parameters
Name | Description |
---|---|
location path string | Postcode, coordinates in the lat,long format or UPRN in the uprn12345678 format. |
limit query enum | Number of elements to be returned by the method. The returned number of elements may be less than the requested amount if fewer elements are found based on your criteria (in very rare cases). The maximum value is 20. To retrieve only the metadata, use the value 0. |
api_key query enum | Your API key. DEMO key allows you to test the method in the W6 0 postcode sector, or in the [[51.492, -0.25], [51.502, -0.225]] rectangle. |
Request URL:
https://crystalroof.co.uk/customer-api/transport/closest-bus-stops/v1/{location}?api_key=DEMO
Possible responses with examples
Code
Description
200
Success
401
Unauthorized
402
Payment Required
403
Forbidden
429
Too Many Requests
500
Internal Server Error