Odds-API.io

https://docs.odds-api.io/
Admin
Odds-API.io is a sports betting odds comparison API that provides real-time data from 265+...
Tokens:82,894
Snippets:624
Trust Score:8.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Channel Subscription Examples

Source: https://docs.odds-api.io/guides/websockets

Examples of connection strings demonstrating how to combine different channels and filters.

```bash
# Odds + scores + status
wss://api.odds-api.io/v3/ws?apiKey=xxx&channels=odds,scores,status&markets=ML
# Scoreboard only
wss://api.odds-api.io/v3/ws?apiKey=xxx&channels=scores,status&sport=football
```

--------------------------------

### Install Mintlify CLI

Source: https://docs.odds-api.io/development

Global installation command for the Mintlify CLI tool.

```bash
npm i -g mintlify
```

--------------------------------

### Install Python SDK

Source: https://docs.odds-api.io/guides/sdks

Use pip to install the official Python client library.

```bash
pip install odds-api-io
```

--------------------------------

### Install the SDK

Source: https://docs.odds-api.io/guides/sdks

Use npm to install the odds-api-io package in your project.

```bash
npm install odds-api-io
```

--------------------------------

### API Endpoint Examples

Source: https://docs.odds-api.io/llms-full.txt

Example request URLs for various API endpoints.

```text
/events/live?apiKey=YOUR_KEY&sport=football
```

```text
/events/search?apiKey=YOUR_KEY&query=Liverpool
```

```text
/events/123456?apiKey=YOUR_KEY
```

```text
/odds?apiKey=YOUR_KEY&eventId=123456&bookmakers=Bet365,SingBet,Unibet
```

--------------------------------

### Install Odds API SDKs

Source: https://docs.odds-api.io/guides/sdks

Commands to install the official Python, Node.js, and MCP server packages.

```bash
pip install odds-api-io
```

```bash
npm install odds-api-io
```

```bash
npx odds-api-mcp-server
```

--------------------------------

### Start the WebSocket Poller

Source: https://docs.odds-api.io/superpowers/plans/2026-06-25-score-poller

Initializes the listener for market and match updates and starts the background goroutines for polling and monitoring.

```go
func (p *Poller) Start() {
    log.Println("Starting LISTEN/NOTIFY WebSocket poller...")

    if err := p.listener.Listen("market_updates"); err != nil {
        log.Fatalf("Failed to listen on market_updates: %v", err)
    }

    if err := p.listener.Listen("match_updates"); err != nil {
        log.Fatalf("Failed to listen on match_updates: %v", err)
    }

    log.Println("LISTEN/NOTIFY active on market_updates and match_updates")

    utils.SafeGoWithRestart("poller-handleNotifications", p.handleNotifications, 5*time.Second, 0)
    utils.SafeGoWithRestart("poller-processBatches", p.processBatches, 5*time.Second, 0)
    utils.SafeGoWithRestart("poller-backupPolling", p.backupPolling, 5*time.Second, 0)
    utils.SafeGoWithRestart("poller-warmCaches", p.warmCaches, 5*time.Second, 0)
    utils.SafeGoWithRestart("poller-monitorMetrics", p.monitorMetrics, 5*time.Second, 0)
    utils.SafeGoWithRestart("poller-pollScores", p.pollScores, 5*time.Second, 0)
}
```

--------------------------------

### Quick Start with JavaScript

Source: https://docs.odds-api.io/guides/sdks

Initialize the client using CommonJS require syntax.

```javascript
const { OddsAPIClient } = require('odds-api-io');

const client = new OddsAPIClient({ apiKey: 'YOUR_API_KEY' });

const sports = await client.getSports();
console.log(`Found ${sports.length} sports`);
```

--------------------------------

### Arbitrage Bets Endpoint Example

Source: https://docs.odds-api.io/llms-full.txt

Example request and response for retrieving arbitrage betting opportunities.

```http
/arbitrage-bets?apiKey=YOUR_KEY&bookmakers=Bet365,SingBet&includeEventDetails=true
```

