# Poedb — 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 comprehensive Path of Exile game data including items, gems, leagues, and game mechanics like bleeding effects across both PoE 1 and PoE 2. Get detailed information about specific items and categories, or browse current league information to stay updated on the latest game content.

**Category:** Entertainment | **Website:** [poedb.tw/](https://poedb.tw/) | **Docs:** [parse.bot/marketplace/121030b1-2e10-42ef-a868-99e4e4c9a574/poedb-tw-api](https://parse.bot/marketplace/121030b1-2e10-42ef-a868-99e4e4c9a574/poedb-tw-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-poedb-tw-api-121030b1/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_category_data

Get items and their properties for a specific category page. Returns card sections with tabular data parsed from the category page. Each card has a title and an items array containing row data extracted from tables.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Category name as it appears in the URL path (e.g., 'Unique_item', 'Gem', 'League', 'Bleeding', 'Maps') |
| `version` | string | No | Game version: 'poe1' or 'poe2' |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-poedb-tw-api-121030b1/get_category_data \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","version":"<string>"}'
```

### get_details

Fetch detailed data for a specific game entity using its slug. Returns structured sections with tables and text content parsed from the entity's wiki-style page. Each section corresponds to a card block on the page (quests, stats, related items, etc.).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `slug` | string | Yes | URL slug for the entity (e.g., 'Fireball', 'Bleeding', 'Headhunter'). Obtainable from search endpoint results[*].value. |
| `version` | string | No | Game version: 'poe1' or 'poe2' |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-poedb-tw-api-121030b1/get_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug":"<string>","version":"<string>"}'
```

### get_leagues

Get information about game leagues including version, name, duration, and dates. Returns card sections with league lists and related data. This is equivalent to calling get_category_data with category='League'.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `version` | string | No | Game version: 'poe1' or 'poe2' |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-poedb-tw-api-121030b1/get_leagues \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"<string>"}'
```

### search

Search for game entities (items, gems, passives, monsters, etc.) by keyword against the autocomplete index. Returns matching labels and their URL slugs. Performs a case-insensitive substring match on entity labels. The full index is fetched on each call so broad queries may return many results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword to match against entity labels (case-insensitive substring match) |
| `version` | string | No | Game version: 'poe1' or 'poe2' |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-poedb-tw-api-121030b1/search \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>","version":"<string>"}'
```
