mta.subway.arrivalBoard() — nearby subway departure board

GET

https://www.mtaapi.dev

api

subway

arrival-board

Get a nearby subway arrival board

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.mtaapi.dev/api/v1/subway/arrival-board', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "station": {
      "id": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "lat": 123,
      "lon": 123,
      "parentId": "<string>"
    },
    "distanceMeters": 123,
    "directions": [
      {
        "arrivals": [
          {
            "route": {
              "id": "<string>",
              "shortName": "<string>",
              "longName": "<string>",
              "type": 123,
              "color": "<string>",
              "textColor": "<string>"
            },
            "stop": {
              "id": "<string>",
              "name": "<string>",
              "displayName": "<string>",
              "lat": 123,
              "lon": 123,
              "parentId": "<string>"
            },
            "arrivalTime": "<string>",
            "minutes": 123,
            "realtime": true,
            "source": "<string>",
            "destination": "<string>",
            "displayDirection": "<string>",
            "headsign": "<string>",
            "departureTime": "<string>",
            "tripId": "<string>",
            "raw": "<unknown>"
          }
        ],
        "headsign": "<string>"
      }
    ]
  }
]

Returns the nearest subway stations to a lat / lon, with each station’s upcoming arrivals already grouped by direction. It combines nearby-station discovery and arrivals into one request — ideal for a lobby departure board or a “stations near me” screen. Control the board with limitStations (max 20, default 5) and limitArrivals per direction (max 10, default 3). Pass an optional route to restrict every station to a single line. Each entry is { station, distanceMeters, directions: [{ direction, headsign?, arrivals[] }] }.

SDK

const board = await mta.subway.arrivalBoard({
  lat: 40.7356,
  lon: -73.9906,
  limitStations: 5,
  limitArrivals: 3,
})

See the Arrival Boards guide for an end-to-end walkthrough.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

lat

number

required

Required range: -90 <= x <= 90

lon

number

required

Required range: -180 <= x <= 180

route

string

Minimum string length: 1

radiusMeters

number

Required range: x >= 1

limitStations

number

Required range: 1 <= x <= 20

limitArrivals

number

Required range: 1 <= x <= 10

includeRaw

boolean

Response

200 - application/json

Response for status 200

station

object

required

Hide child attributes

station.id

string

required

station.name

string

required

station.displayName

string

station.lat

number

station.lon

number

station.mode

enum<string>

Available options:

subway,

bus

station.parentId

string

distanceMeters

number

required

directions

object[]

required

Hide child attributes

directions.direction

enum<string>

required

Available options:

north,

south,

east,

west,

unknown,

uptown,

downtown

directions.arrivals

object[]

required

Hide child attributes

directions.arrivals.mode

enum<string>

required

Available options:

subway,

bus,

lirr,

metro-north

directions.arrivals.route

object

required

Hide child attributes

directions.arrivals.route.id

string

required

directions.arrivals.route.shortName

string

directions.arrivals.route.longName

string

directions.arrivals.route.type

number

directions.arrivals.route.color

string

directions.arrivals.route.textColor

string

directions.arrivals.stop

object

required

Hide child attributes

directions.arrivals.stop.id

string

required

directions.arrivals.stop.name

string

required

directions.arrivals.stop.displayName

string

directions.arrivals.stop.lat

number

directions.arrivals.stop.lon

number

directions.arrivals.stop.mode

enum<string>

Available options:

subway,

bus

directions.arrivals.stop.parentId

string

directions.arrivals.direction

enum<string>

required

Available options:

north,

south,

east,

west,

unknown,

uptown,

downtown

directions.arrivals.arrivalTime

string

required

directions.arrivals.minutes

number

required

directions.arrivals.realtime

boolean

required

directions.arrivals.source

string

required

directions.arrivals.destination

string

directions.arrivals.displayDirection

string

directions.arrivals.headsign

string

directions.arrivals.departureTime

string

directions.arrivals.tripId

string

directions.arrivals.raw

any

directions.headsign

string

Subway Route StationsReference for GET /api/v1/subway/routes/{route}/stations. Get the ordered stations a subway route serves, optionally hydrated with arrivals.

Get a nearby subway arrival board

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.mtaapi.dev/api/v1/subway/arrival-board', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "station": {
      "id": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "lat": 123,
      "lon": 123,
      "parentId": "<string>"
    },
    "distanceMeters": 123,
    "directions": [
      {
        "arrivals": [
          {
            "route": {
              "id": "<string>",
              "shortName": "<string>",
              "longName": "<string>",
              "type": 123,
              "color": "<string>",
              "textColor": "<string>"
            },
            "stop": {
              "id": "<string>",
              "name": "<string>",
              "displayName": "<string>",
              "lat": 123,
              "lon": 123,
              "parentId": "<string>"
            },
            "arrivalTime": "<string>",
            "minutes": 123,
            "realtime": true,
            "source": "<string>",
            "destination": "<string>",
            "displayDirection": "<string>",
            "headsign": "<string>",
            "departureTime": "<string>",
            "tripId": "<string>",
            "raw": "<unknown>"
          }
        ],
        "headsign": "<string>"
      }
    ]
  }
]

​SDK

Authorizations

Query Parameters

Response

SDK