```json
[
  {
    "id": "arb_123456_ml",
    "eventId": 123456,
    "market": {"name": "ML", "hdp": null},
    "profitMargin": 0.0215,
    "impliedProbability": 0.9785,
    "totalStake": 100,
    "legs": [
      {"side": "home", "bookmaker": "Bet365", "odds": "2.15", "directLink": "..."},
      {"side": "away", "bookmaker": "SingBet", "odds": "2.10", "directLink": "..."}
    ],
    "optimalStakes": [
      {"side": "home", "bookmaker": "Bet365", "stake": 48.84, "potentialReturn": 105.00},
      {"side": "away", "bookmaker": "SingBet", "stake": 51.16, "potentialReturn": 107.44}
    ],
    "event": {...}
  }
]
```

--------------------------------

### Install Claude Code CLI

Source: https://docs.odds-api.io/ai-tools/claude-code

Installs the Claude Code tool globally on your system using npm.

```bash
npm install -g @anthropic-ai/claude-code
```

--------------------------------

### Historical Events Example

Source: https://docs.odds-api.io/llms-full.txt

Example URL for retrieving historical events for a specific league and date range.

```text
https://api.odds-api.io/v3/historical/events?sport=football&league=england-premier-league&from=2026-06-01T00:00:00Z&to=2026-07-01T00:00:00Z&apiKey=KEY
```

--------------------------------

### Historical Closing Lines Example

Source: https://docs.odds-api.io/llms-full.txt

Example URL for retrieving historical closing lines for multiple leagues.

```text
https://api.odds-api.io/v3/historical/closing-lines?sport=football&leagues=england-premier-league,spain-la-liga&from=2026-01-01T00:00:00Z&to=2026-01-31T23:59:59Z&markets=ML&bookmakers=Bet365,Unibet&apiKey=KEY
```

--------------------------------

### Port Conflict Notification

Source: https://docs.odds-api.io/development

Example output when the default port is already occupied.

```text
Port 3000 is already in use. Trying 3001 instead.
```

--------------------------------

### GET /arbitrage-bets

Source: https://docs.odds-api.io/llms.txt

Get arbitrage betting opportunities.

```APIDOC
## GET /arbitrage-bets

### Description
Get arbitrage opportunities.

### Method
GET

### Endpoint
/arbitrage-bets

### Parameters
#### Query Parameters
- **bookmakers** (string) - Required - List of bookmakers
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### Run Local Preview

Source: https://docs.odds-api.io/development

Commands to navigate to the documentation directory and start the local development server.

```bash
cd docs
mintlify dev
```

--------------------------------

### GET /value-bets

Source: https://docs.odds-api.io/llms.txt

Get value betting opportunities.

```APIDOC
## GET /value-bets

### Description
Get value betting opportunities.

### Method
GET

### Endpoint
/value-bets

### Parameters
#### Query Parameters
- **bookmaker** (string) - Required - Bookmaker name
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### GET /odds/updated

Source: https://docs.odds-api.io/llms.txt

Get recently updated odds.

```APIDOC
## GET /odds/updated

### Description
Get recently updated odds.

### Method
GET

### Endpoint
/odds/updated

### Parameters
#### Query Parameters
- **since** (string) - Required - Timestamp
- **bookmaker** (string) - Required - Bookmaker name
- **sport** (string) - Required - Sport name
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### Define request and response examples

Source: https://docs.odds-api.io/ai-tools/cursor

Use RequestExample and ResponseExample to document API interactions.

```bash
curl -X POST 'https://api.example.com/users' \
  -H 'Content-Type: application/json' \
  -d '{"name": "John Doe", "email": "john@example.com"}'
```

```json
{
  "id": "user_123",
  "name": "John Doe", 
  "email": "john@example.com",
  "created_at": "2024-01-15T10:30:00Z"
}
```

--------------------------------

### GET /odds/multi

Source: https://docs.odds-api.io/llms.txt

Get odds for multiple events.

```APIDOC
## GET /odds/multi

### Description
Get odds for multiple events (up to 10).

### Method
GET

### Endpoint
/odds/multi

### Parameters
#### Query Parameters
- **eventIds** (string) - Required - Comma-separated list of event IDs
- **bookmakers** (string) - Required - List of bookmakers
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### Quick Start with TypeScript

Source: https://docs.odds-api.io/guides/sdks

Initialize the client and fetch sports, events, and odds data.

