Getting started

Errors and rate limits

An error from the API comes with a stable code to branch on, and a message for people.

Error codes

401unauthorizedThe key is missing, malformed, unknown or revoked.

403api_not_enabledRoundPlan has not turned on API access for the agency.

403subscription_inactiveThe agency's trial expired or its subscription ended.

403insufficient_scopeThe key cannot read this endpoint. See Permissions.

400invalid_requestA query parameter is not valid. The message says which.

404not_foundNothing with that id in the agency. For an itinerary, also: the trip has none yet, or the option asked for is no longer shown to the client.

429rate_limitedToo many requests. Wait the seconds in Retry-After.

500internal_errorSomething went wrong on our side. Retry later.

Maintenance

During a planned maintenance window every endpoint answers 503 with a Retry-After header and the body { "error": "…", "maintenance": true }. That body predates the error envelope and has no code: check the status.

Rate limits

Each key may make 120 requests a minute, and an agency 600 across all its keys. Over the limit you get 429 and a Retry-After header with the seconds to wait. A request that reaches the count also gets X-RateLimit-Limit and X-RateLimit-Remaining: this key's limit and what is left of it this minute. They are missing when the request stops before the count: a missing, wrong or revoked key, API access off, or a billing lock. If the counter itself is briefly unavailable the request is let through without them; the other checks still apply.