Skip to content

endpoints

Jump to bottom
Tezza ♥️ edited this page Oct 17, 2016 · 6 revisions

#API Endpoints

BikePoint

Endpoint Description License Data Availability
/BikePoint Gets all bike point locations  Open  AVAILABLE
/BikePoint/{id} Gets the bike point with the given id.  Open  AVAILABLE
/BikePoint
?swLat={swLat}
&swLon={swLon}
&neLat={neLat}
&neLon={neLon} 		Gets the bike points that lie within the bounding box defined by the lat/lon of its north-west and south-east corners.  Open  AVAILABLE
/BikePoint
?lat={lat}
&lon={lon}
&radius={radius} 		Gets the bike points that lie within the locus defined by the lat/lon of its centre and a radius in metres.  Open  AVAILABLE
/BikePoint/Search
?query={query} 		Search for bike stations by their name, a bike points name contains location information  Open  AVAILABLE

#####Sources

Weather

Endpoint Description License Data Availability
/Weather Gets the current weather situation CC0 Available
/Weather/AirQuality Gets air quality data feed CC0 UNUSABLE - missing live data

######Sources

Journey

Endpoint Description License Data Availability
/Journey/{from}/to/{to} Perform a Journey Planner search from the parameters specified in simple types CC0 AVAILABLE

######Sources

Line

Endpoint Description License Data Availability
/Line/{ids} Gets line specified by the line id. CC0 TBD with openOV
/Line/{ids}/Arrivals Get the list of arrival predictions for given line ids CC0 TBD with openOV
/Line/{ids}/Disruption Get disruptions for the given line ids CC0 TBD with openOV
/Line/{ids}/Disruption
?startDate={startDate}
&endDate={endDate} 		Get disruptions for the given line ids during provided date range CC0 TBD with openOV
/Line/Mode/{modes} Gets line specified by provided modes. CC0 TBD with openOV
/Line/Mode/{modes}/Disruption Get disruptions for all lines of the given modes. CC0 TBD with openOV
/Line/Mode/{modes}/Disruption
?startDate={startDate}
&endDate={endDate} 		Get disruptions for all lines of the given modes during provided date range. CC0 TBD with openOV
/Line/Mode/{modes}/Route Gets all lines and their valid routes for given modes, including the name and id of the originating and terminating stops for each route CC0 TBD with openOV
/Line/Mode/{modes}/Status Gets the line status of for all lines for the given modes CC0 TBD with openOV
/Line/Mode/{modes}/Status
?startDate={startDate}
&endDate={endDate} 		Gets the line status of for all lines for the given modes during the provided dates e.g Minor Delays CC0 TBD with openOV
/Line/Route Get all valid routes for all lines, including the name and id of the originating and terminating stops for each route. CC0 TBD with openOV
/Line/{ids}/Route Get all valid routes for given line ids, including the name and id of the originating and terminating stops for each route. CC0 TBD with openOV
/Line/Status/{severity} Gets the line status for all lines with a given severity A list of valid severity codes can be obtained from a call to Line/Meta/Severity CC0 TBD with openOV
/Line/{ids}/Status Gets the line status of for given line ids e.g Minor Delays CC0 TBD with openOV
/Line/{ids}/Status/
{startDate}/to/{endDate} 		Gets the line status for given line ids during the provided dates e.g Minor Delays CC0 TBD with openOV
/Line/{id}/StopPoints Gets a list of the stations that serve the given line id CC0 TBD with openOV
/Line/{id}/Timetable/
{fromStopPointId} 		Gets the timetable for a specified station on the give line CC0 TBD with openOV
/Line/{id}/Timetable/
{fromStopPointId}/to/
{toStopPointId} 		Gets the timetable for a specified station on the give line with specified CC0 TBD with openOV

######Sources

Occupancy

