Skip to content

fix(docs): align /account OpenAPI spec + docs with live flat response (SHA-3188) #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paperclip-resolver merged 1 commit into from
May 21, 2026
Merged

fix(docs): align /account OpenAPI spec + docs with live flat response (SHA-3188) #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 49 additions & 57 deletions content/de/api-reference/account.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ const response = await fetch(
);
const { data } = await response.json();

console.log(`Tier: ${data.key.tier}`);
console.log(`Rate limit: ${data.limits.requests_per_minute} req/min`);
console.log(`Max books: ${data.limits.max_books}`);
console.log(`Tier: ${data.tier}`);
console.log(`Rate limit: ${data.rate_limit.requests_per_minute} req/min`);
console.log(`Max books: ${data.rate_limit.max_books}`);
```
</Tabs.Tab>
<Tabs.Tab>
Expand All @@ -52,9 +52,9 @@ response = requests.get(
)
account = response.json()['data']

print(f"Tier: {account['key']['tier']}")
print(f"Tier: {account['tier']}")
print(f"Features: {account['features']}")
print(f"Add-ons: {account['addons']}")
print(f"Streaming: {account['streaming']['enabled']}")
```
</Tabs.Tab>
</Tabs>
Expand All @@ -66,34 +66,28 @@ print(f"Add-ons: {account['addons']}")
```json
{
"data": {
"key": {
"id": "key_abc123def456",
"tier": "pro"
},
"limits": {
"key_id": "key_abc123def456",
"tier": "pro",
"rate_limit": {
"requests_per_minute": 300,
"max_streams": 10,
"odds_delay_seconds": 0,
"max_books": 15
},
"features": {
"ev": true,
"arbitrage": true,
"middles": true,
"streaming": true
},
"addons": ["websocket"],
"streaming_trial": {
"active": false,
"eligible": false,
"used": true,
"activated_at": "2026-01-15T12:00:00Z",
"expires_at": "2026-01-15T16:00:00Z"
"features": [
"odds",
"schedule",
"ev",
"arbitrage",
"middles",
"low_hold",
"closing_line",
"splits"
],
"streaming": {
"enabled": true,
"max_connections": 10
}
},
"meta": {
"updated_at": "2026-02-08T14:44:32.123Z"
}
"updated_at": "2026-02-08T14:44:32.123Z"
}
```

Expand Down Expand Up @@ -122,50 +116,48 @@ X-Request-Id: req_acct123xyz

## Antwortfelder

### Key-Objekt
### `data`-Objekt

| Feld | Typ | Beschreibung |
|-------|------|-------------|
| `id` | string | Bezeichner für den in dieser Anfrage verwendeten API-Schlüssel |
| `key_id` | string | Bezeichner für den in dieser Anfrage verwendeten API-Schlüssel |
| `tier` | string | Abonnementstufe: `free`, `hobby`, `pro`, `sharp` oder `enterprise` |
| `user_id` | string | Benutzerkennung (sofern verfügbar) |

### Limits-Objekt
| `rate_limit` | object | Rate Limit und Sportsbook-Zugriff — siehe unten |
| `features` | string[] | Auf Ihrer Stufe aktivierte Funktionen — siehe unten |
| `streaming` | object | Verfügbarkeit von SSE-/WebSocket-Streaming — siehe unten |

| Feld | Typ | Beschreibung |
|-------|------|-------------|
| `requests_per_minute` | number | Maximal zulässige API-Anfragen pro Minute |
| `max_streams` | number | Maximale gleichzeitige SSE-/WebSocket-Streams (0 wenn Streaming nicht aktiviert ist) |
| `odds_delay_seconds` | number | Verzögerung der Odds-Daten in Sekunden (`0` für kostenpflichtige Stufen, `60` für kostenlos) |
| `max_books` | number | Maximale Anzahl der für Ihre Stufe zugänglichen Sportsbooks |
Ein `updated_at`-Feld auf oberster Ebene (ISO 8601-Zeitstempel) begleitet `data`.

### Features-Objekt
### `rate_limit`-Objekt