```typescript
import { OddsAPIClient } from 'odds-api-io';

const client = new OddsAPIClient({ apiKey: 'YOUR_API_KEY' });

// Get all sports
const sports = await client.getSports();

// Get Premier League events
const events = await client.getEvents({
  sport: 'football',
  league: 'england-premier-league',
});

// Get odds from multiple bookmakers
const odds = await client.getEventOdds({
  eventId: events[0].id,
  bookmakers: 'Bet365,SingBet,FanDuel',
});

// Display odds with direct bet links
for (const [bookie, markets] of Object.entries(odds.bookmakers)) {
  const ml = markets.find(m => m.name === 'ML');
  if (ml?.odds?.[0]) {
    const o = ml.odds[0];
    console.log(`${bookie}: H ${o.home} | D ${o.draw} | A ${o.away}`);
  }
}

// Direct bet links
for (const [bookie, url] of Object.entries(odds.urls || {})) {
  console.log(`  Bet at ${bookie}: ${url}`);
}
```

--------------------------------

### GET /odds

Source: https://docs.odds-api.io/llms.txt

Get odds for a specific event.

```APIDOC
## GET /odds

### Description
Get odds for an event.

### Method
GET

### Endpoint
/odds

### Parameters
#### Query Parameters
- **eventId** (string) - Required - The event ID
- **bookmakers** (string) - Required - List of bookmakers
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### GET /events/live

Source: https://docs.odds-api.io/llms.txt

Get currently live events.

```APIDOC
## GET /events/live

### Description
Get currently live events (includes optional clock object: minute, playedSeconds, period, running, statusDetail, serve, injuryTime).

### Method
GET

### Endpoint
/events/live

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### GET /odds/movements

Source: https://docs.odds-api.io/llms.txt

Get odds movement history for an event.

```APIDOC
## GET /odds/movements

### Description
Get odds movement history.

### Method
GET

### Endpoint
/odds/movements

### Parameters
#### Query Parameters
- **eventId** (string) - Required - The event ID
- **bookmaker** (string) - Required - Bookmaker name
- **market** (string) - Required - Market name
- **apiKey** (string) - Required - Your API key
```

--------------------------------

### API Authentication Example

Source: https://docs.odds-api.io/api-reference/introduction

Demonstrates the required query parameter format for API key authentication.

```text
https://api.odds-api.io/v3/events?apiKey=YOUR_API_KEY&sport=football
```

--------------------------------

### GET /odds/movements

Source: https://docs.odds-api.io/llms-full.txt

Get historical odds movements for a specific market.

```APIDOC
## GET /odds/movements

### Description
Get historical odds movements for a specific market.

### Method
GET

### Endpoint
/odds/movements

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Your API key
- **eventId** (integer) - Required - Event ID
- **bookmaker** (string) - Required - Bookmaker name
- **market** (string) - Required - Market name (e.g., "ML", "Totals")
- **marketLine** (float) - Optional - Handicap line (required for non-ML markets)

### Request Example
/odds/movements?apiKey=YOUR_KEY&eventId=123456&bookmaker=SingBet&market=ML
```

--------------------------------

### Connection URL Examples

Source: https://docs.odds-api.io/guides/websockets

Various configurations for filtering live events, specific leagues, or multiple sports.

```bash
# All live football events with main markets only
wss://api.odds-api.io/v3/ws?apiKey=xxx&sport=football&status=live&markets=ML,Spread,Totals

# Specific leagues
wss://api.odds-api.io/v3/ws?apiKey=xxx&leagues=england-premier-league,spain-la-liga&markets=ML

# Specific events
wss://api.odds-api.io/v3/ws?apiKey=xxx&eventIds=12345,67890,11111

# Multiple sports, prematch only
wss://api.odds-api.io/v3/ws?apiKey=xxx&sport=football,basketball,tennis&status=prematch
```

--------------------------------

### Create Cursor configuration directory

Source: https://docs.odds-api.io/ai-tools/cursor

Initialize the .cursor directory in the root of your documentation repository.

```bash
mkdir -p .cursor
```

--------------------------------

### Connect to WebSocket with Replay URL

Source: https://docs.odds-api.io/guides/websockets

Example URL structure for initiating a WebSocket connection with a specific sequence number for replay.

```bash
wss://api.odds-api.io/v3/ws?apiKey=xxx&markets=ML,Spread,Totals&lastSeq=482917
```

--------------------------------

