Next Nearby Departures (Deprecated)
Use the board
resource to request the next nearby departures at a location/station.
This section provides information on the resources and request parameters for the next nearby departures functionality.
.../v3/board.{format}?<parameter>=<value>...
Parameter | Data Type | Description |
---|---|---|
app_id | String | Typically, but not guaranteed to be, 20 |
app_code | String | Typically, but not guaranteed to be, 20 |
apikey | String | A 43-byte Base64 URL-safe encoded string used for the authentication of the client |
stnId | String | Specifies a station id for the request. Remember to url encode the '#' with %23 |
time | DateTime | Specifies the time in ISO 8601 (for example, 2020-06-24T01:23:45) format.
|
Parameter | Data Type | Description |
---|---|---|
callbackFunc | String | Specifies an arbitrary string used to wrap the JSON object in the response. |
callbackId | Integer | If you specify the parameter callbackId , specifies the first argument to the function specified by the callbackFunc . |
lang | String | Specifies the language of the response. The value complies with the ISO 639-1 standard and defaults to en . |
modes | String | Specifies the transit type filter used to determine which types of transit to include in the response. |
max | Integer | Specifies the maximum number of next departures the response should include. The default value is 40. The minimum value is 1 and the maximum value is 500. |
strict | Integer | Specifies which station departures the response should include. Specify strict=1 to only include departures from the given station id. Default behaviour is that a request to a stop causes the response to contain equivalent stops. |
maxPerTransport | Integer | Define the maximum number of results per transport returned in the response. A transport is identified by his name, direction and mode. When not set, all departures are returned, otherwise the first maxPerTransport departures for each transport in chronological order are returned. Range: 1-10 |
sort | Enum | Define how the departures are sorted. By default the departures are returned sorted by scheduled time. When sort=transport , the departures are sorted first by transport and then by scheduled time.
The default is |
timespan | Integer | Limit the next departures to the defined time window and starting from the time provided in the request. When not set, this filter is not applied and a maximum of 24 hours of departures can be returned. The filter will remove all departures outside the interval defined by time and timespan . Range: 1-1440 minutes The default is |