Skip to content

Public API endpoints

API entrypoint

GET /

Provides basic information about this Transiter instance and the Transit systems it contains.

Request type: EntrypointRequest

Request payload for the entrypoint endpoint.

No fields.

Response type: EntrypointReply

Response payload for the entrypoint endpoint.

Field Type Description
transiter EntrypointReply.TransiterDetails Version and other information about this Transiter binary.
systems ChildResources Systems that are installed in this Transiter instance.

EntrypointReply.TransiterDetails

Message containing version information about a Transiter binary.

Field Type Description
version string The version of the Transiter binary this instance is running.
href string URL of the Transiter GitHub respository.
build EntrypointReply.TransiterDetails.Build Information about the CI build invocation that built this Transiter binary.

EntrypointReply.TransiterDetails.Build

Message containing information about a specific Transiter CI build.

Field Type Description
number string The GitHub build number.
built_at string Time the binary was built, in the form of a human readable string.
built_at_timestamp string Time the binary was built, in the form of a Unix timestamp.
git_commit_hash string Hash of the Git commit that the binary was built at.
href string URL of the GitHub actions CI run.

List systems

GET /systems

List all transit systems that are installed in this Transiter instance.

Request type: ListSystemsRequest

Request payload for the list systems endpoint.

No fields.

Response type: ListSystemsReply

Response payload for the list systems endpoint.

Field Type Description
systems System List of systems.

Get system

GET /systems/<system_id>

Get a system by its ID.

Request type: GetSystemRequest

Request payload for the get system endpoint.

Field Type Description
system_id string ID of the system to get.

This is a URL parameter in the HTTP API.

Response type: System

List agencies

GET /systems/<system_id>/agencies

List all agencies in a system.

Request type: ListAgenciesRequest

Request payload for the list agencies endpoint.

Field Type Description
system_id string ID of the system for which to list agencies.

This is a URL parameter in the HTTP API.

Response type: ListAgenciesReply

Response payload for the list agencies endpoint.

Field Type Description
agencies Agency List of agencies.

Get agency

GET /systems/<system_id>/agencies/<agency_id>

Get an agency in a system by its ID.

Request type: GetAgencyRequest

Request payload for the get agency endpoint.

Field Type Description
system_id string ID of the system the agency is in.

This is a URL parameter in the HTTP API.
agency_id string ID of the agency.

This is a URL parameter in the HTTP API.

Response type: Agency

List stops

GET /systems/<system_id>/stops/<stop_id>

List all stops in a system.

This endpoint is paginated. If there are more results, the next_id field of the response will be populated. To get more results, make the same request with the first_id field set to the value of next_id in the response.

Request type: ListStopsRequest

Request payload for the list stops endpoint.

Field Type Description
system_id string ID of the system for which to list stops.

This is a URL parameter in the HTTP API.
only_return_specified_ids bool If true, only return stops whose IDs are specified in the repeated id field.
id string IDs to return if only_return_specified_ids is set to true. It is an error to populate this field if only_return_specified_ids is false.
first_id string ID of the first stop to return. If not set, the stop with the smallest ID will be first.
limit int32 Maximum number of stops to return.
skip_stop_times bool If true, the stop times field will not be populated. This will generally make the response faster to generate.
skip_service_maps bool If true, the service maps field will not be populated. This will generally make the response faster to generate.
skip_alerts bool If true, the alerts field will not be populated. This will generally make the response faster to generate.
skip_transfers bool If true, the transfers field will not be populated. This will generally make the response faster to generate.

Response type: ListStopsReply

Response payload for the list stops endpoint.

Field Type Description
stops Stop List of stops.
next_id string ID of the next stop to return, if there are more results.

Get stop

GET /systems/<system_id>/stops/<stop_id>

Get a stop in a system by its ID.

Request type: GetStopRequest

Reqeust payload for the get stop endpoint.

Field Type Description
system_id string ID of the system the stop is in.

This is a URL parameter in the HTTP API.
stop_id string ID of the stop.

This is a URL parameter in the HTTP API.
skip_stop_times bool If true, the stop times field will not be populated. This will generally make the response faster to generate.
skip_service_maps bool If true, the service maps field will not be populated. This will generally make the response faster to generate.
skip_alerts bool If true, the alerts field will not be populated. This will generally make the response faster to generate.
skip_transfers bool If true, the transfers field will not be populated. This will generally make the response faster to generate.

Response type: Stop

List routes

GET /systems/<system_id>/routes

List all routes in a system.

Request type: ListRoutesRequest

Request payload for the list routes endpoint.

Field Type Description
system_id string ID of the system for which to list routes.

