mta.bus.routeStops() — ordered stops on a route

GET

https://www.mtaapi.dev

api

bus

routes

{route}

stops

Get ordered bus stops for a route

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

fetch('https://www.mtaapi.dev/api/v1/bus/routes/{route}/stops', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "route": {
    "id": "<string>",
    "shortName": "<string>",
    "longName": "<string>",
    "type": 123,
    "color": "<string>",
    "textColor": "<string>"
  },
  "directions": [
    {
      "direction": "<string>",
      "stops": [
        {
          "id": "<string>",
          "name": "<string>",
          "displayName": "<string>",
          "lat": 123,
          "lon": 123,
          "parentId": "<string>",
          "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>"
            }
          ]
        }
      ],
      "headsigns": [
        "<string>"
      ]
    }
  ]
}

Returns the ordered stops a bus route serves. Pass the route in the path (for example M23) and an optional direction filter. Set includeArrivals=true to attach live arrivals to each stop (bounded by limitArrivals and limitStops). The response is a RouteStopsResponse: { route, mode, directions: [{ direction, headsigns?, stops: [...] }] }, where each stop carries an optional arrivals array when hydrated.

SDK

const routeStops = await mta.bus.routeStops({ route: 'M23' })

for (const pattern of routeStops.directions) {
  console.log(pattern.direction, pattern.stops.length, 'stops')
}

See the Routes & Stations guide.

Authorizations

Authorization

string

header

required

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

Path Parameters

route

string

required

Minimum string length: 1

Query Parameters

direction

string

Minimum string length: 1

includeArrivals

boolean

limitArrivals

number

Required range: 1 <= x <= 10

limitStops

number

Maximum total stops to hydrate when includeArrivals=true.

Required range: 1 <= x <= 20

includeRaw

boolean

Response

200 - application/json

Response for status 200

route

object

required

Hide child attributes

route.id

string

required

route.shortName

string

route.longName

string

route.type

number

route.color

string

route.textColor

string

mode

enum<string>

required

Available options:

subway,

bus

directions

object[]

required

Hide child attributes

directions.direction

string

required

directions.stops

object[]

required

Hide child attributes

directions.stops.id

string

required

directions.stops.name

string

required

directions.stops.displayName

string

directions.stops.lat

number

directions.stops.lon

number

directions.stops.mode

enum<string>

Available options:

subway,

bus

directions.stops.parentId

string

directions.stops.arrivals

object[]

Hide child attributes

directions.stops.arrivals.mode

enum<string>

required

Available options:

subway,

bus,

lirr,

metro-north

directions.stops.arrivals.route

object

required

Hide child attributes

directions.stops.arrivals.route.id

string

required

directions.stops.arrivals.route.shortName

string

directions.stops.arrivals.route.longName

string

directions.stops.arrivals.route.type

number

directions.stops.arrivals.route.color

string

directions.stops.arrivals.route.textColor

string

directions.stops.arrivals.stop

object

required

Hide child attributes

directions.stops.arrivals.stop.id

string

required

directions.stops.arrivals.stop.name

string

required

directions.stops.arrivals.stop.displayName

string

directions.stops.arrivals.stop.lat

number

directions.stops.arrivals.stop.lon

number

directions.stops.arrivals.stop.mode

enum<string>

Available options:

subway,

bus

directions.stops.arrivals.stop.parentId

string

directions.stops.arrivals.direction

enum<string>

required

Available options:

north,

south,

east,

west,

unknown,

uptown,

downtown

directions.stops.arrivals.arrivalTime

string

required

directions.stops.arrivals.minutes

number

required

directions.stops.arrivals.realtime

boolean

required

directions.stops.arrivals.source

string

required

directions.stops.arrivals.destination

string

directions.stops.arrivals.displayDirection

string

directions.stops.arrivals.headsign

string

directions.stops.arrivals.departureTime

string

directions.stops.arrivals.tripId

string

directions.stops.arrivals.raw

any

directions.headsigns

string[]

RoutesReference for GET /api/v1/routes. List the catalog of subway and bus routes, with names, colors, and transit mode.

Get ordered bus stops for a route

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

fetch('https://www.mtaapi.dev/api/v1/bus/routes/{route}/stops', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "route": {
    "id": "<string>",
    "shortName": "<string>",
    "longName": "<string>",
    "type": 123,
    "color": "<string>",
    "textColor": "<string>"
  },
  "directions": [
    {
      "direction": "<string>",
      "stops": [
        {
          "id": "<string>",
          "name": "<string>",
          "displayName": "<string>",
          "lat": 123,
          "lon": 123,
          "parentId": "<string>",
          "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>"
            }
          ]
        }
      ],
      "headsigns": [
        "<string>"
      ]
    }
  ]
}

​SDK

Authorizations

Path Parameters

Query Parameters

Response

SDK