API
Public /api/v1 catalog for this site and Shelf of Holding. Browse adventures, enemies, and mini links without authentication.
Interactive docs
Explore every endpoint, schema, and Try it out against this origin.
Authentication
Catalog GET endpoints are public. Recommendations and adventure submissions require a signed-in user and an Authorization: Bearer <firebase-id-token> header.
# Public catalog read
curl "https://miniledger.futurehax.com/api/v1/adventures"
Rate limits
POST /api/v1/recommendations is limited to 10 requests per hour per Firebase uid. Exceeded limits return 429 with a Retry-After header (seconds until retry).
Mini catalog
Each mini is in one browser group, in this order: Pirates, Skeletons, Zombies, Redcoats, Ships, Props, NPCs, Creatures, Others. GET /api/v1/minis does not filter by group. POST /api/v1/recommendations category accepts the same ids: pirates, skeletons, zombies, redcoats, ships, props, npcs, creatures, others.
format is stl, token, model, or physical.
price, when present, has amount, currency, and label. The label is the stored sale unit: Free when the amount is 0; Set price for a paid offer with more than one mini (crew, marine, or boxed set); Model price for a paid single mini (one ship model or one figure); Set price. Deckhand and up get it free. for a FutureHax paid set; Naval token pack price for a Punch-Out naval token.
Display rule, not a stored field: the card heading reads Set Price only when the offer includes more than one mini (Punch-Out token sets, FutureHax ship sets, multi-figure packs) and Individual Price for a single mini, including a single physical figure. Free and missing prices have no heading. The API does not return that heading.
Props rows are browse-only and have no actor links. Current rows: Hand Pointer, FutureHax Jolly Rogenerator Dice Box, and FutureHax Compatible with Pirate Borg Dice Box.
Endpoints
Base path /api/v1. Full request and response schemas live in Swagger.
Adventures
/api/v1/adventuresList adventures A to Z, with optional search and filters.
/api/v1/adventures/{id}Get one adventure with its actors and the mini options linked to each.
Actors
/api/v1/actorsList Foundry-sourced enemies, optionally by adventure.
Minis
/api/v1/minisList catalog minis. Groups are Pirates, Skeletons, Zombies, Redcoats, Ships, Props, NPCs, Creatures, then Others. Format is stl, token, model, or physical. Optional price is amount, currency, and a sale-unit label.
Recommendations
/api/v1/recommendationsSubmit a mini suggestion for an adventure enemy (Bearer required). category is a browser group id, including props, npcs, and creatures.
Adventure submissions
/api/v1/adventure-submissionsSubmit an adventure for catalog review (Bearer required; Discord intake).
Meta
/api/v1/openapiOpenAPI 3.0 specification as JSON.
/api/v1/docsRedirect to the interactive Swagger UI.
Error codes
Errors use a JSON envelope: { error, code, details? }.
unauthorizedMissing or invalid Firebase ID token.
invalid_argumentRequest validation failed.
invalid_jsonRequest body is not valid JSON.
rate_limitedToo many requests; see the Retry-After header.
not_foundRequested resource was not found.
internal_errorUnexpected server error.
Next steps