openbart / docs

overview

openbart is an open-source REST JSON API for Bay Area Rapid Transit (BART) data. it bundles the static schedule, real-time trip updates, service alerts, and rolled-up line health into a single simple API.

all endpoints are GET, return JSON, and are served from https://openbart.com. the base path is /api/v1.

CORS is enabled for all origins, so you can call the API directly from a browser.

authentication

the API is open and works with no authentication. if you want a higher rate limit, pass an API key on every request using one of:

Authorization: Bearer <your-key>
X-API-Key: <your-key>

keys look like ob_sk_.... see rate limits below for how to request one.

rate limits

every response includes these headers so you can track usage:

X-RateLimit-Limit:     <your limit per minute>
X-RateLimit-Remaining: <requests left in this window>
X-RateLimit-Reset:     <unix timestamp when the window resets>

when you exceed the limit you'll get a 429 response with a Retry-After header.

need a higher limit, or want another transit agency indexed alongside BART? reach out to @theharryet on twitter.

responses

single resources are returned directly as a JSON object:

{ "id": "DBRK", "name": "Downtown Berkeley", ... }

list endpoints use a consistent pagination envelope:

{
  "items": [...],
  "pagination": { "offset": 0, "limit": 50, "total": 234 }
}

pagination params: ?offset=0&limit=50 (default 50, max 200).

errors return a standard shape with a matching HTTP status:

{ "error": { "code": "NOT_FOUND", "message": "Stop 'FAKE' not found" } }

endpoints