Skip to content

Commit 6958771

Browse files
Mlaz-codeclaude
andcommitted
docs: rewrite API documentation for v1 redesign
Complete rewrite of all API reference pages to match new v1 surface: - Add 12 new pages: odds-comparison, odds-batch, events-odds, events-markets, opportunities-ev, opportunities-arbitrage, opportunities-middles, account, account-usage, account-keys, stream, health - Rewrite 8 existing pages: odds, odds-best, events, events-by-id, sports, leagues, sportsbooks, markets - Delete 14 obsolete pages: schedule, events-live, events-search, positive-ev, value-bets, player-props, me, user-stats, middles, arbitrage, odds-stream, ev-stream, arbitrage-stream, combined-stream - Update overview, quickstart, authentication, streaming docs - Restructure sidebar navigation with clear sections Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 3d46423 commit 6958771

48 files changed

Lines changed: 5865 additions & 3750 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

TEST_REPORT.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,8 @@ A comprehensive test suite was executed against all 27 documented SharpAPI publi
125125

126126
| Endpoint | Status | HTTP Code | Notes |
127127
|----------|--------|-----------|-------|
128-
| `GET /stream/odds` | ✅ PASS | 200 | Connection established successfully |
129-
| `GET /stream/odds?sports=nba` | ✅ PASS | 200 | Connection established successfully |
130-
| `GET /stream/ev` | ✅ PASS | 200 | Connection established successfully |
131-
| `GET /stream/arbitrage` | ✅ PASS | 200 | Connection established successfully |
132-
| `GET /stream/combined` | ✅ PASS | 200 | Connection established successfully |
128+
| `GET /v1/stream` | ✅ PASS | 200 | Connection established successfully |
129+
| `GET /v1/stream?sports=nba` | ✅ PASS | 200 | Connection established successfully |
133130

134131
**Analysis:** All streaming endpoints are functional and accepting SSE connections. The timeout mechanism successfully validated that connections are established and streams are available.
135132

pages/api-reference/_meta.json

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,51 @@
11
{
22
"overview": "Overview",
3-
"---Discovery": {
3+
"---Reference": {
44
"type": "separator",
55
"title": "Reference Data"
66
},
77
"sports": "Sports",
88
"leagues": "Leagues",
99
"sportsbooks": "Sportsbooks",
1010
"markets": "Markets",
11-
"---Schedule": {
12-
"type": "separator",
13-
"title": "Schedule & Events"
14-
},
15-
"schedule": "Schedule",
16-
"events": "Events",
17-
"events-live": "Live Events",
18-
"events-by-id": "Event Details",
19-
"events-search": "Event Search",
2011
"---Odds": {
2112
"type": "separator",
2213
"title": "Odds"
2314
},
24-
"odds": "Odds",
15+
"odds": "Odds Snapshot",
2516
"odds-best": "Best Odds",
26-
"---Markets": {
17+
"odds-comparison": "Odds Comparison",
18+
"odds-batch": "Batch Odds",
19+
"---Events": {
2720
"type": "separator",
28-
"title": "Markets"
21+
"title": "Events"
2922
},
30-
"player-props": "Player Props",
23+
"events": "Events",
24+
"events-by-id": "Event Details",
25+
"events-odds": "Event Odds",
26+
"events-markets": "Event Markets",
3127
"---Opportunities": {
3228
"type": "separator",
3329
"title": "Opportunities"
3430
},
35-
"positive-ev": "Positive EV",
36-
"arbitrage": "Arbitrage",
37-
"value-bets": "Value Bets",
38-
"middles": "Middles",
31+
"opportunities-ev": "+EV Opportunities",
32+
"opportunities-arbitrage": "Arbitrage",
33+
"opportunities-middles": "Middles",
34+
"---Streaming": {
35+
"type": "separator",
36+
"title": "Streaming"
37+
},
38+
"stream": "Unified Stream",
3939
"---Account": {
4040
"type": "separator",
4141
"title": "Account"
4242
},
43-
"me": "Account Info"
43+
"account": "Account Info",
44+
"account-usage": "Usage Stats",
45+
"account-keys": "API Key Management",
46+
"---Internal": {
47+
"type": "separator",
48+
"title": "Internal"
49+
},
50+
"health": "Health Check"
4451
}

0 commit comments

Comments
 (0)