Endpoint Description License Data Availability
/Occupancy/CarPark Gets the occupancy for all car parks that have occupancy data. CC-BY-SA 3.0 AVAILABLE
/Occupancy/CarPark/{id} Gets the occupancy for a car park with a given id. CC-BY-SA 3.0 AVAILABLE
/Occupancy/Vehicle/{ids} Gets the occupancy for a given list of vehicle Id's. UNKNOWN  UNAVAILABLE

######Sources

StopPoint

Endpoint Description License Data Availability
/StopPoint/{ids} Gets a list of StopPoints corresponding to the given list of stop ids. CC0  AVAILABLE
/StopPoint
?lat={lat}
&lon={lon}
&radius={radius} 		Gets a list of StopPoints within by the specified criteria CC0 AVAILABLE
/StopPoint
?lat={lat}
&lon={lon}
&radius={radius}
&stopTypes={stopTypes} 		Gets a list of StopPoints within by the specified criteria CC0 UNAVAILABLE, stopType unknown, other metadata missing (disabled acces,...)
/StopPoint
?swLat={swLat}
&swLon={swLon}
&neLat={neLat}
&neLon={neLon} 		Gets a list of StopPoints contained within a lat/long bounding box. CC0 AVAILABLE
/StopPoint
?swLat={swLat}
&swLon={swLon}
&neLat={neLat}
&neLon={neLon}
&stopTypes={stopTypes} 		Gets a list of StopPoints contained within a lat/long bounding box and filtered by the specified criteria. CC0 UNAVAILABLE, stopType unknown, other metadata missing (disabled acces,...)
/StopPoint/{id}/Arrivals Gets the list of arrival predictions for the given stop point id CC0 UNAVAILABLE, Can probably be calculated
/StopPoint/{id}/
CanReachOnLine/{lineId} 		Gets Stopoints that are reachable from a station/line combination. CC0 UNAVAILABLE, Can probably be calculated
/StopPoint/{ids}/Disruption Gets all disruptions for the specified StopPointId, plus disruptions for any child Naptan records it may have. CC0  UNAVAILABLE, might be scraped from Verkéiersverbond website
/StopPoint/{ids}/Disruption
?startDate={startDate}
&endDate={endDate} 		Gets all disruptions for the specified StopPointId, plus disruptions for any child Naptan records it may have. CC0 UNAVAILABLE
/StopPoint/Meta/{metadataType} Gets metadata for methods that act upon the Stops controller. If metadataType is "categories", gets a list of all of the available stops property categories and keys, grouped by category name. If metadataType is "stoptypes", gets a list of the available types of stops. If metadataType is "modes", gets a list of the valid modes to filter stops by. CC0 UNAVAILABLE as possible metadata is yet unknown
/StopPoint/Mode/{modes} Gets a list of StopPoints filtered by the modes available at that StopPoint. CC0 UNAVAILABLE, stoppoints are currentl missing the necessary metadata
/StopPoint/Mode/{modes}/Disruption Gets a distinct list of disrupted stop points for the given modes CC0 UNAVAILABLE, stoppoints are currentl missing the necessary metadata
/StopPoint/Mode/{modes}/Disruption
?startDate={startDate}
&endDate={endDate} 		Gets a distinct list of disrupted stop points for given modes CC0 UNAVAILABLE, stoppoints are currentl missing the necessary metadata + missing dates
/StopPoint/{id}/Route Returns the route sections for all the lines that service the given stop point ids CC0 UNAVAILABLE, Can probably be calculated
/StopPoint/Search/{query} Search StopPoints by their common name, zip, city, street name, address,... CC0 AVAILABLE
/StopPoint/ServiceTypes
?id={id} 		Gets the service types for a given stoppoint CC0 UNAVAILABLE, stoppoints are currentl missing the necessary metadata

######Sources

Vehicle

Endpoint Description License Data Availability
/Vehicle/{ids}/Arrivals Gets the predictions for a given list of vehicle Id's. CC0  UNAVAILABLE

Clone this wiki locally