# Protondb — 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 for game compatibility information and check how well games run on Linux and Steam Deck, including user reports, performance statistics, and official verification status. Explore detailed game data, platform analytics, and community feedback to evaluate compatibility across titles.

**Category:** Entertainment | **Website:** [protondb.com/](https://protondb.com/) | **Docs:** [parse.bot/marketplace/0b06ef6e-b3c0-4df6-88ff-7b4998ce9645/protondb-com-api](https://parse.bot/marketplace/0b06ef6e-b3c0-4df6-88ff-7b4998ce9645/protondb-com-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-protondb-com-api-0b06ef6e/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### explore_games_list

Browse the ProtonDB explore page: a paginated list of games with compatibility information. Supports multiple sort orders (popular, releaseDate, wilsonRating, playerCount, userScore, mostBorked, fixWanted). Returns up to 50 games per page with total page count.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `filter` | string | No | Filter option (e.g. unfiltered). |
| `sort` | string | No | Sort option. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/explore_games_list \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"filter":"<string>","sort":"<string>"}'
```

### get_dashboard_stats

Retrieve the full compatibility breakdown dashboard. Covers multiple game categories (topTen, topHundred, topThousand, fullSteamCatalog, indie, vr, etc.) with ratings distributions across ProtonDB medals, click-play tiers, and Steam Deck verification states.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/get_dashboard_stats \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_deck_verified_details

Retrieve the Steam Deck Verified status and individual test criteria for a game. resolved_category values: 3=Verified, 2=Playable, 1=Unsupported, 0=Unknown. Each resolved_item is a specific test result with a display_type and localization token.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `app_id` | string | Yes | Steam App ID of the game. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/get_deck_verified_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"app_id":"<string>"}'
```

### get_game_reports

Retrieve user-submitted compatibility reports for a game. Each report includes the contributor's system specs (CPU, GPU, OS), Proton version used, and a detailed verdict. Filterable by device type. Returns up to 40 reports per page.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `app_id` | string | Yes | Steam App ID of the game. |
| `device` | string | No | Device filter. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/get_game_reports \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"app_id":"<string>","device":"<string>"}'
```

### get_game_summary

Retrieve the ProtonDB compatibility summary for a specific game by its Steam App ID. Returns tier rating (platinum/gold/silver/bronze/borked), confidence level, total report count, and a normalized score. A 404 means no reports exist for this app ID.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `app_id` | string | Yes | Steam App ID of the game (e.g. 620 for Portal 2). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/get_game_summary \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"app_id":"<string>"}'
```

### get_stats_summary

Retrieve global ProtonDB statistics: total report count, number of unique games with reports, and the Unix timestamp of the last data refresh. No parameters required.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/get_stats_summary \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_steam_app_details

Retrieve official Steam store metadata for a game via ProtonDB's proxy. Returns the full Steam appdetails payload including name, description, pricing, system requirements, genres, screenshots, and release date. Extracts the inner data object for the requested app.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `app_id` | string | Yes | Steam App ID of the game. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-protondb-com-api-0b06ef6e/get_steam_app_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"app_id":"<string>"}'
```

### search_games

Full-text search over the ProtonDB game index by title. Returns matching games with their Steam App IDs. Each hit carries the game name and its Steam App ID (objectID). Limited to 20 results per call.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search keyword or game title to find matching games. |

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