Lines

Get Line Route

Retrieves the ordered route of stations for a specific line, including branches.

get/lines/{lineId}/route

Request

  • Base URL: https://api.stationly.co.uk/api/v1
  • URL: https://api.stationly.co.uk/api/v1/lines/{lineId}/route
  • Auth: API key in header X-Stationly-Key

Path parameters

lineIdstring required

Query parameters

stationstring

Naptan id to make the sequence relative to. When supplied, every stop list starts at the stop AFTER this station and runs to its branch terminus, and directions not served from here are omitted.

modestring

Response

A list of directions and destinations for the line.

idstring
directionNamestring
towardsstring
labelstring
secondaryLabelstring
originStationIdstring nullable
upcomingStationsstring[]

Display names of the shared trunk. Legacy shape.

Example response

[
  {
    "id": "inbound",
    "directionName": "Southbound",
    "towards": "Russell Square",
    "label": "Southbound towards Russell Square",
    "secondaryLabel": "Russell Square · Holborn",
    "originStationId": "940GZZLUKSX",
    "upcomingStops": [
      {
        "id": "940GZZLURSQ",
        "name": "Russell Square"
      }
    ],
    "destinations": [
      {
        "id": "940GZZLUHR5",
        "label": "Heathrow Terminal 5",
        "name": "Heathrow Terminal 5"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.