Spiral Knights Market API
Licence
The data is published under CC BY 4.0: use it for anything, with credit.
Spiral Knights market data from spiralknights.marketThe machine-readable description of this API can be found at /v1/openapi.json.
About
This API provides public, read-only access to Spiral Knights Market's energy and auction house data as seen on energy.spiralknights.market and auction.spiralknights.market.
| Base URL | https://api.spiralknights.market |
|---|---|
| Rate limit | 120 requests per minute per IP |
Conventions
| Item | All API uses an item's slug as an item identifier. Item display names and categories can be queried via /v1/auction/items. |
|---|---|
| Time | Time is provided as ISO 8601 UTC in responses. |
| Paging | List queries return next_cursor in responses. Pass it back as cursor for the next page for the query. A null next_cursor in responses means there are no more pages. |
Errors
Every error has the same body, with the HTTP status set to match.
{ "error": { "code": "bad_request", "message": "from must be before to" } }| Status | Code | Meaning |
|---|---|---|
| 400 | bad_request | A parameter is missing or invalid. |
| 429 | rate_limited | Over the rate limit. |
| 503 | unavailable | The dataset cannot be read right now. |
Loading
About
Listings and sales identify items by slug only. To show them with names, request the listings, then
look up their slugs in one call.
GET /v1/auction/listings?category=SWORD&limit=2
{
"total": 68,
"next_cursor": "eyJvIjoyfQ",
"listings": [
{ "auction_id": 32242453, "slug": "Nightblade", "variant": null, "buy_price": 10000, ... },
{ "auction_id": 32239715, "slug": "Troika", "variant": null, "buy_price": 2500, ... }
]
}
GET /v1/auction/items/lookup?slug=Nightblade&slug=Troika
{
"items": [
{ "slug": "Nightblade", "name": "Nightblade", "category": "SWORD", "variants": [] },
{ "slug": "Troika", "name": "Troika", "category": "SWORD", "variants": [] }
],
"unknown": []
}The lookup takes up to 25 slugs per call and is cached for an hour, so a page of listings costs one extra request.
Loading