GET routes

mbta.com:boston-mbta-transit

Summary:
Operation ID: ApiWeb.RouteController.index
Auth: unknown

Parameters (11)

fields[route] (string, query, optional)

Fields to include with the response. Multiple fields **MUST** be a comma-separated (U+002C COMMA, ",") list. Note that fields can also be selected for included data types: see the [V3 API Best Practices](https://www.mbta.com/developers/v3-api/best-practices) for an example.

filter[date] (string, query, optional)

Filter by date that route is active The active date is the service date. Trips that begin between midnight and 3am are considered part of the previous service day. The format is ISO8601 with the template of YYYY-MM-DD.

filter[direction_id] (string, query, optional)

Filter by direction of travel along the route. Must be used in conjuction with `filter[route]` to apply. The meaning of `direction_id` varies based on the route. You can programmatically get the direction names from `/routes` `/data/{index}/attributes/direction_names` or `/routes/{id}` `/data/attri...

Constraints: {'enum': ['0', '1']}

filter[id] (string, query, optional)

Filter by multiple IDs. Multiple IDs **MUST** be a comma-separated (U+002C COMMA, ",") list.

filter[listed_route] (string, query, optional)

Filter by whether route should be publicly listed. Set to 'true' to return only listed routes, 'false' to return all routes. If not provided, defaults to showing only listed routes (same as 'true').

filter[stop] (string, query, optional)

Filter by `/data/{index}/relationships/stop/data/id`. Multiple IDs **MUST** be a comma-separated (U+002C COMMA, ",") list.

filter[type] (string, query, optional)

| Value | Name | Example | |-------|---------------|------------| | `0` | Light Rail | Green Line | | `1` | Heavy Rail | Red Line | | `2` | Commuter Rail | | | `3` | Bus | | | `4` | Ferry | | Multiple `route_type` **M...

include (string, query, optional)

Relationships to include. * `stop` * `line` * `route_patterns` The value of the include parameter **MUST** be a comma-separated (U+002C COMMA, ",") list of relationship paths. A relationship path is a dot-separated (U+002E FULL-STOP, ".") list of relationship names. [JSONAPI "include" behavior](ht...

page[limit] (integer, query, optional)

Max number of elements to return

page[offset] (integer, query, optional)

Offset (0-based) of first element in the page

sort (string, query, optional)

Results can be [sorted](http://jsonapi.org/format/#fetching-sorting) by the id or any `/data/{index}/attributes` key. Assumes ascending; may be prefixed with '-' for descending | JSON pointer | Direction | `sort` | |--------------|-----------|------------| | `/data/{index}/attributes/color` | a...

Constraints: {'enum': ['color', '-color', 'description', '-description', 'direction_destinations', '-direction_destinations', 'direction_names', '-direction_names', 'fare_class', '-fare_class', 'listed_route', '-listed_route', 'long_name', '-long_name', 'short_name', '-short_name', 'sort_order', '-sort_order', 'text_color', '-text_color', 'type', '-type']}

No probe data for this endpoint yet.