### Connect to WebSocket API

Source: https://docs.odds-api.io/api-reference/websocket

Examples for establishing a WebSocket connection and handling incoming messages across different environments.

```javascript
const WebSocket = require('ws');

const apiKey = process.env.ODDS_API_KEY;
const params = new URLSearchParams({
  apiKey,
  markets: 'ML,Spread,Totals',
  sport: 'football',
  status: 'live'
});

const ws = new WebSocket(`wss://api.odds-api.io/v3/ws?${params}`);

ws.onopen = () => console.log("Connecting...");

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);

  if (data.type === 'welcome') {
    console.log("Connected! Filters:", data.sport_filter, data.status_filter);
  } else if (data.type === 'resync_required') {
    console.log("Resync required:", data.reason);
    console.log("Fetch a REST snapshot with includeSeq=true, then reconnect with that seq.");
  } else if (data.type === 'updated') {
    console.log(`Match ${data.id} at ${data.bookie}:`, data.markets.length, "markets");
  }
};

ws.onerror = (err) => console.error("Error:", err);
ws.onclose = () => console.log("Disconnected");
```

```javascript
const apiKey = 'YOUR_API_KEY';
const params = new URLSearchParams({
  apiKey,
  markets: 'ML,Spread,Totals',
  leagues: 'england-premier-league'
});

const ws = new WebSocket(`wss://api.odds-api.io/v3/ws?${params}`);

ws.onopen = () => console.log("Connecting...");

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  if (data.type === 'welcome') {
    console.log("Connected! Leagues:", data.leagues_filter);
  } else if (data.type === 'resync_required') {
    console.log("Resync required:", data.reason);
  } else {
    console.log(`${data.type}: Match ${data.id}`);
  }
};

ws.onerror = (err) => console.error("Error:", err);
ws.onclose = () => console.log("Disconnected");
```

```python
import websocket
import json
import os
from urllib.parse import urlencode

api_key = os.environ['ODDS_API_KEY']
params = urlencode({
    'apiKey': api_key,
    'markets': 'ML,Spread,Totals',
    'sport': 'football',
    'status': 'live'
})

def on_open(ws):
    print("Connecting...")

def on_message(ws, message):
    data = json.loads(message)
    if data['type'] == 'welcome':
        print(f"Connected! Filters: {data['sport_filter']}, {data['status_filter']}")
    elif data['type'] == 'resync_required':
        print(f"Resync required: {data['reason']}")
    elif data['type'] == 'updated':
        print(f"Match {data['id']} at {data['bookie']}")

def on_error(ws, error):
    print(f"Error: {error}")

def on_close(ws, close_status_code, close_msg):
    print("Disconnected")

ws = websocket.WebSocketApp(
    f"wss://api.odds-api.io/v3/ws?{params}",
    on_open=on_open,
    on_message=on_message,
    on_error=on_error,
    on_close=on_close
)
ws.run_forever()
```

```php
<?php
use WebSocket\Client;

$apiKey = getenv('ODDS_API_KEY');
$params = http_build_query([
    'apiKey' => $apiKey,
    'markets' => 'ML,Spread,Totals',
    'sport' => 'football',
    'status' => 'live'
]);

$client = new Client("wss://api.odds-api.io/v3/ws?{$params}");

