Skip to content

Commit 16da7c0

Browse files
Mlaz-codeclaude
andcommitted
docs: update odds API docs — remove deprecated fields, add player props
- Remove status, external_event_id, selection_id, market_id from /odds schema - Remove live game state fields section (now at /gamestate) - Remove has_score query param from /odds and /odds/best - Add player_name and stat_category fields - Update TypeScript SDK OddsLine interface - Update openapi.json NormalizedOdds schema Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 55739ac commit 16da7c0

4 files changed

Lines changed: 14 additions & 31 deletions

File tree

content/api-reference/odds-best.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ Best Odds is available on all tiers, including Free. The sportsbooks compared de
2525
| `market` | string | all | Filter by market type(s), comma-separated (e.g., `moneyline`, `spread`, `total`) |
2626
| `event` | string || Filter by event ID(s), comma-separated |
2727
| `live` | boolean || `true` = live only, `false` = prematch only, omit = both |
28-
| `has_score` | boolean || `true` = only events with game state/scores |
2928
| `min_odds` | number || Minimum American odds filter |
3029
| `max_odds` | number || Maximum American odds filter |
3130
| `limit` | integer | 50 | Max results per page (max 500) |
@@ -222,6 +221,8 @@ X-Request-Id: req_best_789xyz
222221
| `all_books[].line` | number \| null | Line at this sportsbook |
223222
| `all_books[].timestamp` | string | When this book's odds were last updated |
224223
| `timestamp` | string | ISO 8601 timestamp of the best odds determination |
224+
| `player_name` | string\|undefined | Player name (player prop markets only) |
225+
| `stat_category` | string\|undefined | Stat category, e.g. `points`, `rebounds` (player prop markets only) |
225226

226227
<Callout type="info">
227228
The `market_hold` field represents the bookmaker's built-in margin (overround) as a percentage. A hold of `4.2` means the combined implied probabilities across all outcomes sum to 104.2%. Lower hold = more efficient market.

content/api-reference/odds.mdx

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ The sportsbooks returned in your results depend on your subscription tier. Free
2626
| `market` | string | all | Filter by market type(s), comma-separated. Supports categories (`moneyline`, `spread`, `total`, `props`) or exact types (`point_spread`, `player_points`). |
2727
| `event` | string || Filter by event ID(s), comma-separated |
2828
| `live` | boolean || `true` = live only, `false` = prematch only, omit = both |
29-
| `has_score` | boolean || `true` = only events with game state/scores |
3029
| `sort` | string || Sort field with optional `-` prefix for descending (e.g., `-odds_american`, `probability`) |
3130
| `fields` | string | all | Comma-separated field names to include in response (e.g., `id,sportsbook,odds_american`) |
3231
| `min_odds` | number || Minimum American odds filter (e.g., `-110`) |
@@ -115,8 +114,7 @@ if result['meta']['pagination']['has_more']:
115114
"line": null,
116115
"event_start_time": "2026-01-26T19:00:00Z",
117116
"timestamp": "2026-01-26T02:10:24.125Z",
118-
"is_live": false,
119-
"status": "upcoming"
117+
"is_live": false
120118
},
121119
{
122120
"id": "draftkings_33483153_moneyline_PHI",
@@ -136,8 +134,7 @@ if result['meta']['pagination']['has_more']:
136134
"line": null,
137135
"event_start_time": "2026-01-26T19:00:00Z",
138136
"timestamp": "2026-01-26T02:10:24.125Z",
139-
"is_live": false,
140-
"status": "upcoming"
137+
"is_live": false
141138
}
142139
],
143140
"meta": {
@@ -238,26 +235,12 @@ X-Request-Id: req_abc123def456
238235
| `event_start_time` | string | ISO 8601 event start time |
239236
| `timestamp` | string | ISO 8601 timestamp when odds were last updated |
240237
| `is_live` | boolean | Whether the event is currently live |
241-
| `status` | string | `upcoming`, `live`, or `ended` |
242-
| `external_event_id` | string\|undefined | Sportsbook's native event ID (for deep linking) |
243-
| `selection_id` | string\|undefined | Sportsbook's selection/outcome ID |
244-
| `market_id` | string\|undefined | Sportsbook's market ID |
245-
246-
#### Live Game State Fields
247-
248-
These fields are included when the event is live (`is_live: true`):
238+
| `player_name` | string\|undefined | Player name (player prop markets only) |
239+
| `stat_category` | string\|undefined | Stat category, e.g. `points`, `rebounds` (player prop markets only) |
249240

250-
| Field | Type | Description |
251-
|-------|------|-------------|
252-
| `home_score` | number\|null | Home team score |
253-
| `away_score` | number\|null | Away team score |
254-
| `game_period` | string\|null | Current period (e.g., `Q3`, `2nd`, `3rd Period`) |
255-
| `game_clock` | string\|null | Time remaining (e.g., `5:42`) |
256-
| `score_type` | string\|undefined | Score type (e.g., `points`, `goals`, `runs`) |
257-
| `possession` | string\|null | Team with possession |
258-
| `is_timeout` | boolean\|null | Whether a timeout is in progress |
259-
| `power_play` | string\|null | Power play info (hockey) |
260-
| `last_play` | string\|null | Description of last play |
241+
<Callout type="info">
242+
Live game state (scores, periods, clocks) is available via the [Game State](/api-reference/gamestate) endpoint. Deep links to sportsbook pages are available via the [Deep Links](/api-reference/deeplinks) endpoint using the odds `id` field.
243+
</Callout>
261244

262245
## Sorting
263246

content/sdks/typescript.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,9 @@ interface OddsLine {
6363
line?: number;
6464
event_start_time: string;
6565
is_live: boolean;
66-
status: string;
6766
timestamp: string;
68-
fetched_at?: string;
69-
data_age_ms?: number;
67+
player_name?: string; // Player prop markets only
68+
stat_category?: string; // Player prop markets only
7069
}
7170

7271
interface EVOpportunity {

public/openapi.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -782,13 +782,12 @@
782782
},
783783
"NormalizedOdds": {
784784
"type": "object",
785-
"required": ["id", "sportsbook", "eventId", "sport", "league", "homeTeam", "awayTeam", "marketType", "selection", "odds", "eventStartTime", "timestamp", "isLive", "status"],
785+
"required": ["id", "sportsbook", "eventId", "sport", "league", "homeTeam", "awayTeam", "marketType", "selection", "odds", "eventStartTime", "timestamp", "isLive"],
786786
"properties": {
787787
"id": { "type": "string" },
788788
"sportsbook": { "type": "string", "example": "draftkings" },
789789
"sportsbookDisplayName": { "type": "string", "example": "DraftKings" },
790790
"eventId": { "type": "string" },
791-
"externalEventId": { "type": "string" },
792791
"sport": { "type": "string", "example": "basketball" },
793792
"league": { "type": "string", "example": "NBA" },
794793
"homeTeam": { "type": "string", "example": "Los Angeles Lakers" },
@@ -801,7 +800,8 @@
801800
"eventStartTime": { "type": "string", "format": "date-time" },
802801
"timestamp": { "type": "string", "format": "date-time" },
803802
"isLive": { "type": "boolean" },
804-
"status": { "$ref": "#/components/schemas/EventStatus" }
803+
"playerName": { "type": "string", "description": "Player name (player prop markets only)" },
804+
"statCategory": { "type": "string", "description": "Stat category (player prop markets only)" }
805805
}
806806
},
807807
"Event": {

0 commit comments

Comments
 (0)