Skip to content

Commit 46e7175

Browse files
paperclip-resolver[bot]paperclip-resolver[bot]
authored
docs: correct canonical event_id format (SHA-3432 C3) (#242)
Correct canonical event_id docs to match runtime format and remove stale evt_ examples.\n\nRefs SHA-3432\nType: docs
1 parent b287a08 commit 46e7175

16 files changed

Lines changed: 112 additions & 64 deletions

‎content/en/api-reference/events-by-id.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Requires API key via `X-API-Key` header, `Authorization: Bearer` header, or `api
2020

2121
| Parameter | Type | Required | Description |
2222
|-----------|------|----------|-------------|
23-
| `eventId` | string | Yes | Unique event identifier (e.g., `evt_nba_bos_lal_20260208`) |
23+
| `eventId` | string | Yes | Unique event identifier (e.g., `nba_celtics_lakers_2026-02-08_b3`) |
2424

2525
## Response Headers
2626

@@ -76,13 +76,13 @@ Each entry in the `markets` array summarizes an available market type for this e
7676
<Tabs items={['cURL', 'JavaScript', 'Python']}>
7777
<Tabs.Tab>
7878
```bash
79-
curl -X GET "https://api.sharpapi.io/api/v1/events/evt_nba_bos_lal_20260208" \
79+
curl -X GET "https://api.sharpapi.io/api/v1/events/nba_celtics_lakers_2026-02-08_b3" \
8080
-H "X-API-Key: YOUR_API_KEY"
8181
```
8282
</Tabs.Tab>
8383
<Tabs.Tab>
8484
```javascript
85-
const eventId = 'evt_nba_bos_lal_20260208';
85+
const eventId = 'nba_celtics_lakers_2026-02-08_b3';
8686
const response = await fetch(
8787
`https://api.sharpapi.io/api/v1/events/${eventId}`,
8888
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
@@ -96,7 +96,7 @@ console.log(`Markets: ${data.markets.map(m => m.type).join(', ')}`);
9696
```python
9797
import requests
9898

99-
event_id = 'evt_nba_bos_lal_20260208'
99+
event_id = 'nba_celtics_lakers_2026-02-08_b3'
100100
response = requests.get(
101101
f'https://api.sharpapi.io/api/v1/events/{event_id}',
102102
headers={'X-API-Key': 'YOUR_API_KEY'}
@@ -119,7 +119,7 @@ Single-resource responses wrap the object in `data` as a single object (not an a
119119
```json
120120
{
121121
"data": {
122-
"id": "evt_nba_bos_lal_20260208",
122+
"id": "nba_celtics_lakers_2026-02-08_b3",
123123
"external_ids": {
124124
"draftkings": "12345678",
125125
"fanduel": "87654321",
@@ -188,7 +188,7 @@ Single-resource responses wrap the object in `data` as a single object (not an a
188188
]
189189
},
190190
"meta": {
191-
"event_id": "evt_nba_bos_lal_20260208"
191+
"event_id": "nba_celtics_lakers_2026-02-08_b3"
192192
}
193193
}
194194
```

‎content/en/api-reference/events-markets.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Requires API key via `X-API-Key` header, `Authorization: Bearer` header, or `api
2020

2121
| Parameter | Type | Required | Description |
2222
|-----------|------|----------|-------------|
23-
| `eventId` | string | Yes | Unique event identifier (e.g., `evt_nba_bos_lal_20260208`) |
23+
| `eventId` | string | Yes | Unique event identifier (e.g., `nba_celtics_lakers_2026-02-08_b3`) |
2424

2525
## Response Headers
2626

@@ -57,13 +57,13 @@ All responses include standard rate limit and metadata headers:
5757
<Tabs items={['cURL', 'JavaScript', 'Python']}>
5858
<Tabs.Tab>
5959
```bash
60-
curl -X GET "https://api.sharpapi.io/api/v1/events/evt_nba_bos_lal_20260208/markets" \
60+
curl -X GET "https://api.sharpapi.io/api/v1/events/nba_celtics_lakers_2026-02-08_b3/markets" \
6161
-H "X-API-Key: YOUR_API_KEY"
6262
```
6363
</Tabs.Tab>
6464
<Tabs.Tab>
6565
```javascript
66-
const eventId = 'evt_nba_bos_lal_20260208';
66+
const eventId = 'nba_celtics_lakers_2026-02-08_b3';
6767
const response = await fetch(
6868
`https://api.sharpapi.io/api/v1/events/${eventId}/markets`,
6969
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
@@ -83,7 +83,7 @@ for (const market of data) {
8383
```python
8484
import requests
8585

86-
event_id = 'evt_nba_bos_lal_20260208'
86+
event_id = 'nba_celtics_lakers_2026-02-08_b3'
8787
response = requests.get(
8888
f'https://api.sharpapi.io/api/v1/events/{event_id}/markets',
8989
headers={'X-API-Key': 'YOUR_API_KEY'}
@@ -158,7 +158,7 @@ for market in result['data']:
158158
}
159159
],
160160
"meta": {
161-
"event_id": "evt_nba_bos_lal_20260208",
161+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
162162
"count": 5,
163163
"updated_at": "2026-02-08T12:05:00Z"
164164
}

‎content/en/api-reference/events-odds.mdx‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Requires API key via `X-API-Key` header, `Authorization: Bearer` header, or `api
2424

2525
| Parameter | Type | Required | Description |
2626
|-----------|------|----------|-------------|
27-
| `eventId` | string | Yes | Unique event identifier (e.g., `evt_nba_bos_lal_20260208`) |
27+
| `eventId` | string | Yes | Unique event identifier (e.g., `nba_celtics_lakers_2026-02-08_b3`) |
2828

2929
## Query Parameters
3030

@@ -71,13 +71,13 @@ All responses include standard rate limit and metadata headers:
7171
<Tabs items={['cURL', 'JavaScript', 'Python']}>
7272
<Tabs.Tab>
7373
```bash
74-
curl -X GET "https://api.sharpapi.io/api/v1/events/evt_nba_bos_lal_20260208/odds" \
74+
curl -X GET "https://api.sharpapi.io/api/v1/events/nba_celtics_lakers_2026-02-08_b3/odds" \
7575
-H "X-API-Key: YOUR_API_KEY"
7676
```
7777
</Tabs.Tab>
7878
<Tabs.Tab>
7979
```javascript
80-
const eventId = 'evt_nba_bos_lal_20260208';
80+
const eventId = 'nba_celtics_lakers_2026-02-08_b3';
8181
const response = await fetch(
8282
`https://api.sharpapi.io/api/v1/events/${eventId}/odds`,
8383
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
@@ -90,7 +90,7 @@ console.log(`${meta.total} total odds for this event`);
9090
```python
9191
import requests
9292

93-
event_id = 'evt_nba_bos_lal_20260208'
93+
event_id = 'nba_celtics_lakers_2026-02-08_b3'
9494
response = requests.get(
9595
f'https://api.sharpapi.io/api/v1/events/{event_id}/odds',
9696
headers={'X-API-Key': 'YOUR_API_KEY'}
@@ -106,13 +106,13 @@ print(f"{result['meta']['total']} total odds for this event")
106106
<Tabs items={['cURL', 'JavaScript', 'Python']}>
107107
<Tabs.Tab>
108108
```bash
109-
curl -X GET "https://api.sharpapi.io/api/v1/events/evt_nba_bos_lal_20260208/odds?sportsbook=draftkings,pinnacle&market=moneyline,spread" \
109+
curl -X GET "https://api.sharpapi.io/api/v1/events/nba_celtics_lakers_2026-02-08_b3/odds?sportsbook=draftkings,pinnacle&market=moneyline,spread" \
110110
-H "X-API-Key: YOUR_API_KEY"
111111
```
112112
</Tabs.Tab>
113113
<Tabs.Tab>
114114
```javascript
115-
const eventId = 'evt_nba_bos_lal_20260208';
115+
const eventId = 'nba_celtics_lakers_2026-02-08_b3';
116116
const response = await fetch(
117117
`https://api.sharpapi.io/api/v1/events/${eventId}/odds?sportsbook=draftkings,pinnacle&market=moneyline,spread`,
118118
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
@@ -124,7 +124,7 @@ const { data } = await response.json();
124124
```python
125125
import requests
126126

127-
event_id = 'evt_nba_bos_lal_20260208'
127+
event_id = 'nba_celtics_lakers_2026-02-08_b3'
128128
response = requests.get(
129129
f'https://api.sharpapi.io/api/v1/events/{event_id}/odds',
130130
params={
@@ -144,17 +144,17 @@ odds = response.json()['data']
144144
<Tabs.Tab>
145145
```bash
146146
# First page
147-
curl -X GET "https://api.sharpapi.io/api/v1/events/evt_nba_bos_lal_20260208/odds?limit=50&offset=0" \
147+
curl -X GET "https://api.sharpapi.io/api/v1/events/nba_celtics_lakers_2026-02-08_b3/odds?limit=50&offset=0" \
148148
-H "X-API-Key: YOUR_API_KEY"
149149

150150
# Next page
151-
curl -X GET "https://api.sharpapi.io/api/v1/events/evt_nba_bos_lal_20260208/odds?limit=50&offset=50" \
151+
curl -X GET "https://api.sharpapi.io/api/v1/events/nba_celtics_lakers_2026-02-08_b3/odds?limit=50&offset=50" \
152152
-H "X-API-Key: YOUR_API_KEY"
153153
```
154154
</Tabs.Tab>
155155
<Tabs.Tab>
156156
```javascript
157-
const eventId = 'evt_nba_bos_lal_20260208';
157+
const eventId = 'nba_celtics_lakers_2026-02-08_b3';
158158
let offset = 0;
159159
const limit = 50;
160160
let allOdds = [];
@@ -178,7 +178,7 @@ console.log(`Fetched all ${allOdds.length} odds`);
178178
```python
179179
import requests
180180

181-
event_id = 'evt_nba_bos_lal_20260208'
181+
event_id = 'nba_celtics_lakers_2026-02-08_b3'
182182
all_odds = []
183183
offset = 0
184184
limit = 50
@@ -209,9 +209,9 @@ print(f"Fetched all {len(all_odds)} odds")
209209
{
210210
"data": [
211211
{
212-
"id": "dk_evt_nba_bos_lal_20260208_ml_home",
212+
"id": "dk_nba_celtics_lakers_2026-02-08_b3_ml_home",
213213
"sportsbook": "draftkings",
214-
"event_id": "evt_nba_bos_lal_20260208",
214+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
215215
"market_type": "moneyline",
216216
"selection": "Boston Celtics",
217217
"selection_type": "home",
@@ -224,9 +224,9 @@ print(f"Fetched all {len(all_odds)} odds")
224224
"last_seen_at": "2026-02-08T12:05:00Z"
225225
},
226226
{
227-
"id": "dk_evt_nba_bos_lal_20260208_ml_away",
227+
"id": "dk_nba_celtics_lakers_2026-02-08_b3_ml_away",
228228
"sportsbook": "draftkings",
229-
"event_id": "evt_nba_bos_lal_20260208",
229+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
230230
"market_type": "moneyline",
231231
"selection": "Los Angeles Lakers",
232232
"selection_type": "away",
@@ -239,9 +239,9 @@ print(f"Fetched all {len(all_odds)} odds")
239239
"last_seen_at": "2026-02-08T12:05:00Z"
240240
},
241241
{
242-
"id": "pin_evt_nba_bos_lal_20260208_ml_home",
242+
"id": "pin_nba_celtics_lakers_2026-02-08_b3_ml_home",
243243
"sportsbook": "pinnacle",
244-
"event_id": "evt_nba_bos_lal_20260208",
244+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
245245
"market_type": "moneyline",
246246
"selection": "Boston Celtics",
247247
"selection_type": "home",
@@ -254,9 +254,9 @@ print(f"Fetched all {len(all_odds)} odds")
254254
"last_seen_at": "2026-02-08T12:03:00Z"
255255
},
256256
{
257-
"id": "dk_evt_nba_bos_lal_20260208_spread_home",
257+
"id": "dk_nba_celtics_lakers_2026-02-08_b3_spread_home",
258258
"sportsbook": "draftkings",
259-
"event_id": "evt_nba_bos_lal_20260208",
259+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
260260
"market_type": "spread",
261261
"selection": "Boston Celtics",
262262
"selection_type": "home",
@@ -269,9 +269,9 @@ print(f"Fetched all {len(all_odds)} odds")
269269
"last_seen_at": "2026-02-08T12:05:00Z"
270270
},
271271
{
272-
"id": "dk_evt_nba_bos_lal_20260208_total_over",
272+
"id": "dk_nba_celtics_lakers_2026-02-08_b3_total_over",
273273
"sportsbook": "draftkings",
274-
"event_id": "evt_nba_bos_lal_20260208",
274+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
275275
"market_type": "total",
276276
"selection": "Over",
277277
"selection_type": "over",

‎content/en/api-reference/events.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ data = response.json()
233233
{
234234
"data": [
235235
{
236-
"id": "evt_nba_bos_lal_20260208",
236+
"id": "nba_celtics_lakers_2026-02-08_b3",
237237
"external_ids": {
238238
"draftkings": "33483200",
239239
"fanduel": "nba-bos-lal-20260208"
@@ -250,7 +250,7 @@ data = response.json()
250250
"books": ["betmgm", "caesars", "draftkings", "fanduel"]
251251
},
252252
{
253-
"id": "evt_nba_gsw_mia_20260208",
253+
"id": "nba_heat_warriors_2026-02-08_b3",
254254
"external_ids": {
255255
"draftkings": "33483205"
256256
},

‎content/en/api-reference/historical-odds-closing.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ for event in data['events']:
114114
"league": "nba",
115115
"events": [
116116
{
117-
"event_id": "evt_nba_bos_mia_20260410",
117+
"event_id": "nba_celtics_heat_2026-04-10_b3",
118118
"sport": "basketball",
119119
"league": "nba",
120120
"home_team": "Boston Celtics",

‎content/en/api-reference/odds-batch.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ curl -X POST "https://api.sharpapi.io/api/v1/odds/batch" \
5151
-H "X-API-Key: YOUR_API_KEY" \
5252
-H "Content-Type: application/json" \
5353
-d '{
54-
"event_ids": ["evt_nba_lal_bos_20260126", "evt_nba_gsw_mia_20260126"],
54+
"event_ids": ["nba_celtics_lakers_2026-01-26_b3", "nba_heat_warriors_2026-01-26_b3"],
5555
"sportsbook": "draftkings",
5656
"market": "moneyline"
5757
}'
@@ -66,7 +66,7 @@ const response = await fetch('https://api.sharpapi.io/api/v1/odds/batch', {
6666
'Content-Type': 'application/json'
6767
},
6868
body: JSON.stringify({
69-
event_ids: ['evt_nba_lal_bos_20260126', 'evt_nba_gsw_mia_20260126'],
69+
event_ids: ['nba_celtics_lakers_2026-01-26_b3', 'nba_heat_warriors_2026-01-26_b3'],
7070
sportsbook: 'draftkings',
7171
market: 'moneyline'
7272
})
@@ -96,7 +96,7 @@ response = requests.post(
9696
'Content-Type': 'application/json'
9797
},
9898
json={
99-
'event_ids': ['evt_nba_lal_bos_20260126', 'evt_nba_gsw_mia_20260126'],
99+
'event_ids': ['nba_celtics_lakers_2026-01-26_b3', 'nba_heat_warriors_2026-01-26_b3'],
100100
'sportsbook': 'draftkings',
101101
'market': 'moneyline'
102102
}
@@ -125,7 +125,7 @@ if result['data']['missing_events']:
125125
"data": {
126126
"events": [
127127
{
128-
"event_id": "evt_nba_lal_bos_20260126",
128+
"event_id": "nba_celtics_lakers_2026-01-26_b3",
129129
"event_name": "Los Angeles Lakers @ Boston Celtics",
130130
"sport": "basketball",
131131
"league": "nba",
@@ -155,7 +155,7 @@ if result['data']['missing_events']:
155155
]
156156
},
157157
{
158-
"event_id": "evt_nba_gsw_mia_20260126",
158+
"event_id": "nba_heat_warriors_2026-01-26_b3",
159159
"event_name": "Golden State Warriors @ Miami Heat",
160160
"sport": "basketball",
161161
"league": "nba",

‎content/en/api-reference/odds-best.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ for item in result['data']:
9292
"success": true,
9393
"data": [
9494
{
95-
"event_id": "evt_nba_lal_bos_20260126",
95+
"event_id": "nba_celtics_lakers_2026-01-26_b3",
9696
"event_name": "Los Angeles Lakers @ Boston Celtics",
9797
"sport": "basketball",
9898
"league": "nba",

‎content/en/api-reference/opportunities-arbitrage.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ for arb in data['data']:
100100
"data": [
101101
{
102102
"id": "arb_dk_pin_nba_lal_bos_ml",
103-
"event_id": "evt_nba_lal_bos_20260208",
103+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
104104
"event_name": "Los Angeles Lakers @ Boston Celtics",
105105
"sport": "basketball",
106106
"league": "nba",

‎content/en/api-reference/opportunities-ev.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ for opp in data['data']:
120120
"data": [
121121
{
122122
"id": "ev_dk_nba_33483153_ml_PHO",
123-
"game_id": "evt_nba_phi_pho_20260208",
123+
"game_id": "nba_76ers_suns_2026-02-08_b3",
124124
"ev_percentage": 4.2,
125125
"odds_american": -105,
126126
"odds_decimal": 1.952,
@@ -155,7 +155,7 @@ for opp in data['data']:
155155
},
156156
{
157157
"id": "ev_fd_nba_33483153_ml_PHO",
158-
"game_id": "evt_nba_phi_pho_20260208",
158+
"game_id": "nba_76ers_suns_2026-02-08_b3",
159159
"ev_percentage": 2.8,
160160
"odds_american": -108,
161161
"odds_decimal": 1.926,

‎content/en/api-reference/opportunities-low-hold.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ for hold in data['data']:
102102
"data": [
103103
{
104104
"id": "lh_nba_lal_bos_ml_0",
105-
"event_id": "evt_nba_lal_bos_20260208",
105+
"event_id": "nba_celtics_lakers_2026-02-08_b3",
106106
"event_name": "Los Angeles Lakers @ Boston Celtics",
107107
"sport": "basketball",
108108
"league": "nba",

0 commit comments

Comments
 (0)