while (true) {
    try {
        $data = json_decode($client->receive(), true);

        if ($data['type'] === 'welcome') {
            echo "Connected! Filters: " . implode(', ', $data['sport_filter']) . "\n";
        } elseif ($data['type'] === 'resync_required') {
            echo "Resync required: {$data['reason']}\n";
        } else {
            echo "Type: {$data['type']}, Match: {$data['id']}\n";
        }
    } catch (Exception $e) {
        echo "Error: " . $e->getMessage() . "\n";
        break;
    }
}
```

--------------------------------

### Dropping Odds Endpoint Example

Source: https://docs.odds-api.io/llms-full.txt

Example request and response for tracking significant odds movements.

```http
/dropping-odds?apiKey=YOUR_KEY&sport=football&minDrop=10&includeEventDetails=true
```

```json
[
  {
    "eventId": 69455182,
    "event": {
      "home": "Manchester City",
      "away": "Arsenal",
      "date": "2025-10-15T15:00:00Z",
      "sport": {"name": "Football", "slug": "football"},
      "league": {"name": "England - Premier League", "slug": "england-premier-league"}
    },
    "market": {"name": "Spread", "hdp": -1.5},
    "betSide": "home",
    "odds": {
      "opening": 2.05,
      "current": 1.52,
      "drop": {
        "sinceOpening": 25.9,
        "12h": 8.4,
        "24h": 12.3,
        "48h": null
      }
    },
    "lastMovedAt": 1775851240182,
    "updatedAt": 1775854172851
  },
  {
    "eventId": 61301179,
    "market": {"name": "Player Passes", "hdp": 34.5, "label": "Carlos Baleba"},
    "betSide": "over",
    "odds": {
      "opening": 3.75,
      "current": 1.5,
      "drop": {"sinceOpening": 60, "12h": null, "24h": null, "48h": null}
    },
    "lastMovedAt": 1776281915401,
    "updatedAt": 1776283503652
  }
]
```

--------------------------------

### VS Code Copilot Instructions

Source: https://docs.odds-api.io/ai-vibe-coding

Configuration for .github/copilot-instructions.md to provide workspace-wide API context.

```markdown
# Odds-API.io Context

This project integrates with Odds-API.io for sports betting odds data.

Base URL: https://api.odds-api.io/v3
Authentication: API key as query parameter

Key endpoints:
- GET /sports - List available sports
- GET /events?sport={slug}&apiKey={key} - Get events
- GET /odds?eventId={id}&bookmakers={list}&apiKey={key} - Get odds
- GET /dropping-odds?sport={slug}&apiKey={key} - Dropping odds (paid plans only)

Full docs: https://docs.odds-api.io/llms-full.txt
```

--------------------------------

### Configure WebSocket Channels

Source: https://docs.odds-api.io/api-reference/websocket

Examples of connecting to the WebSocket API with different channel configurations to control data stream delivery.

```bash
# Odds + live scores + status changes
wss://api.odds-api.io/v3/ws?apiKey=xxx&channels=odds,scores,status&markets=ML,Spread,Totals
# Scoreboard only (no odds traffic, no markets needed)
wss://api.odds-api.io/v3/ws?apiKey=xxx&channels=scores,status&sport=football
```

--------------------------------

### WebSocket Connection Examples

Source: https://docs.odds-api.io/api-reference/websocket

Various URL configurations for filtering WebSocket streams by sport, league, event, or status.

```bash
# Live football with main markets
wss://api.odds-api.io/v3/ws?apiKey=xxx&sport=football&status=live&markets=ML,Spread,Totals

# Specific leagues
wss://api.odds-api.io/v3/ws?apiKey=xxx&leagues=england-premier-league,spain-la-liga&markets=ML

# Specific events
wss://api.odds-api.io/v3/ws?apiKey=xxx&eventIds=12345,67890

# Multiple sports, prematch only
wss://api.odds-api.io/v3/ws?apiKey=xxx&sport=football,basketball&status=prematch
```

--------------------------------

### Initialize and Use Python Client

Source: https://docs.odds-api.io/guides/sdks

Basic usage for fetching sports, events, and odds using the synchronous OddsAPIClient.

```python
from odds_api import OddsAPIClient

client = OddsAPIClient(api_key="YOUR_API_KEY")

# Get all sports
sports = client.get_sports()

# Get Premier League events
events = client.get_events(sport="football", league="england-premier-league")

# Get odds from multiple bookmakers
odds = client.get_event_odds(
    event_id=events[0]['id'],
    bookmakers="Bet365,SingBet,FanDuel"
)

# Display odds with direct bet links
for bookie, markets in odds['bookmakers'].items():
    ml = next((m for m in markets if m['name'] == 'ML'), None)
    if ml:
        o = ml['odds'][0]
        print(f"{bookie}: H {o['home']} | D {o['draw']} | A {o['away']}")

# Direct bet links
for bookie, url in odds.get('urls', {}).items():
    print(f"  Bet at {bookie}: {url}")
