Skip to main content
POST
/
search-data
Search across all content
curl --request POST \
  --url https://api.wanderersguide.app/functions/v1/search-data \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "is_advanced": true,
  "type": "trait",
  "content_sources": [
    123
  ],
  "name": "<string>",
  "description": "<string>",
  "rarity": "COMMON",
  "availability": "STANDARD",
  "traits": [
    123
  ],
  "size": "TINY",
  "cost": "<string>",
  "trigger": "<string>",
  "requirements": "<string>",
  "level_min": 123,
  "level_max": 123,
  "rank_min": 123,
  "rank_max": 123,
  "cast": "<string>",
  "traditions": [
    "<string>"
  ],
  "defense": "<string>",
  "range": "<string>",
  "area": "<string>",
  "targets": "<string>",
  "duration": "<string>",
  "spell_type": "FOCUS",
  "actions": "ONE-ACTION",
  "prerequisites": [
    "<string>"
  ],
  "frequency": "<string>",
  "access": "<string>",
  "special": "<string>",
  "ab_type": "action",
  "bulk": "<string>",
  "group": "GENERAL",
  "hands": "<string>",
  "craft_requirements": "<string>",
  "usage": "<string>"
}
'
{
  "status": "success",
  "data": {
    "ability_blocks": [
      {
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "type": "action",
        "content_source_id": 123,
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "operations": [
          {}
        ],
        "actions": "ONE-ACTION",
        "level": 123,
        "availability": "STANDARD",
        "prerequisites": [
          "<string>"
        ],
        "frequency": "<string>",
        "cost": "<string>",
        "trigger": "<string>",
        "requirements": "<string>",
        "access": "<string>",
        "special": "<string>",
        "meta_data": {},
        "traits": [
          123
        ],
        "version": "<string>"
      }
    ],
    "ancestries": [
      {
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "trait_id": 123,
        "artwork_url": "<string>",
        "operations": [
          {}
        ]
      }
    ],
    "archetypes": [
      {
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "trait_id": 123,
        "artwork_url": "<string>",
        "dedication_feat_id": 123
      }
    ],
    "backgrounds": [
      {
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "operations": [
          {}
        ],
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "classes": [
      {
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "operations": [
          {}
        ],
        "skill_training_base": 123,
        "trait_id": 123,
        "artwork_url": "<string>"
      }
    ],
    "creatures": [
      {
        "name": "<string>",
        "level": 123,
        "rarity": "COMMON",
        "details": {
          "image_url": "<string>",
          "background_image_url": "<string>",
          "description": "<string>",
          "adjustment": "ELITE"
        },
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "traits": [
          123
        ],
        "operations": [
          {}
        ],
        "abilities_base": [
          {
            "name": "<string>",
            "rarity": "COMMON",
            "description": "<string>",
            "type": "action",
            "content_source_id": 123,
            "id": 123,
            "created_at": "2023-11-07T05:31:56Z",
            "operations": [
              {}
            ],
            "actions": "ONE-ACTION",
            "level": 123,
            "availability": "STANDARD",
            "prerequisites": [
              "<string>"
            ],
            "frequency": "<string>",
            "cost": "<string>",
            "trigger": "<string>",
            "requirements": "<string>",
            "access": "<string>",
            "special": "<string>",
            "meta_data": {},
            "traits": [
              123
            ],
            "version": "<string>"
          }
        ],
        "abilities_added": [
          123
        ],
        "inventory": {},
        "spells": {},
        "meta_data": {},
        "deprecated": true
      }
    ],
    "items": [
      {
        "name": "<string>",
        "level": 123,
        "rarity": "COMMON",
        "description": "<string>",
        "group": "GENERAL",
        "size": "TINY",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "price": {
          "cp": 123,
          "sp": 123,
          "gp": 123,
          "pp": 123
        },
        "bulk": "<string>",
        "availability": "STANDARD",
        "traits": [
          123
        ],
        "hands": "<string>",
        "craft_requirements": "<string>",
        "usage": "<string>",
        "meta_data": {},
        "operations": [
          {}
        ]
      }
    ],
    "languages": [
      {
        "name": "<string>",
        "description": "<string>",
        "content_source_id": 123,
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "speakers": "<string>",
        "script": "<string>",
        "rarity": "COMMON",
        "availability": "STANDARD"
      }
    ],
    "spells": [
      {
        "name": "<string>",
        "rank": 5,
        "traditions": [
          "<string>"
        ],
        "rarity": "COMMON",
        "description": "<string>",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "availability": "STANDARD",
        "cast": "<string>",
        "traits": [
          123
        ],
        "defense": "<string>",
        "cost": "<string>",
        "trigger": "<string>",
        "requirements": "<string>",
        "range": "<string>",
        "area": "<string>",
        "targets": "<string>",
        "duration": "<string>",
        "heightened": {},
        "meta_data": {}
      }
    ],
    "traits": [
      {
        "name": "<string>",
        "content_source_id": 123,
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "meta_data": {
          "important": true,
          "creature_trait": true,
          "unselectable": true,
          "class_trait": true,
          "ancestry_trait": true,
          "archetype_trait": true,
          "versatile_heritage_trait": true
        }
      }
    ],
    "versatile_heritages": [
      {
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "trait_id": 123,
        "artwork_url": "<string>",
        "heritage_id": 123
      }
    ],
    "class_archetypes": [
      {
        "class_id": 123,
        "name": "<string>",
        "rarity": "COMMON",
        "description": "<string>",
        "content_source_id": 123,
        "version": "<string>",
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "archetype_id": 123,
        "artwork_url": "<string>",
        "operations": [
          {}
        ],
        "feature_adjustments": [
          {
            "fa_id": "<string>",
            "type": "ADD",
            "prev_id": 123,
            "data": {
              "name": "<string>",
              "rarity": "COMMON",
              "description": "<string>",
              "type": "action",
              "content_source_id": 123,
              "id": 123,
              "created_at": "2023-11-07T05:31:56Z",
              "operations": [
                {}
              ],
              "actions": "ONE-ACTION",
              "level": 123,
              "availability": "STANDARD",
              "prerequisites": [
                "<string>"
              ],
              "frequency": "<string>",
              "cost": "<string>",
              "trigger": "<string>",
              "requirements": "<string>",
              "access": "<string>",
              "special": "<string>",
              "meta_data": {},
              "traits": [
                123
              ],
              "version": "<string>"
            }
          }
        ],
        "override_skill_training_base": 123,
        "override_class_operations": true,
        "deprecated": true
      }
    ]
  }
}

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.

Authorizations

​
Authorization
string
header
required

API key created in your Wanderer's Guide account settings. Send as Authorization: Bearer <key>. Used for direct API access from external tools and scripts.

Body

application/json
​
text
string

Simple-mode search text.

​
is_advanced
boolean
​
type
enum<string>
Available options:
trait,
item,
spell,
class,
archetype,
versatile-heritage,
class-archetype,
ability-block,
creature,
ancestry,
background,
language,
content-source
​
content_sources
integer[]
​
name
string
​
description
string
​
rarity
enum<string>
Available options:
COMMON,
UNCOMMON,
RARE,
UNIQUE
​
availability
enum<string>
Available options:
STANDARD,
LIMITED,
RESTRICTED
​
traits
integer[]
​
size
enum<string>
Available options:
TINY,
SMALL,
MEDIUM,
LARGE,
HUGE,
GARGANTUAN
​
cost
string
​
trigger
string
​
requirements
string
​
level_min
integer
​
level_max
integer
​
rank_min
integer
​
rank_max
integer
​
cast
string
​
traditions
string[]
​
defense
string
​
range
string
​
area
string
​
targets
string
​
duration
string
​
spell_type
enum<string>
Available options:
FOCUS,
RITUAL,
NORMAL
​
actions
enum<string> | null
Available options:
ONE-ACTION,
TWO-ACTIONS,
THREE-ACTIONS,
REACTION,
FREE-ACTION,
ONE-TO-TWO-ACTIONS,
ONE-TO-THREE-ACTIONS,
TWO-TO-THREE-ACTIONS,
null
​
prerequisites
string[]
​
frequency
string
​
access
string
​
special
string
​
ab_type
enum<string>
Available options:
action,
feat,
physical-feature,
sense,
class-feature,
heritage,
mode
​
bulk
string
​
group
enum<string>
Available options:
GENERAL,
WEAPON,
ARMOR,
SHIELD,
RUNE,
UPGRADE,
MATERIAL
​
hands
string
​
craft_requirements
string
​
usage
string

Response

200 - application/json

JSend success with the SearchResults envelope.

​
status
enum<string>
Available options:
success
​
data
object