| Feld | Typ | Beschreibung |
|-------|------|-------------|
| `ev` | boolean | Zugriff auf +EV-Gelegenheitserkennung |
| `arbitrage` | boolean | Zugriff auf Arbitrage-Erkennung |
| `middles` | boolean | Zugriff auf Middles-Erkennung |
| `streaming` | boolean | Zugriff auf SSE-/WebSocket-Streaming (über Add-on, Testversion oder Enterprise) |
| `requests_per_minute` | number | Maximal zulässige API-Anfragen pro Minute auf Ihrer Stufe |
| `max_books` | number | Maximale Anzahl der für Ihre Stufe zugänglichen Sportsbooks (`999` bedeutet unbegrenzt) |

### Add-ons
### `features`-Array

| Feld | Typ | Beschreibung |
|-------|------|-------------|
| `addons` | string[] | Aktive Add-ons (z. B. `["websocket"]`) |
Array von Funktions-Tokens, die auf Ihrer Stufe aktiviert sind. Mögliche Werte:

### Streaming-Testversion-Objekt (optional)
| Wert | Beschreibung |
|-------|-------------|
| `odds` | Live-Odds-Endpoints |
| `schedule` | Event-/Spielplan-Endpoints |
| `ev` | +EV-Gelegenheitserkennung |
| `arbitrage` | Arbitrage-Erkennung |
| `middles` | Middles-Erkennung |
| `low_hold` | Low-Hold-Gelegenheitserkennung |
| `history` | Historische Odds-Endpoints |
| `futures` | Futures-Märkte |
| `closing_line` | Closing-Line-Value-Endpoints |
| `splits` | Öffentliche Wett-Splits |

Vorhanden, wenn der Benutzer eine aktive Testversion hat, berechtigt ist oder bereits eine Testversion genutzt hat.
### `streaming`-Objekt

| Feld | Typ | Beschreibung |
|-------|------|-------------|
| `active` | boolean | Ob aktuell eine Streaming-Testversion aktiv ist |
| `eligible` | boolean | Ob der Benutzer für eine Testversion berechtigt ist |
| `used` | boolean | Ob der Benutzer seine Testversion bereits genutzt hat |
| `activated_at` | string | ISO 8601-Zeitstempel der Aktivierung der Testversion |
| `expires_at` | string | ISO 8601-Zeitstempel des Ablaufs der Testversion |
| `remaining_hours` | number | Verbleibende Stunden der Testversion |
| `enabled` | boolean | Ob SSE-/WebSocket-Streaming verfügbar ist (über Stufe, Add-on oder Testversion) |
| `max_connections` | number | Maximale Anzahl gleichzeitiger Streaming-Verbindungen (`0` wenn Streaming nicht aktiviert ist) |

## Anwendungsfälle

Expand All @@ -177,7 +169,7 @@ const { data: account } = await fetch(
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
).then(r => r.json());