```

--------------------------------

### OpenAPI Specification for Get Sports

Source: https://docs.odds-api.io/api-reference/sports/get-sports

Defines the /sports GET endpoint and the associated response schemas for successful requests and error handling.

```yaml
openapi: 3.0.0
info:
  description: >-
    Odds-API.io is a powerful sports betting odds comparison API, providing
    real-time data from 265+ bookmakers across 34 sports with near zero latency.


    - 265+ bookmakers supported

    - 34 sports including Football, Basketball, Tennis, Esports and more

    - Real-time odds with close to zero latency

    - Pre-match & In-play odds coverage

    - 99.9% uptime for reliability
  title: Odds-API.io - Real-Time Sports Betting Odds API (v3)
  contact: {}
  version: 3.0.0
servers:
  - url: https://api.odds-api.io/v3
security: []
paths:
  /sports:
    get:
      tags:
        - Sports
      summary: Get Sports
      description: Returns a list of sports with name and slug
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/controllers.SportResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
components:
  schemas:
    controllers.SportResponse:
      type: object
      properties:
        name:
          type: string
          example: Football
        slug:
          type: string
          example: football
    controllers.ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Error message
```

--------------------------------

### Authenticated API Requests

Source: https://docs.odds-api.io/authentication

Examples of how to include the API key in requests using various programming languages.

```bash
curl "https://api.odds-api.io/v3/events?apiKey=YOUR_API_KEY&sport=football"
```

```javascript
const apiKey = process.env.ODDS_API_KEY;

const response = await fetch(
  `https://api.odds-api.io/v3/events?apiKey=${apiKey}&sport=football`
);
const data = await response.json();
```

```python
import os
import requests

api_key = os.environ.get('ODDS_API_KEY')

response = requests.get(
    'https://api.odds-api.io/v3/events',
    params={
        'apiKey': api_key,
        'sport': 'football'
    }
)
data = response.json()
```

```php
<?php
$apiKey = getenv('ODDS_API_KEY');

$url = 'https://api.odds-api.io/v3/events?' . http_build_query([
    'apiKey' => $apiKey,
    'sport' => 'football'
]);

$response = file_get_contents($url);
$data = json_decode($response, true);
```

--------------------------------

### OpenAPI Definition for Get Participants

Source: https://docs.odds-api.io/api-reference/participants/get-participants

The OpenAPI specification defining the /participants GET endpoint, including required parameters and response schemas.

```yaml
openapi: 3.0.0
info:
  description: >-
    Odds-API.io is a powerful sports betting odds comparison API, providing
    real-time data from 265+ bookmakers across 34 sports with near zero latency.


    - 265+ bookmakers supported

    - 34 sports including Football, Basketball, Tennis, Esports and more

    - Real-time odds with close to zero latency

    - Pre-match & In-play odds coverage

    - 99.9% uptime for reliability
  title: Odds-API.io - Real-Time Sports Betting Odds API (v3)
  contact: {}
  version: 3.0.0
servers:
  - url: https://api.odds-api.io/v3
security: []
paths:
  /participants:
    get:
      tags:
        - Participants
      summary: Get Participants
      description: Returns participants (teams) for a specified sport
      parameters:
        - description: API key for authentication
          name: apiKey
          in: query
          required: true
          schema:
            type: string
        - example: '"football"'
          description: Sport slug (e.g. football)
          name: sport
          in: query
          required: true
          schema:
            type: string
        - example: '"Chelsea"'
          description: Search term to filter by name
          name: search
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/dto.ParticipantDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    dto.ParticipantDto:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        sport:
          description: slug format (e.g., "football")
          type: string
    controllers.ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Error message
```

--------------------------------

### ChatGPT Documentation Fetch Command

Source: https://docs.odds-api.io/ai-vibe-coding

Command to instruct ChatGPT to ingest the full API documentation.

```text
Read the documentation at https://docs.odds-api.io/llms-full.txt and help me build [your project] using the Odds-API.io API.
```

--------------------------------

### Claude Documentation Fetch Command

Source: https://docs.odds-api.io/ai-vibe-coding

Command to instruct Claude to ingest the full API documentation.

```text
Please fetch and read https://docs.odds-api.io/llms-full.txt to understand the Odds-API.io API, then help me [your task].
```

--------------------------------

### OpenAPI Specification for Get Bookmakers

Source: https://docs.odds-api.io/api-reference/bookmakers/get-bookmakers

Defines the GET /bookmakers endpoint, including response schemas for successful requests and various error codes.

```yaml
openapi: 3.0.0
info:
  description: >-
    Odds-API.io is a powerful sports betting odds comparison API, providing
    real-time data from 265+ bookmakers across 34 sports with near zero latency.


    - 265+ bookmakers supported

    - 34 sports including Football, Basketball, Tennis, Esports and more

    - Real-time odds with close to zero latency

    - Pre-match & In-play odds coverage

    - 99.9% uptime for reliability
  title: Odds-API.io - Real-Time Sports Betting Odds API (v3)
  contact: {}
  version: 3.0.0
