Quick start
APIs
Start calling data Using the APIs. A different API is required to consume each data type.
Query parameters are documented in the API reference.
You must register for an account to get an API key.
Download all data
Download all data will give you all data cached by the service for your chosen data type. All data set statuses are included in the download all, including: Published and Inactive.
Data provided to service
- Look for examples of data published to the service
- Find a data set’s detail page
- View a data set’s metadata
- Find a data set’s ID
- Download a data set
- Provide feedback to data publishers about a certain data set
Data updates
| Data type | Cache type | Update rate |
|---|---|---|
| Timetables | Static | Updates every 24 hours around 06:00 GMT |
| Fares data | Static | Updates every 24 hours around 06:00 GMT |
| Bus location data | Real time | Every 10 seconds |
Status
| Data set status | Explanation |
|---|---|
| Published | Data that has been published |
| Inactive | If a publisher actively wants to remove data from a published state, they can move it to an inactive state |
| Error | If the publisher users a URL link to publish and the URL link fails to validate during the daily pull from BODS, then the data set will move into error but however the old data will still be available |
| Data feed status | Explanation |
|---|---|
| Published | Data that has been published |
| No vehicle activity |
Data feeds provide location data and can either be in a published or
error state. Error states are given to feeds when:
|
| Inactive | If a publisher actively wants to remove data from a published state, they can move it to an inactive state. |
What is a data set/feed?
Operators must provide a complete set of data regarding local bus services. They may provide this as a single data set or break it down into multiple data sets, depending on their own business needs. Commonly operators break the data down into data sets per:
- Operating companies
- Regions of operation
- Underlying scheduler
- Route or line
- Data source / system supplying data