departureboard.io API API

by departureboard.io

Overview

The departureboard.io is a high performance API written in Golang. Its goal is to provide to main functions: (1): A JSON API interface to the legacy National Rail SOAP API: Giving developers the ability to pull live information on departures, arrivals, and services from National Rail, without having to use the legacy SOAP API provided by National Rail. Information is still pulled directly from National Rail in the background, providing the same level of real-time data without the additional complexity of having to interact with SOAP. (2): A JSON API interface for additional National Rail information: Giving developers the ability to pull a range of information about the Rail Network, via a JSON API interface. This is not an offering that National Rail currently provide, and is custom developed. Data is sourced from periodically updated XML documents, parsed, and provided for consumption via the departureboard.io API. This API is completely free to use for non-commercial purposes. You can explore the various sections of the documentation using the links below. For more information please see <a href="https://api.departureboard.io">https://api.departureboard.io</a>

departureboard.io API is a transportation API from departureboard.io. It needs no API key. It is served over HTTPS. Its OpenAPI description documents 6 endpoints.

At a glance

Authentication: No auth
HTTPS: Yes
CORS: Unknown
Category: Transportation
Base URL: https://api.departureboard.io/api/v2.0
Version: 2.0
Endpoints: 6
OpenAPI: Specification ↗
Spec updated: 2020-11-16

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.departureboard.io/api/v2.0/getArrivalsAndDeparturesByCRS/CRS" \
  -H "Accept: application/json"

JavaScript

const response = await fetch("https://api.departureboard.io/api/v2.0/getArrivalsAndDeparturesByCRS/CRS", {
  method: "GET",
  headers: {
    "Accept": "application/json",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.departureboard.io/api/v2.0/getArrivalsAndDeparturesByCRS/CRS",
    headers={
    "Accept": "application/json",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/getArrivalsAndDeparturesByCRS/{CRS}`	getArrivalsAndDeparturesByCRS is used to get a list of services arriving to and departing from a UK train station by the CRS (Computer Reservation System) code.
GET	`/getArrivalsByCRS/{CRS}`	getArrivalsByCRS is used to get a list of services arriving to a UK train station by the CRS (Computer Reservation System) code. This will typically return a li
GET	`/getDeparturesByCRS/{CRS}`	getDeparturesByCRS is used to get a list of services departing from a UK train station by the CRS (Computer Reservation System) code. This will typically return
GET	`/getFastestDeparturesByCRS/{CRS}`	getFastestDeparturesByCRS is used to get the fastest next service running between two stations. Multiple destinations can be specified. This will typically retu
GET	`/getNextDeparturesByCRS/{CRS}`	getNextDeparturesByCRS is used to get the next service running between two stations. Multiple destinations can be specified. This will typically return a single
GET	`/getServiceDetailsByID/{serviceID}`	getServiceDetailsByID is used to get information on a service, by the Service ID. This will typically return a train service, but will also return a bus and fer