v2

latestSwagger 2.0Creative Commons Attribution 4.0 International2026-08-0126125128.6 KB
Patterns

View the stopping pattern for a specific trip/service run

get/v3/pattern/run/{run_ref}/route_type/{route_type}

Path parameters

run_refstring required

The run_ref is the identifier of a run as returned by the departures/* and runs/* endpoints. WARNING, run_id is deprecated. Use run_ref instead.

route_type0 | 1 | 2 | 3 | 4 required

Number identifying transport mode; values returned via RouteTypes API

Query parameters

expandinteger[]

List of objects to be returned in full (i.e. expanded) - options include: All, Stop, Route, Run, Direction, Disruption, VehiclePosition, VehicleDescriptor and None. Default is Disruption. Run must be expanded to receive VehiclePosition and VehicleDescriptor information.

stop_idinteger

Filter by stop_id; values returned by Stops API

date_utcstring date-time

Filter by the date and time of the request (ISO 8601 UTC format) (default = current date and time)

include_skipped_stopsboolean

Include any skipped stops in a stopping pattern. Defaults to false.

include_geopathboolean

Indicates if geopath data will be returned (default = false)

include_advertised_interchangeboolean

Indicates whether data related to interchanges should be included in the response (default = false) When set to true, this parameter enables API clients to retrieve additional exchange information (stops, routes, runs, directions and disruptions) in a single call instead of making multiple requests

tokenstring

Please ignore

devidstring

Your developer id

signaturestring

Authentication signature for request

Response

The stopping pattern of the specified run_ref and route type. (NOTE: the departure sequence field should be used to sort departures in chronological order, however it is not always N+1 or N-1 of the previous or following departure. e.g 100, 200, 250, 300 instead of 1, 2, 3, 4)

stopsobject

A train station, tram stop, bus stop, regional coach stop or Night Bus stop

routesobject

Train lines, tram routes, bus routes, regional coach routes, Night Bus routes

runsobject

Individual trips/services of a route

directionsobject

Directions of travel of route