# BG3 Wiki — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and retrieve detailed information about Baldur's Gate 3 classes, subclasses, spells, items, quests, and other game content from the official wiki. Build character guides, plan builds, and look up game mechanics without leaving your app.

**Category:** Entertainment | **Website:** [bg3.wiki/](https://bg3.wiki/) | **Docs:** [parse.bot/marketplace/dae5b814-425b-4281-acf8-58f8a99d81af/bg3-wiki-api](https://parse.bot/marketplace/dae5b814-425b-4281-acf8-58f8a99d81af/bg3-wiki-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_class

Retrieve detailed information for a specific character class, including proficiencies, progression table parameters, and subclasses. The progression object keys vary by class.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `class_name` | string | Yes | Name of the class. Accepted values: Barbarian, Bard, Cleric, Druid, Fighter, Monk, Paladin, Ranger, Rogue, Sorcerer, Warlock, Wizard. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/get_class \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"class_name":"<string>"}'
```

### get_item

Retrieve details for a specific item including type, rarity, damage, weight, price, and unique identifier. Fields like damage/damage_type are present only for weapons; armour_class is present only for armour.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `item_name` | string | Yes | Name of the item (e.g. Everburn Blade, Amulet of Greater Health) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/get_item \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"item_name":"<string>"}'
```

### get_quest

Retrieve quest information including description and section headings. Automatically follows wiki redirects for variant spellings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `quest_name` | string | Yes | Name of the quest (e.g. Escape the Nautiloid, Find the Githyanki Creche) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/get_quest \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quest_name":"<string>"}'
```

### get_spell

Retrieve full details for a specific spell including level, school, damage, range, cost, AoE, concentration status, and which classes can cast it.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `spell_name` | string | Yes | Name of the spell (e.g. Fireball, Magic Missile, Eldritch Blast) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/get_spell \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spell_name":"<string>"}'
```

### get_subclass

Retrieve detailed information for a specific subclass, including features and parent class name.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `subclass_name` | string | Yes | Name of the subclass (e.g. Berserker, Wildheart, Oath of Devotion) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/get_subclass \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"subclass_name":"<string>"}'
```

### list_classes

List all playable classes in Baldur's Gate 3. Returns the 12 base classes with their wiki URLs. No pagination — the full list is returned in one call.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/list_classes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### list_items_by_category

List items by category from the wiki. For composite categories like Armour, automatically combines Light, Medium, and Heavy subcategories. Returns item names with wiki URLs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Category name (e.g. Weapons, Amulets, Armour, Light Armour, Greatswords, Staves, Shields, Rings, Clothing) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/list_items_by_category \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>"}'
```

### list_spells

List spells from the wiki, optionally filtered by level, school of magic, or class. Only one filter is applied at a time with priority: level > school > class. Without filters returns all spells.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `class` | string | No | Filter by class name |
| `level` | string | No | Filter by spell level (0-6) |
| `school` | string | No | Filter by school of magic |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/list_spells \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"class":"<string>","level":"<string>","school":"<string>"}'
```

### search_wiki

Search the BG3 wiki by keyword. Returns up to 20 results with titles, text snippets, and URLs.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search term |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-bg3-wiki-api-dae5b814/search_wiki \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```
