StopPlace
objectA place where passengers start, end or change a journey, for example a station or a bus stop. A stop place groups one or more quays.
Fields
The situations that name this stop place as a stop. A situation that names one of its quays is not returned here, but on that quay.
The name of the stop place.
The API accepts the language argument for compatibility but ignores it.
It always returns the name from the source data, in whatever language that name is.
languageStringIgnored. The name is not translated.
The transport mode of the stop place. The source data holds at most one mode, so the list has at most one item.
The transport submode of the stop place. The source data holds at most one submode, so the list has at most one item.
The stop place that contains this one, for example a station with several modes. Null when there is none.
The calls at all the quays of this stop place in a time window, ordered by expected time (the departure, else the arrival; the aimed time where real-time data gives none).
It takes the same arguments as Quay.estimatedCalls, and its caps apply to the stop place as a whole.
Where real-time data exists, it replaces the scheduled times, in the window and in the order: a call is in the window by the time it has, so a delayed call is listed until it has left, and one that has gone is not.
A journey that is replaced on its operating day, that is its dated journey says replaced and another dated journey names it as the one it replaces, is left out of that day.
startTimeDateTimeThe start of the time window. The default is the time of the request.
The length of the time window, in seconds. The default is 86400, which is 24 hours.
The maximum number of calls to return. The default is 5 and the largest allowed value is 1000.
Whether the window applies to arrivals, departures, or both. A departure call must allow boarding, and an arrival call must allow alighting.
When true, calls of cancelled trips are included. The default is false.
numberOfDeparturesPerLineAndDestinationDisplayIntThe most calls to return for each combination of line and destination display.
numberOfDeparturesstill caps the whole result. Leave it out, or use zero or less, to apply no per-combination cap.filtersEstimatedCallFilterInputKeep only calls that match this filter. It cannot be combined with
whiteListedorwhiteListedModes.whiteListedInputWhiteListedKeep only calls on these lines or lines of these authorities. It combines with
whiteListedModesas OR, and cannot be combined withfilters.whiteListedModes[TransportMode]!Keep only calls with one of these transport modes. It combines with
whiteListedas OR, and cannot be combined withfilters.When true, calls where boarding is not allowed are left out. A departure call already needs boarding, so this matters under
arrivalsandboth.
The key-values of the stop place: the Key and Value pairs of its key list, in the order the source gave them. A key can repeat. Pass keys to return only the pairs whose key is in the list.
keys[String]!The keys to return. Leave it out to return every pair.