Skip to content

Commit 2e67743

Browse files
authored
docs(polymarket-resolution): snake_case to match wire convention (#226)
The customer-visible field name on /odds is polymarket_resolution (snake_case), matching odds_american / event_id / selection_type / volume_24h / exchange_token_id etc. Initial doc landed with camelCase, which is what api-adapters emits internally on the publish path but isn't what customers see on the SSE/REST wire.
1 parent 705e9fa commit 2e67743

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

content/en/api-reference/sportsbooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ The `requires_tier` field indicates the minimum subscription tier needed to acce
437437
<Callout type="info">
438438
**Polymarket** and **Kalshi** are prediction market platforms. Unlike traditional sportsbooks, they use binary outcome contracts priced between $0 and $1. SharpAPI normalizes contract prices into standard odds formats (American, decimal, implied probability) so you can compare them directly with sportsbook odds. Kalshi is CFTC-regulated.
439439

440-
Polymarket rows additionally carry a `polymarketResolution` field reflecting the upstream UMA optimistic-oracle lifecycle (`settled_normal` / `voided` / `disputed` / `proposed` / `unknown`). See [Polymarket Resolution](/concepts/polymarket-resolution) for the per-value semantics and the upstream caveat that cancellation, participant withdrawal, and event-not-occurred all collapse to the single `voided` bucket.
440+
Polymarket rows additionally carry a `polymarket_resolution` field reflecting the upstream UMA optimistic-oracle lifecycle (`settled_normal` / `voided` / `disputed` / `proposed` / `unknown`). See [Polymarket Resolution](/concepts/polymarket-resolution) for the per-value semantics and the upstream caveat that cancellation, participant withdrawal, and event-not-occurred all collapse to the single `voided` bucket.
441441
</Callout>
442442

443443
## Sharp vs Soft Books

content/en/concepts/polymarket-resolution.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import { Callout } from 'nextra/components'
77

88
# Polymarket Resolution Status
99

10-
Polymarket is a prediction-market CLOB whose markets are graded by the [UMA optimistic oracle](https://docs.uma.xyz/), not by a sportsbook trading desk. When you read Polymarket odds through SharpAPI, the row may carry an extra field — `polymarketResolution` — that reflects where that market sits in the UMA resolution lifecycle.
10+
Polymarket is a prediction-market CLOB whose markets are graded by the [UMA optimistic oracle](https://docs.uma.xyz/), not by a sportsbook trading desk. When you read Polymarket odds through SharpAPI, the row may carry an extra field — `polymarket_resolution` — that reflects where that market sits in the UMA resolution lifecycle.
1111

1212
This field is **Polymarket-only**. Other sportsbook rows (Pinnacle, DraftKings, FanDuel, etc.) do not carry it because their upstream wire formats don't emit an equivalent signal. See [Pinnacle wire survey](https://github.com/Mlaz-code/api-adapters/) for the parallel investigation that concluded the same field cannot be delivered for traditional books.
1313

1414
## When the field appears
1515

16-
| Market state | `polymarketResolution` |
16+
| Market state | `polymarket_resolution` |
1717
|---|---|
1818
| Actively trading | omitted (field not present) |
1919
| Closed, resolved with a winner | `"settled_normal"` |
@@ -37,7 +37,7 @@ The UMA oracle declared a winning outcome. In a binary market, exactly one outco
3737
"marketType": "binary",
3838
"selection": "Yes",
3939
"odds": -10000,
40-
"polymarketResolution": "settled_normal",
40+
"polymarket_resolution": "settled_normal",
4141
"trueProbability": 1.0
4242
}
4343
```
@@ -71,15 +71,15 @@ The market is closed but the UMA lifecycle fields are empty. This happens on leg
7171

7272
## Delayed resolution
7373

74-
Polymarket markets can resolve days or weeks after the underlying event ends. The `polymarketResolution` field appears whenever the upstream resolution lifecycle advances, even long after the market closed.
74+
Polymarket markets can resolve days or weeks after the underlying event ends. The `polymarket_resolution` field appears whenever the upstream resolution lifecycle advances, even long after the market closed.
7575

7676
If your application processes resolution events (for grading, settlement reconciliation, etc.), watch the SSE stream / WebSocket for these late-arriving rows.
7777

7878
## Comparison with other books
7979

8080
| Book | Equivalent field? | Notes |
8181
|---|---|---|
82-
| **Polymarket** | `polymarketResolution` | 5-state enum, derived from UMA oracle |
82+
| **Polymarket** | `polymarket_resolution` | 5-state enum, derived from UMA oracle |
8383
| **Kalshi** | _(not yet)_ | Kalshi has settlement events but we don't surface them today — separate request |
8484
| **Pinnacle** | _(not available upstream)_ | Pinnacle's wire emits no real-time reason field; `cancellationReason` exists only on the post-grading Lines API partner endpoint |
8585
| **DraftKings / FanDuel / BetMGM / Caesars** | _(not available)_ | Suspended markets simply disappear from the feed; no status field is emitted |
@@ -89,7 +89,7 @@ The data customers want — a per-book settlement reason — is not industry-sta
8989

9090
## Why the field is Polymarket-prefixed
9191

92-
We deliberately named the field `polymarketResolution` rather than a generic `resolutionStatus` so it's obvious the values are Polymarket-specific. A future Kalshi version would be a separate `kalshiResolution` field with its own enum — the wire formats are different enough that a unified enum would either be lowest-common-denominator (useless) or full of asterisks for "Polymarket-only" / "Kalshi-only" values.
92+
We deliberately named the field `polymarket_resolution` rather than a generic `resolutionStatus` so it's obvious the values are Polymarket-specific. A future Kalshi version would be a separate `kalshiResolution` field with its own enum — the wire formats are different enough that a unified enum would either be lowest-common-denominator (useless) or full of asterisks for "Polymarket-only" / "Kalshi-only" values.
9393

9494
## See also
9595

0 commit comments

Comments
 (0)