API reference
Every route in batch 1, grouped by resource.
The full, machine-readable contract is in OpenAPI (v1.json). The pages below explain each resource in words.
Conventions
- JSON,
camelCase, opaque identifiers. - Calendar dates
YYYY-MM-DD; timestampsISO 8601, UTC. - Amounts as decimal strings, with the currency alongside (
"budget": "700.00", "currency": "EUR"). - Single response:
{ "data": … }. List:{ "data": […], "hasMore": …, "nextCursor": … }. - All list routes accept
limit(at most 20) andcursor.
Resources
| Resource | Routes |
|---|---|
| Listings | GET /listings, /listings/{ref}, /listings/mine |
| Offers | GET /listings/{ref}/offers, /offers/mine, /offers/{id} |
| Free vehicles | GET /vehicles, /vehicles/{id}, /vehicles/mine |
| Places and cost | GET /places, /cost-estimate |
| Companies | GET /companies/{id} |
| Events | GET /events/types (catalog; delivery is planned) |
Authentication
Authorization: Bearer ajk_live_…, optional on public routes (it ties the cursor and limits to the key, not the address), required on the rest. See Authenticating with keys.
Errors
A single format, with a stable requestId for support. See Errors.