# OddsPapi API

## Get Started

### Start here

- [OddsPapi - B2B Sports Betting Odds API](https://docs.oddspapi.io/index.md): B2B low-latency realtime sports odds API. Stream live betting odds, fixtures, scores, lineups, injuries and statistics via WebSocket. REST API for snapshots and historical data.
- [Quickstart Guide - Connect to Odds API in Minutes](https://docs.oddspapi.io/quickstart.md): Get started with OddsPapi in minutes. Connect to the WebSocket gateway, authenticate with your API key, subscribe to channels, and stream realtime sports odds data.
- [AI & LLM Integration - Documentation Export](https://docs.oddspapi.io/ai.md): Download OddsPapi documentation for AI tools, LLMs, and offline use. Machine-readable exports in TXT and OpenAPI JSON formats for ChatGPT, Claude, and other AI assistants.

### Coverage

- [Sports Coverage - Fixtures & Futures by Sport](https://docs.oddspapi.io/coverage.md): Coverage of the OddsPapi B2B odds API: 350+ bookmakers anchored on sharp trading books, plus 60+ sports and prediction-market topics with fixtures and futures availability per sportId.
- [Bookmaker Coverage - Sharps, Exchanges & Retail Books](https://docs.oddspapi.io/coverage/bookmakers.md): What OddsPapi covers across 350+ bookmakers: sharp trading books, exchanges and prediction markets, and retail sportsbooks — with per-book capabilities, freshness bounds, and status signals.
- [Market Coverage - Market Types, Lines, Periods & Player Props](https://docs.oddspapi.io/coverage/markets.md): What markets OddsPapi covers: market types, period scoping, Asian and European handicaps, totals, player props, and how to discover the full market map per sport via GET /markets.

### Build with OddsPapi

- [Prediction Markets & Exchanges - Orderbook Depth & Limits](https://docs.oddspapi.io/guides/prediction-markets.md): Build market-making and arbitrage systems on OddsPapi: aggregated exchange prices with back/lay orderbook depth, native venue IDs for order routing, stake limits, and measured per-venue delay.
- [Sharp-Line Trading & CLV - Limits, Delay & Closing Line Value](https://docs.oddspapi.io/guides/sharp-line-trading.md): Trade against sharp bookmaker lines on OddsPapi: stake limits per price, measured observation delay per book, main-line filtering, staleness handling, and CLV measurement.
- [Running OddsPapi as a Second Feed - Mapping & Cross-Validation](https://docs.oddspapi.io/guides/second-feed.md): Add OddsPapi alongside an existing odds feed: join fixtures via external provider IDs and the mapping endpoints, compare prices on stable selection keys, and measure which feed is faster.
- [Powering a Sportsbook - Schedule, Prices, In-Play & Settlement](https://docs.oddspapi.io/guides/sportsbook.md): Build a full betting product on OddsPapi: discover sports and tournaments, load schedules, model markets and outcomes, stream prices and in-play state, and settle bets.
- [Settlement & Grading - Per-Outcome Grades, Quarter Lines & Periods](https://docs.oddspapi.io/guides/settlement.md): Grade bets on OddsPapi: per-outcome settlement grades on frozen IDs, Asian quarter-line half-stake math, period-market grading, and handling UNDECIDED and CANCELLED.
- [Evaluating OddsPapi - Measure Latency, Coverage & Recovery Yourself](https://docs.oddspapi.io/guides/evaluation.md): A trial protocol for OddsPapi: log per-book observation delay against the published numbers, drill the recovery paths, verify coverage from the API, and settle the speed question with CLV.
- [Periods per Sport - When fulltime and result Differ](https://docs.oddspapi.io/guides/periods.md): Understand the OddsPapi period vocabulary per sport: when fulltime is a distinct fact, when it collapses into result, and how to group markets by marketType and period without hard-coding assumptions.
- [Parlays & SGP - Building a Betslip](https://docs.oddspapi.io/guides/parlays.md): A workflow guide for multi-leg betting on OddsPapi: choosing between the parlay and SGP endpoints, keeping a live slip priced, comparing bookmakers, and degrading gracefully when a leg suspends.

## API

### Getting Started

- [REST API Overview - HTTP Endpoints for Sports Data](https://docs.oddspapi.io/api-reference/overview.md): OddsPapi REST API reference. HTTP endpoints for sports betting data snapshots, metadata retrieval, historical odds, and recovery workflows. Supports 8 languages.
- [API Authentication - How to Authenticate Requests](https://docs.oddspapi.io/api-reference/authentication.md): Learn how to authenticate OddsPapi API requests using your API key, as an X-API-Key header or an apiKey query parameter.
- [API Error Codes - HTTP Status Codes & Error Handling](https://docs.oddspapi.io/api-reference/errors.md): Complete guide to OddsPapi API error responses. HTTP status codes, error formats, rate limit headers, and troubleshooting common error causes.
- [API Rate Limits - Request Quotas & Throttling](https://docs.oddspapi.io/api-reference/rate-limits.md): OddsPapi API rate limits and quotas. Request limits per endpoint, rate limit headers, and best practices for handling 429 responses.
- [Core Concepts - IDs, Data Models & Best Practices](https://docs.oddspapi.io/api-reference/concepts.md): Understand OddsPapi data models: fixture IDs, market IDs, odds identifiers, entity relationships, timestamps, and implementation best practices for arbitrage detection.
- [Parlays - Price Multi-Leg Bets](https://docs.oddspapi.io/api-reference/parlays.md): Price accumulators and correlated same-game parlays from OddsPapi oddsIds. Compare bookmakers side by side, read the correlation margin, and handle suspended or missing legs.
- [Enumerations - Status IDs, Periods & Settlement Statuses](https://docs.oddspapi.io/api-reference/enumerations.md): Complete reference of all fixed enum values in the OddsPapi API: statusId lifecycle values, period keys, and settlement statuses.
- [Reliability & Operations - Uptime, Status & Incident Response](https://docs.oddspapi.io/api-reference/reliability.md): How OddsPapi delivers reliable realtime data for trading: redundant architecture, live status page, recovery design, support response, and incident handling.

### Reference

#### common

- [Get Bookmakers](https://docs.oddspapi.io/api-reference/common/get-bookmakers.md): List bookmakers.
- [Get Sports](https://docs.oddspapi.io/api-reference/common/get-sports.md): List sports.
- [Get Tournaments](https://docs.oddspapi.io/api-reference/common/get-tournaments.md): List tournaments.
- [Get Seasons](https://docs.oddspapi.io/api-reference/common/get-seasons.md): List seasons.
- [Get Participants](https://docs.oddspapi.io/api-reference/common/get-participants.md): List participants.
- [Get Players](https://docs.oddspapi.io/api-reference/common/get-players.md): List players.
- [Get Venues](https://docs.oddspapi.io/api-reference/common/get-venues.md): List venues by explicit IDs.
- [Get Markets](https://docs.oddspapi.io/api-reference/common/get-markets.md): List markets.
- [Get Currencies](https://docs.oddspapi.io/api-reference/common/get-currencies.md): List currencies and conversion values.

#### fixtures

- [Fixtures Filtered](https://docs.oddspapi.io/api-reference/fixtures/fixtures-filtered.md): List fixtures.
- [Fixtures Today](https://docs.oddspapi.io/api-reference/fixtures/fixtures-today.md): List today's fixtures.
- [Fixtures Live](https://docs.oddspapi.io/api-reference/fixtures/fixtures-live.md): List live fixtures.

#### fixtures/odds

- [Fixture Odds](https://docs.oddspapi.io/api-reference/fixturesodds/fixture-odds.md): Get current odds for a fixture.
- [Fixture Odds CLV](https://docs.oddspapi.io/api-reference/fixturesodds/fixture-odds-clv.md): Get opening vs closing line values (OLV/CLV) for a fixture.
- [Fixture Odds Historical](https://docs.oddspapi.io/api-reference/fixturesodds/fixture-odds-historical.md): Get historical odds timeline for a fixture.
- [Fixtures Odds Main](https://docs.oddspapi.io/api-reference/fixturesodds/fixtures-odds-main.md): Get current main odds for multiple fixtures.

#### parlays

- [Parlay Odds](https://docs.oddspapi.io/api-reference/parlays/parlay-odds.md): Price a parlay (accumulator) from selected `oddsIds`.
- [Same-Game Parlay Odds](https://docs.oddspapi.io/api-reference/parlays/same-game-parlay-odds.md): Price a correlated same-game parlay (SGP) from selected `oddsIds`.

#### mapping

- [Fixture Mapping](https://docs.oddspapi.io/api-reference/mapping/fixture-mapping.md): List fixture mappings for external bookmakers.
- [Future Mapping](https://docs.oddspapi.io/api-reference/mapping/future-mapping.md): Map internal future IDs to bookmaker/provider future IDs.

#### settlement

- [Fixture Settlement](https://docs.oddspapi.io/api-reference/settlement/fixture-settlement.md): Get settlements for a fixture.
- [Future Settlement](https://docs.oddspapi.io/api-reference/settlement/future-settlement.md): Get settlements for a future.

#### futures

- [Futures Filtered](https://docs.oddspapi.io/api-reference/futures/futures-filtered.md): List futures.
- [Futures Live](https://docs.oddspapi.io/api-reference/futures/futures-live.md): List live futures.

#### futures/odds

- [Future Odds](https://docs.oddspapi.io/api-reference/futuresodds/future-odds.md): Get latest odds for a future.
- [Future Odds CLV](https://docs.oddspapi.io/api-reference/futuresodds/future-odds-clv.md): Get OLV and CLV for a future’s odds.
- [Future Odds Historical](https://docs.oddspapi.io/api-reference/futuresodds/future-odds-historical.md): Get historical odds changes for a future.

#### media

- [Media Bookmaker](https://docs.oddspapi.io/api-reference/media/media-bookmaker.md): Get bookmaker logo.
- [Media Category](https://docs.oddspapi.io/api-reference/media/media-category.md): Get category icon.
- [Media Tournament](https://docs.oddspapi.io/api-reference/media/media-tournament.md): Get tournament image.
- [Media Participant](https://docs.oddspapi.io/api-reference/media/media-participant.md): Get participant image.

## WebSocket

### Getting Started

- [WebSocket API Overview - Realtime Sports Data Streaming](https://docs.oddspapi.io/websocket/overview.md): Connect to OddsPapi WebSocket gateway for low-latency realtime sports betting data. Stream live odds, scores, fixtures, and events with JSON or MessagePack encoding.
- [WebSocket Authentication & Channel Filters](https://docs.oddspapi.io/websocket/auth.md): Authenticate to OddsPapi WebSocket gateway and configure channel subscriptions. Filter by sports, tournaments, fixtures, and bookmakers for targeted data streaming.
- [WebSocket Compression (zstd)](https://docs.oddspapi.io/websocket/compression.md): Cut WebSocket bandwidth with zstd. Two opt-in modes: receiveType: zstd (dictless, decode in one line) or receiveType: zstd-dict (trained per-channel dictionaries, best ratio).
- [WebSocket Resume & Replay - Connection Recovery](https://docs.oddspapi.io/websocket/resume-replay.md): Handle WebSocket disconnections gracefully. Resume data streams without gaps using serverEpoch and entryId cursors. Automatic replay for missed updates.
- [WebSocket Troubleshooting - Common Issues & Solutions](https://docs.oddspapi.io/websocket/troubleshooting.md): Debug OddsPapi WebSocket connection issues. Solutions for login errors, empty responses, binary decoding, backpressure disconnects, close codes, and resume failures.
- [Interactive WebSocket Console - Test Live Data](https://docs.oddspapi.io/websocket/console.md): Test OddsPapi WebSocket API in your browser. Interactive console for connecting to the gateway, subscribing to channels, and viewing realtime sports data.

### Channels

- [Fixtures Channel - Match Metadata & Schedules](https://docs.oddspapi.io/websocket/channels/fixtures.md): Stream realtime fixture updates via WebSocket. Match status, start times, participants, tournaments, scores, and provider ID mappings for Betradar, Pinnacle, Flashscore, OpticOdds.
- [Futures Channel - Season & Outright Markets](https://docs.oddspapi.io/websocket/channels/futures.md): Stream futures and outright betting markets via WebSocket. Season-long markets, tournament winners, championship odds with timing windows and provider mappings.
- [Bookmakers Channel - Sportsbook Status & Metadata](https://docs.oddspapi.io/websocket/channels/bookmakers.md): Stream bookmaker status per fixture via WebSocket. Track which sportsbooks offer odds, detect stale/suspended markets, and monitor participant rotation flags.
- [Bookmakers Futures Channel - Outright Market Status](https://docs.oddspapi.io/websocket/channels/bookmakersFutures.md): Stream bookmaker availability for futures markets via WebSocket. Monitor which sportsbooks offer outright and season-long betting odds.
- [Odds Channel - Realtime Betting Odds Stream](https://docs.oddspapi.io/websocket/channels/odds.md): Low-latency realtime betting odds via WebSocket. Stream live odds aggregated from 350+ bookmakers. Decimal, fractional, American formats with orderbook depth.
- [Scores Channel - Live Score Updates](https://docs.oddspapi.io/websocket/channels/scores.md): Stream realtime live scores via WebSocket. Period-by-period score updates for all sports including result, halftime, quarters, sets, and periods.
- [Clocks Channel - Live Match Clock Updates](https://docs.oddspapi.io/websocket/channels/clocks.md): Stream realtime match clock updates via WebSocket. Period, remaining time, and stopped state for live fixtures.
- [Currencies Channel - Exchange Rates & Crypto Prices](https://docs.oddspapi.io/websocket/channels/currencies.md): Stream realtime currency exchange rates via WebSocket. Fiat and cryptocurrency pricing data including BTC, ETH, and major tokens for odds conversion.

## Changelog

### Releases

- [API Changelog - Updates, Features & Breaking Changes](https://docs.oddspapi.io/changelog/index.md): OddsPapi API changelog. New features, improvements, bug fixes, and breaking changes. Track WebSocket and REST API updates for sports betting data integration.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## AsyncAPI Specs

- [websocket](/asyncapi/websocket.json)

## Optional

- [Status+](https://oddspapi-v5.instatus.com)
- [ABP+](https://docs.55-tech.com/abp-api/overview)
- [MM+](https://docs.55-tech.com/mm-api/overview)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Chinese (68 pages)](https://docs.oddspapi.io/_llms/zh.txt): Documentation for Chinese.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.