if (!account.features.ev) {
if (!account.features.includes('ev')) {
console.log('Upgrade to Pro tier for +EV detection');
} else {
// Proceed with EV endpoint
Expand Down
106 changes: 49 additions & 57 deletions content/en/api-reference/account.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ const response = await fetch(
);
const { data } = await response.json();

console.log(`Tier: ${data.key.tier}`);
console.log(`Rate limit: ${data.limits.requests_per_minute} req/min`);
console.log(`Max books: ${data.limits.max_books}`);
console.log(`Tier: ${data.tier}`);
console.log(`Rate limit: ${data.rate_limit.requests_per_minute} req/min`);
console.log(`Max books: ${data.rate_limit.max_books}`);
```
</Tabs.Tab>
<Tabs.Tab>
Expand All @@ -52,9 +52,9 @@ response = requests.get(
)
account = response.json()['data']

print(f"Tier: {account['key']['tier']}")
print(f"Tier: {account['tier']}")
print(f"Features: {account['features']}")
print(f"Add-ons: {account['addons']}")
print(f"Streaming: {account['streaming']['enabled']}")
```
</Tabs.Tab>
</Tabs>
Expand All @@ -66,34 +66,28 @@ print(f"Add-ons: {account['addons']}")
```json
{
"data": {
"key": {
"id": "key_abc123def456",
"tier": "pro"
},
"limits": {
"key_id": "key_abc123def456",
"tier": "pro",
"rate_limit": {
"requests_per_minute": 300,
"max_streams": 10,
"odds_delay_seconds": 0,
"max_books": 15
},
"features": {
"ev": true,
"arbitrage": true,
"middles": true,
"streaming": true
},
"addons": ["websocket"],
"streaming_trial": {
"active": false,
"eligible": false,
"used": true,
"activated_at": "2026-01-15T12:00:00Z",
"expires_at": "2026-01-15T16:00:00Z"
"features": [
"odds",
"schedule",
"ev",
"arbitrage",
"middles",
"low_hold",
"closing_line",
"splits"
],
"streaming": {
"enabled": true,
"max_connections": 10
}
},
"meta": {
"updated_at": "2026-02-08T14:44:32.123Z"
}
"updated_at": "2026-02-08T14:44:32.123Z"
}
```

Expand Down Expand Up @@ -122,50 +116,48 @@ X-Request-Id: req_acct123xyz

## Response Fields

### Key Object
### `data` Object

| Field | Type | Description |
|-------|------|-------------|
| `id` | string | Identifier for the API key used in this request |
| `key_id` | string | Identifier for the API key used in this request |
| `tier` | string | Subscription tier: `free`, `hobby`, `pro`, `sharp`, or `enterprise` |
| `user_id` | string | User identifier (when available) |

### Limits Object
| `rate_limit` | object | Rate limit and book access — see below |
| `features` | string[] | Capabilities enabled on this tier — see below |
| `streaming` | object | SSE/WebSocket streaming availability — see below |

| Field | Type | Description |
|-------|------|-------------|
| `requests_per_minute` | number | Maximum API requests allowed per minute |
| `max_streams` | number | Maximum concurrent SSE/WebSocket streams (0 if streaming not enabled) |
| `odds_delay_seconds` | number | Odds data delay in seconds (`0` for paid tiers, `60` for free) |
| `max_books` | number | Maximum sportsbooks accessible on your tier |
A top-level `updated_at` field (ISO 8601 timestamp) accompanies `data`.

### Features Object
### `rate_limit` Object

| Field | Type | Description |
|-------|------|-------------|
| `ev` | boolean | Access to +EV opportunity detection |
| `arbitrage` | boolean | Access to arbitrage detection |
| `middles` | boolean | Access to middles detection |
| `streaming` | boolean | Access to SSE/WebSocket streaming (via add-on, trial, or enterprise) |
| `requests_per_minute` | number | Maximum API requests allowed per minute on your tier |
| `max_books` | number | Maximum sportsbooks accessible on your tier (`999` indicates unlimited) |

### Add-ons
### `features` Array

| Field | Type | Description |
|-------|------|-------------|
| `addons` | string[] | Active add-ons (e.g., `["websocket"]`) |
Array of capability tokens enabled on your tier. Possible values:

### Streaming Trial Object (Optional)
| Value | Description |
|-------|-------------|
| `odds` | Live odds endpoints |
| `schedule` | Event/schedule endpoints |
| `ev` | +EV opportunity detection |
| `arbitrage` | Arbitrage detection |
| `middles` | Middles detection |
| `low_hold` | Low-hold opportunity detection |
| `history` | Historical odds endpoints |
| `futures` | Futures markets |
| `closing_line` | Closing line value endpoints |
| `splits` | Public betting splits |

Present when the user has an active trial, is eligible, or has used a trial.
### `streaming` Object

| Field | Type | Description |
|-------|------|-------------|
| `active` | boolean | Whether a streaming trial is currently active |
| `eligible` | boolean | Whether the user is eligible for a trial |
| `used` | boolean | Whether the user has already used their trial |
| `activated_at` | string | ISO 8601 timestamp when the trial was activated |
| `expires_at` | string | ISO 8601 timestamp when the trial expires |
| `remaining_hours` | number | Hours remaining on the trial |
| `enabled` | boolean | Whether SSE/WebSocket streaming is available (via tier, add-on, or trial) |
| `max_connections` | number | Maximum concurrent streaming connections (`0` if streaming not enabled) |

## Use Cases

Expand All @@ -177,7 +169,7 @@ const { data: account } = await fetch(
{ headers: { 'X-API-Key': 'YOUR_API_KEY' } }
).then(r => r.json());

if (!account.features.ev) {
if (!account.features.includes('ev')) {
console.log('Upgrade to Pro tier for +EV detection');
} else {
// Proceed with EV endpoint
Expand Down
Loading