Skip to content

OBA API Specs

Eric Jutrzenka edited this page May 11, 2026 · 8 revisions

OBA API Endpoint Specifications

Cockburn-style use case specs generated from the live Java implementation. Each page covers accepted parameters, response structure, error conditions, and suspected defects.

Endpoints

Endpoint Page
agencies-with-coverage [[agencies-with-coverage
GET /api/where/agency/{id} [[GET /api/where/agency/{id}
arrival-and-departure-for-stop [[arrival-and-departure-for-stop
arrivals-and-departures-for-stop [[arrivals-and-departures-for-stop
block / block-instance [[block / block-instance
config [[config
Use Case: current-time [[Use Case: current-time
GET /api/where/route/{id} [[GET /api/where/route/{id}
route-ids-for-agency [[route-ids-for-agency
routes-for-agency / route-ids-for-agency [[routes-for-agency / route-ids-for-agency
routes-for-location [[routes-for-location
schedule-for-route [[schedule-for-route
schedule-for-stop [[schedule-for-stop
Use Case: Retrieve Shape [[Use Case: Retrieve Shape
Use Case: Retrieve Stop IDs for Agency [[Use Case: Retrieve Stop IDs for Agency
stops-for-agency [[stops-for-agency
stops-for-location [[stops-for-location
stops-for-route [[stops-for-route
Use Case: Get Stop [[Use Case: Get Stop
trip-details [[trip-details
trip-for-vehicle [[trip-for-vehicle
trips-for-location [[trips-for-location
trips-for-route [[trips-for-route
Use Case: Get Trip [[Use Case: Get Trip
Use Case: Get Vehicles for Agency [[Use Case: Get Vehicles for Agency

Search

Endpoint Page
search/route — Route Name Search [[search/route — Route Name Search
Search: Stop [[Search: Stop

Last updated: 2026-05-11T23:13:08Z

Clone this wiki locally