Caravan Online public API
Read-only game data for tools, sites and statistics. Free.
Keys and limits
- Make up to 3 keys in Settings → Account → API keys. A key is shown once, when it is made; revoke a key there.
- Send the key in the X-API-Key header of every request.
- All keys of one account share one limit: 60 requests a minute, up to 30 at once. Past it the API answers 429 with Retry-After (seconds).
- Without a valid key: 401. While the API is closed: 503.
Endpoints
| Request | Fields |
|---|---|
| GET /api/v1/version | api (shape version), build (client build), server (server version) |
| GET /api/v1/online | total (players in the game); regions: region, players |
| GET /api/v1/guilds | guilds (top 100): rank, name, tag, score, change7d, members |
| GET /api/v1/market | towns: town, items: item, tier, grade, currency, bestBuy, bestSell, buyQuantity, sellQuantity |
- Every answer also has generated and next: Unix seconds of this snapshot and of the next one.
- The server rewrites the data every 5 minutes. Answers carry Cache-Control max-age=300 and an ETag; send If-None-Match to get 304.
- bestBuy is the highest buy order and bestSell the lowest sell order, null when there is none. Prices are per item in the currency's unit; gold is counted in hundredths.
- Any website may call the API from a browser (CORS, GET only).
- No live positions of players, monsters or resources are published.
Rules
- Allowed: tools, sites, bots in chat apps and statistics that read these endpoints.
- Not allowed: macros or programs that play the game, and clones or private servers of the game.
- The Terms of Service apply to every use. A key that breaks them is revoked.