Skip to content

Commit 783a4df

Browse files
Mlaz-codeclaude
andauthored
docs(gamestate): reflect new $79/mo add-on gating (#191)
REST /api/v1/gamestate moved from Enterprise-only to a $79/mo add-on (or Enterprise) in sharp-api-go#40 + sharpapi-site#14. Update: - Frontmatter description - Authentication section: call out the add-on, mention streaming still requires the WebSocket add-on + Enterprise for the gamestate channel - Rate Limits: clarify that limits follow the base tier, not the add-on - Troubleshooting: 403 now includes addon:"game_state" in the body; mention the billing flow as the primary fix Streaming references in stream.mdx left unchanged — the gamestate streaming channel is still Enterprise-only. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 07abf54 commit 783a4df

1 file changed

Lines changed: 17 additions & 9 deletions

File tree

content/en/api-reference/gamestate.mdx

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: "GET /api/v1/gamestate — Aggregated live game state (scores, periods, clocks, situational data) merged across sportsbooks into a single authoritative view per event. Enterprise tier only."
2+
description: "GET /api/v1/gamestate — Aggregated live game state (scores, periods, clocks, situational data) merged across sportsbooks into a single authoritative view per event. Available on the Game State add-on ($79/mo) or Enterprise tier."
33
---
44

55
import { Callout, Tabs } from 'nextra/components'
@@ -18,12 +18,17 @@ GET /api/v1/gamestate/{sport}
1818

1919
## Authentication
2020

21-
Requires API key. **Enterprise tier only.** Non-Enterprise tiers receive
22-
`403 tier_restricted`.
21+
Requires API key. Available on **the Game State add-on ($79/mo)** or the
22+
**Enterprise tier**. Keys without either receive `403 tier_restricted`
23+
with `addon: "game_state"` in the error body. Add the add-on from the
24+
[billing page](https://sharpapi.io/dashboard/billing) on any paid plan
25+
(Hobby / Pro / Sharp); Enterprise keys get it included.
2326

2427
Live game state also streams over the `gamestate` channel on
2528
[SSE](/api-reference/stream) and [WebSocket](/api-reference/websocket)
26-
— see [Streaming](#streaming) below.
29+
— see [Streaming](#streaming) below. (Streaming access requires the
30+
WebSocket add-on or Enterprise, in addition to the Game State
31+
requirement above.)
2732

2833
## Path Parameters
2934

@@ -245,14 +250,17 @@ events when events drop from the live set.
245250
246251
## Rate Limits & Quotas
247252
248-
Same Enterprise-tier limits as other endpoints — see
249-
[Pricing](https://sharpapi.io/pricing). `/gamestate` counts the same
250-
as other REST calls toward the per-minute quota.
253+
Rate limits follow your **base tier**, not the add-on — Hobby keys keep
254+
their 120 req/min, Pro keep 300, Sharp keep 1,000, Enterprise custom.
255+
See [Pricing](https://sharpapi.io/pricing). `/gamestate` counts the
256+
same as other REST calls toward the per-minute quota.
251257
252258
## Troubleshooting
253259
254-
- **403 `tier_restricted`** — your key doesn't have the gamestate
255-
feature. Upgrade to Enterprise.
260+
- **403 `tier_restricted`** with `addon: "game_state"` — your key
261+
doesn't have the Game State add-on. Add it from
262+
[Billing](https://sharpapi.io/dashboard/billing) for $79/mo, or
263+
upgrade to Enterprise.
256264
- **Empty `data` object** — no live events in scope. This is common
257265
between events on smaller sport schedules. Poll again.
258266
- **Events with `stale: true`** — the primary book has gone silent.

0 commit comments

Comments
 (0)