You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: content/en/api-reference/gamestate.mdx
+17-9Lines changed: 17 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
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."
3
3
---
4
4
5
5
import { Callout, Tabs } from'nextra/components'
@@ -18,12 +18,17 @@ GET /api/v1/gamestate/{sport}
18
18
19
19
## Authentication
20
20
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.
23
26
24
27
Live game state also streams over the `gamestate` channel on
25
28
[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.)
27
32
28
33
## Path Parameters
29
34
@@ -245,14 +250,17 @@ events when events drop from the live set.
245
250
246
251
## Rate Limits & Quotas
247
252
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.
251
257
252
258
## Troubleshooting
253
259
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.
256
264
- **Empty `data` object** — no live events in scope. This is common
257
265
between events on smaller sport schedules. Poll again.
258
266
- **Events with `stale: true`** — the primary book has gone silent.
0 commit comments