Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wanderersguide.app/llms.txt

Use this file to discover all available pages before exploring further.

This walks through the smallest useful request: looking up the spell Fireball by name. The same shape works for find-item, find-creature, find-ability-block, and every other find-* endpoint.

1. Get an API key

  1. Sign in at wanderersguide.app.
  2. Open your account settings and find the API Clients section.
  3. Create a new client. Copy the 36-character key. It’s shown once.
See Authentication if you’d rather use a Supabase JWT.

2. Make the request

curl -X POST https://api.wanderersguide.app/functions/v1/find-spell \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Fireball"}'

3. Read the response

{
  "status": "success",
  "data": [
    {
      "id": 1234,
      "name": "Fireball",
      "rank": 3,
      "traditions": ["arcane", "primal"],
      "description": "...",
      "content_source_id": 1,
      "version": "1.0.0"
    }
  ]
}
A few quirks worth knowing up front:
  • data is sometimes an array, sometimes a single object. When you pass a single integer id, you get one object (or null). Otherwise you get an array.
  • Filtering by name is exact, case-insensitive. Need fuzzy match? Use /search-data instead.
  • By default, only official published content is returned. Pass content_sources (an array of source ids) to scope to specific books, including any homebrew sources you own.

What to try next