API overview

Base URL:

https://api.headcode.dev

Versioned REST endpoints live under /v1.

All REST endpoints return JSON. Headcode is currently in active development; to request an auth token, email [email protected].

Current API reference

Use the API reference section in the sidebar for generated OpenAPI documentation.

Stations APIServices APITrain Order APILocations APIDisruptions APIOperations APIOperators APIReason Codes API

Downloadable OpenAPI definitions:

• /openapi/stations.yaml
• /openapi/services.yaml
• /openapi/train-order.yaml
• /openapi/locations.yaml
• /openapi/disruptions.yaml
• /openapi/operations.yaml
• /openapi/operators.yaml
• /openapi/reason-codes.yaml

Implemented API surface

• Stations and station search.
• Station departures, arrivals and combined boards.
• Station passing trains — non-stopping services, working (not public) times only, at station/TIPLOC granularity (no Fast/Slow/Up/Down running-line filtering; see Planned API surface).
• Next departures to multiple destinations.
• Station footfall data.
• Services, calling points, formations and live status.
• Service lookup by UID and scheduled start date.
• Platform train order.
• Disruptions from station messages and train alerts.
• Locations — non-station operational rail locations (junctions, sidings, depots).
• Operations — feed health monitoring with active alarms and heartbeat status.
• Operators — Train Operating Company reference data.
• Reason Codes — delay and cancellation reason code reference data.
• Station board filtering — filter departures and arrivals by TOC, platform, destination or calling point.

Planned API surface

• Reliability analytics.
• Passenger flows.
• Accessibility journey profiles.
• Webhook notifications.
• Running-line (Fast/Slow/Up/Down) filtering for passing trains — requires a new data source; no such concept exists in the schema today.