Entur Developer
Open
GraphQL

Quay

object

A place at a stop place where passengers board or alight, for example a platform or a bus stand.

Fields

id·ID!

The full NeTEx id of the quay, including codespace and type.

publicCode·String

The code that passengers see for the quay, for example a platform number.

description·String

A description of the quay.

latitude·Float

The latitude of the quay, in decimal degrees.

longitude·Float

The longitude of the quay, in decimal degrees.

timeZone·String

The time zone of the quay, as given in the source data. It is normally an IANA name such as Europe/Oslo.

stopType·String

The type of stop, as given in the source data.

stopPlace·StopPlace

The stop place that the quay belongs to, or null when it has none.

wheelchairAccessible·WheelchairBoarding

Whether a passenger in a wheelchair can board at this quay. Null when the source data has no accessibility information.

tariffZones·[TariffZone!]!

The tariff zones that the quay is in.

name·String(1 arg)

The name of the quay. 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.

Arguments
  • languageString

    Ignored. The name is not translated.

journeyPatterns·[JourneyPattern!]!

The journey patterns that call at this quay.

lines·[Line!]!

The lines that call at this quay.

estimatedCalls·[EstimatedCall!]!(10 args)deprecated

The calls at this quay in a time window, ordered by expected time (the departure, else the arrival; the aimed time where real-time data gives none). 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.

Arguments
  • startTimeDateTime

    The start of the time window. The default is the time of the request.

  • timeRangeInt= 86400

    The length of the time window, in seconds. The default is 86400, which is 24 hours.

  • numberOfDeparturesInt= 5

    The maximum number of calls to return. The default is 5 and the largest allowed value is 1000.

  • arrivalDepartureArrivalDeparture= departures

    Whether the window applies to arrivals, departures, or both. A departure call must allow boarding, and an arrival call must allow alighting.

  • includeCancelledTripsBoolean= false

    When true, calls of cancelled trips are included. The default is false.

  • numberOfDeparturesPerLineAndDestinationDisplayInt

    The most calls to return for each combination of line and destination display. numberOfDepartures still caps the whole result. Leave it out, or use zero or less, to apply no per-combination cap.

  • Keep only calls that match this filter. It cannot be combined with whiteListed or whiteListedModes.

  • whiteListedInputWhiteListed

    Keep only calls on these lines or lines of these authorities. It combines with whiteListedModes as OR, and cannot be combined with filters.

  • whiteListedModes[TransportMode]!

    Keep only calls with one of these transport modes. It combines with whiteListed as OR, and cannot be combined with filters.

  • omitNonBoardingBoolean= false

    When true, calls where boarding is not allowed are left out. A departure call already needs boarding, so this matters under arrivals and both.

keyValues·[KeyValue!]!(1 arg)

The key-values of the quay: 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.

Arguments
  • The keys to return. Leave it out to return every pair.

The situations that name this quay or its stop place as a stop, whatever the stop condition, without a line or a journey with it. A situation that names the quay only together with a line or a journey is on that line's or journey's calls, not here. Whether a situation is valid at the time of the request is not checked; one that has ended or been closed is not kept.

Did you find what you were looking for?