servers:
  - url: https://api.odds-api.io/v3
security: []
paths:
  /bookmakers:
    get:
      tags:
        - Bookmakers
      summary: Get Bookmakers
      description: Fetch a list of supported bookmakers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/models.Bookmaker'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
components:
  schemas:
    models.Bookmaker:
      type: object
      properties:
        active:
          type: boolean
        name:
          type: string
    controllers.ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Error message
```

--------------------------------

### OpenAPI Specification for Get Leagues

Source: https://docs.odds-api.io/api-reference/leagues/get-leagues

Defines the /leagues GET endpoint, including required parameters like apiKey and sport, and the expected response structure.

```yaml
openapi: 3.0.0
info:
  description: >-
    Odds-API.io is a powerful sports betting odds comparison API, providing
    real-time data from 265+ bookmakers across 34 sports with near zero latency.


    - 265+ bookmakers supported

    - 34 sports including Football, Basketball, Tennis, Esports and more

    - Real-time odds with close to zero latency

    - Pre-match & In-play odds coverage

    - 99.9% uptime for reliability
  title: Odds-API.io - Real-Time Sports Betting Odds API (v3)
  contact: {}
  version: 3.0.0
servers:
  - url: https://api.odds-api.io/v3
security: []
paths:
  /leagues:
    get:
      tags:
        - Leagues
      summary: Get Leagues
      description: >-
        Returns a list of leagues (name, slug, event count) for a specified
        sport
      parameters:
        - description: API key for authentication
          name: apiKey
          in: query
          required: true
          schema:
            type: string
        - example: '"football"'
          description: Sport slug (e.g. football, basketball)
          name: sport
          in: query
          required: true
          schema:
            type: string
        - example: false
          description: If true, include leagues without active events
          name: all
          in: query
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/controllers.LeagueResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    controllers.LeagueResponse:
      type: object
      properties:
        eventsCount:
          type: integer
          example: 32
        name:
          type: string
          example: England - Premier League
        slug:
          type: string
          example: england-premier-league
    controllers.ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: Error message
```

--------------------------------

### Define Mintlify technical writing rules

Source: https://docs.odds-api.io/ai-tools/windsurf

Create this file in the project root to provide Cascade AI with context on project structure, writing standards, and component usage.

```markdown
# Mintlify technical writing rule

## Project context

- This is a documentation project on the Mintlify platform
- We use MDX files with YAML frontmatter  
- Navigation is configured in `docs.json`
- We follow technical writing best practices

## Writing standards

- Use second person ("you") for instructions
- Write in active voice and present tense
- Start procedures with prerequisites
- Include expected outcomes for major steps
- Use descriptive, keyword-rich headings
- Keep sentences concise but informative

## Required page structure

Every page must start with frontmatter:

```yaml
---
title: "Clear, specific title"
description: "Concise description for SEO and navigation"
---
```

## Mintlify components

### Callouts

- `<Note>` for helpful supplementary information
- `<Warning>` for important cautions and breaking changes
- `<Tip>` for best practices and expert advice  
- `<Info>` for neutral contextual information
- `<Check>` for success confirmations

### Code examples

- When appropriate, include complete, runnable examples
- Use `<CodeGroup>` for multiple language examples
- Specify language tags on all code blocks
- Include realistic data, not placeholders
- Use `<RequestExample>` and `<ResponseExample>` for API docs

### Procedures

- Use `<Steps>` component for sequential instructions
- Include verification steps with `<Check>` components when relevant
- Break complex procedures into smaller steps

### Content organization

- Use `<Tabs>` for platform-specific content
- Use `<Accordion>` for progressive disclosure
- Use `<Card>` and `<CardGroup>` for highlighting content
- Wrap images in `<Frame>` components with descriptive alt text

## API documentation requirements

