# Wynncraft — 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.

> Access detailed Wynncraft game information to look up item metadata and search across the complete item database, retrieve player statistics and character inventories, and browse guild information and global search results. Use this data to compare gear, track player progress, analyze guild rosters, or build tools for the Wynncraft community.

**Category:** Entertainment | **Website:** [wynncraft.com/](https://wynncraft.com/) | **Docs:** [parse.bot/marketplace/bfab0ae5-e080-4872-83be-6be33d44b6cc/wynncraft-com-api](https://parse.bot/marketplace/bfab0ae5-e080-4872-83be-6be33d44b6cc/wynncraft-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/wynncraft/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get guild stats

Returns statistics and member list for a guild. Includes level, wars, territories, season ranks, banner, and members organized by rank (owner, chief, strategist, captain, recruiter, recruit). Each member entry has UUID, online status, contributed XP, joined date, and globalData.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `guild_name` | string | Yes | Guild name (case-insensitive). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/get-guild-stats \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"guild_name":"<string>"}'
```

### Get item database full

Returns the full item database by iterating all pages. May take up to ~60 seconds to complete.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/get-item-database-full \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get item database paginated

Returns a paginated list of items from the database. Each page contains 20 items. Pagination metadata is in controller (count, pages, current, next, prev). Items include displayName, type, subType, tier, identifications, base stats, and requirements.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number (1-indexed). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/get-item-database-paginated \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>"}'
```

### Get item metadata

Returns metadata for item filters and identifications. Includes possible values for types, tiers, attack speeds, identification stat names, major IDs, and level ranges.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/get-item-metadata \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### Get player characters

Returns all characters for a player as a list. Each character includes uuid, type (WARRIOR, ARCHER, MAGE, ASSASSIN, SHAMAN), level, xp, xpPercent, totalLevel, gamemode array, and optional reskin/nickname.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `username` | string | Yes | Player username (case-insensitive). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/get-player-characters \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"username":"<string>"}'
```

### Get player stats

Returns full statistics for a player by username. Includes online status, current server, guild membership, playtime hours, rank, and globalData containing wars, totalLevel, mobsKilled, chestsFound, dungeons, raids, pvp stats, and completedQuests.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `username` | string | Yes | Player username (case-insensitive). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/get-player-stats \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"username":"<string>"}'
```

### Global search

Global search across players, guilds, and items by query string. Returns matching results organized by type: players (UUID-to-object map), guilds (UUID-to-object map with name/prefix/level/members), guildsPrefix (guilds matched by tag), and items (array of item objects).

**Estimated cost:** Metered

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

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/global-search \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### Search items

Search for items using complex filters. Returns paginated results (20 per page). Filter keys include type (array of: weapon, armour, accessory), tier (array of: common, unique, rare, legendary, fabled, mythic, set), and other item properties. If no items match the criteria, the upstream API returns a 404.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filters` | string | No | JSON string of filter criteria. Supported keys include type (array of: weapon, armour, accessory), tier (array of: common, unique, rare, legendary, fabled, mythic, set), and other item properties. |
| `page` | integer | No | Page number (1-indexed). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/wynncraft/search-items \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"filters":"<string>","page":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://paywithlocus.com/agent/index.md): every Locus agent page.