GTFS API conventions

[matikin9]

General Endpoint Naming Conventions

• All GTFS endpoints require an agency_id.
• If no specific value for a parameter is specified at the end, the endpoint will return all values for that parameter.

GTFS-rt Trip Updates

• /{agency_id}/trip_updates/ - (future: return metadata?)
• /{agency_id}/trip_updates/all - Return all trip_updates
• /{agency_id}/trip_updates/{field_name}/{field_value}
  • field_name possible values:
    • trip_id
    • vehicle_id
  • field_value possible values:
    • list - Return all unique values for this field as a subset of the trip_updates data
    • {trip_id} - Return a singular trip_update for the trip_id provided. (future: multiple comma-separated trip_ids return trip_updates for each trip_id)

GTFS-rt Vehicle Positions

• /{agency_id}/vehicle_positions/ - (future: return metadata?)
• /{agency_id}/vehicle_positions/all - Return all vehicle_positions
• /{agency_id}/vehicle_positions/{field_name}/{field_value}
  • field_name possible values:
    • vehicle_id
  • field_value possible values:
    • list - Return all unique values for this field as a subset of the vehicle_positions data
    • {vehicle_id} - Return a singular vehicle_position for the vehicle_id provided. (future: multiple comma-separated vehicle_ids return vehicle_positions for each vehicle_id)

[matikin9]

More fields we can add filters for:

• Trip Updates

  • route_id
  • stop_id

• Vehicle Postions

  • trip_id
  • trip_route_id
  • stop_id

[matikin9]

Notes:

• LACMTA_Rail's trip_updats data doesn't include vehicle_id