This is a URL parameter in the HTTP API.
skip_estimated_headways bool If true, the estimated headway fields will not be populated. This will generally make the response faster to generate.
skip_service_maps bool If true, the service maps field will not be populated. This will generally make the response faster to generate.
skip_alerts bool If true, the alerts field will not be populated. This will generally make the response faster to generate.

Response type: ListRoutesReply

Response payload for the list routes endpoint.

Field Type Description
routes Route List of routes.

Get route

GET /systems/<system_id>/routes/<route_id>

Get a route in a system by its ID.

Request type: GetRouteRequest

Request payload for the get route endpoint.

Field Type Description
system_id string ID of the system the route is in.

This is a URL parameter in the HTTP API.
route_id string ID of the route.

This is a URL parameter in the HTTP API.
skip_estimated_headways bool If true, the estimated headway field will not be populated. This will generally make the response faster to generate.
skip_service_maps bool If true, the service maps field will not be populated. This will generally make the response faster to generate.
skip_alerts bool If true, the alerts field will not be populated. This will generally make the response faster to generate.

Response type: Route

List trips

GET /systems/<system_id>/routes/<route_id>/trips

List all trips in a route.

Request type: ListTripsRequest

Request payload for the list trips endpoint.

Field Type Description
system_id string ID of the system the route is in.

This is a URL parameter in the HTTP API.
route_id string ID of the route for which to list trips

This is a URL parameter in the HTTP API.

Response type: ListTripsReply

Response payload for the list trips endpoint.

Field Type Description
trips Trip List of trips.

Get trip

GET /systems/<system_id>/routes/<route_id>/trips/<trip_id>

Get a trip by its ID.

Request type: GetTripRequest

Request payload for the get trip endpoint.

Field Type Description
system_id string ID of the system the trip is in.

This is a URL parameter in the HTTP API.
route_id string ID of the route the trip is in.

This is a URL parameter in the HTTP API.
trip_id string ID of the route.

This is a URL parameter in the HTTP API.

Response type: Trip

List alerts

GET /systems/<system_id>/alerts

List all alerts in a system. By default this endpoint returns both active alerts (alerts which have an active period containing the current time) and non-active alerts.

Request type: ListAlertsRequest

Request payload for the list alerts endpoint.

Field Type Description
system_id string ID of the system for which to list alerts.

This is a URL parameter in the HTTP API.
alert_id string If non-empty, only alerts with the provided IDs are returned. This is interpreted as a filtering condition, so it is not an error to provide non-existent IDs.

If empty, all alerts in the system are returned. TODO: add a boolean filter_on_alert_ids field

Response type: ListAlertsReply

Response payload for the list alerts endpoiont.

Field Type Description
alerts Alert List of alerts.

Get alert

GET /systems/<system_id>/alerts/<alert_id>

Get an alert by its ID.

Request type: GetAlertRequest

Request payload for the get alert endpoint.

Field Type Description
system_id string ID of the system the alert is in.

This is a URL parameter in the HTTP API.
alert_id string ID of the alert.

This is a URL parameter in the HTTP API.

Response type: Alert

List transfers

GET /systems/<system_id>/transfers

List all transfers in a system.

Request type: ListTransfersRequest

Request payload for the list transfers endpoint.

Field Type Description
system_id string ID of the system for which to list transfers.

Response type: ListTransfersReply

Response payload for the list transfers endpoint.

Field Type Description
transfers Transfer List of transfers.

List feeds

GET /systems/<system_id>/feeds

List all feeds for a system.

Request type: ListFeedsRequest

Request payload for the list feeds endpoint.

Field Type Description
system_id string ID of the system for which to list feeds.

Response type: ListFeedsReply

Response payload for the list feeds endpoint.

Field Type Description
feeds Feed List of feeds.

Get feed

GET /systems/<system_id>/feeds/<feed_id>

Get a feed in a system by its ID.

Request type: GetFeedRequest

Request payload for the get feed endpoint.

Field Type Description
system_id string ID of the system the feed is in.

This is a URL parameter in the HTTP API.
feed_id string ID of the feed.

This is a URL parameter in the HTTP API.

Response type: Feed

List feed updates

GET /systems/<system_id>/feeds/<feed_id>/updates

List feeds updates for a feed.

Request type: ListFeedUpdatesRequest

Request payload for the list feed updates endpoint.

Field Type Description
system_id string ID of the system the feed is in.

This is a URL parameter in the HTTP API.
feed_id string ID of the feed for which to list updates.

This is a URL parameter in the HTTP API.

Response type: ListFeedUpdatesReply

Response payload for the list feed updates endpoint.

Field Type Description
updates FeedUpdate List of updates.