- Document all parameters with `<ParamField>` 
- Show response structure with `<ResponseField>`
- Include both success and error examples
- Use `<Expandable>` for nested object properties
- Always include authentication examples

## Quality standards

- Test all code examples before publishing
- Use relative paths for internal links
- Include alt text for all images
- Ensure proper heading hierarchy (start with h2)
- Check existing patterns for consistency
```

--------------------------------

### Configure Odds-API MCP Server

Source: https://docs.odds-api.io/ai-vibe-coding

Installation and configuration commands for various AI environments.

```bash
claude mcp add odds-api --env ODDS_API_KEY="your-api-key" -- npx -y odds-api-mcp-server
```

```json
{
  "mcpServers": {
    "odds-api": {
      "command": "npx",
      "args": ["-y", "odds-api-mcp-server"],
      "env": {
        "ODDS_API_KEY": "your-api-key"
      }
    }
  }
}
```

```json
{
  "odds-api": {
    "command": "npx",
    "args": ["-y", "odds-api-mcp-server"],
    "env": {
      "ODDS_API_KEY": "your-api-key"
    }
  }
}
```

--------------------------------

### OpenAPI Specification for Get Events

Source: https://docs.odds-api.io/api-reference/events/get-events

Defines the /events GET endpoint, including required authentication, query parameters for filtering, and expected response schemas.

```yaml
openapi: 3.0.0
info:
  description: >-
    Odds-API.io is a powerful sports betting odds comparison API, providing
    real-time data from 265+ bookmakers across 34 sports with near zero latency.


    - 265+ bookmakers supported

    - 34 sports including Football, Basketball, Tennis, Esports and more

    - Real-time odds with close to zero latency

    - Pre-match & In-play odds coverage

    - 99.9% uptime for reliability
  title: Odds-API.io - Real-Time Sports Betting Odds API (v3)
  contact: {}
  version: 3.0.0
servers:
  - url: https://api.odds-api.io/v3
security: []
paths:
  /events:
    get:
      tags:
        - Events
      summary: Get Events
      description: Returns events with enhanced filtering and pagination
      parameters:
        - description: API key for authentication
          name: apiKey
          in: query
          required: true
          schema:
            type: string
        - example: '"football"'
          description: Sport slug (e.g. football)
          name: sport
          in: query
          required: true
          schema:
            type: string
        - example: '"england-premier-league"'
          description: League slug (e.g. england-premier-league)
          name: league
          in: query
          schema:
            type: string
        - example: 38
          description: Filter by participant ID (home or away)
          name: participantId
          in: query
          schema:
            type: integer
        - example: '"pending,live"'
          description: Comma-separated event statuses (e.g. pending,live,settled)
          name: status
          in: query
          schema:
            type: string
        - example: '"2025-10-28T10:00:00Z"'
          description: Start date/time in RFC3339 format (e.g. 2025-10-28T10:00:00Z)
          name: from
          in: query
          schema:
            type: string
        - example: '"2025-10-28T23:59:59Z"'
          description: >-
            End date/time in RFC3339 format (e.g. 2025-10-28T23:59:59Z). If
            omitted, defaults to 14 days from now.
          name: to
          in: query
          schema:
            type: string
        - example: '"SingBet"'
          description: >-
            Filter by bookmaker name - returns only events that have odds
            available from this bookmaker (e.g. SingBet)
          name: bookmaker
          in: query
          schema:
            type: string
        - example: 20
          description: >-
            Maximum number of events to return. Every response is capped at
            5000; use limit + skip to paginate larger ranges.
          name: limit
          in: query
          schema:
            type: integer
        - example: 0
          description: Number of events to skip (for pagination)
          name: skip
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/dto.SimpleEventDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/controllers.ErrorResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    dto.SimpleEventDto:
      type: object
      properties:
        away:
          type: string
        awayId:
          type: integer
        bookmakerCount:
          type: integer
        date:
          type: string
        home:
          type: string
        homeId:
          type: integer
        id:
          type: integer
        league:
          $ref: '#/components/schemas/dto.League'
        scores:
          $ref: '#/components/schemas/dto.Score'
        sport:
```

--------------------------------

### Configure Custom Port

Source: https://docs.odds-api.io/development

Run the development server on a specific port using the --port flag.

```bash
mintlify dev --port 3333
```
Tokens:
Raw