v1

latestSwagger 2.02026-07-1384122135.6 KB

Line

Get the list of arrival predictions for given line ids based at the given stop

get/Line/{ids}/Arrivals/{stopPointId}

Path parameters

idsstring[] required

A comma-separated list of line ids e.g. victoria,circle,N133. Max. approx. 20 ids.

stopPointIdstring required

Optional. Id of stop to get arrival predictions for (station naptan code e.g. 940GZZLUASL, you can use /StopPoint/Search/{query} endpoint to find a stop point id from a station name)

Query parameters

direction'inbound' | 'outbound' | 'all'

Optional. The direction of travel. Can be inbound or outbound or all. If left blank, and destinationStopId is set, will default to all

destinationStationIdstring

Optional. Id of destination stop

Response

idstring

The identitier for the prediction

operationTypeinteger

The type of the operation (1: is new or has been updated, 2: should be deleted from any client cache)

vehicleIdstring

The actual vehicle in transit (for train modes, the leading car of the rolling set)

naptanIdstring

Identifier for the prediction

stationNamestring

Station name

lineIdstring

Unique identifier for the Line

lineNamestring

Line Name

platformNamestring

Platform name (for bus, this is the stop letter)

directionstring

Direction (unified to inbound/outbound)

bearingstring

Bearing (between 0 to 359)

tripIdstring

TripId is used to assemble the primary key

baseVersionstring

Data base version

destinationNaptanIdstring

Naptan Identifier for the prediction's destination

destinationNamestring

Name of the destination

timestampstring date-time

Timestamp for when the prediction was inserted/modified (source column drives what objects are broadcast on each iteration)

timeToStationinteger

Prediction of the Time to station in seconds

currentLocationstring

The current location of the vehicle.

towardsstring

Routing information or other descriptive text about the path of the vehicle towards the destination

expectedArrivalstring date-time

The expected arrival time of the vehicle at the stop/station

timeToLivestring date-time

The expiry time for the prediction

modeNamestring

The mode name of the station/line the prediction relates to