> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oddswire.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Build with Oddswire

> Explore the Oddswire sports odds API, including authentication, football fixtures, REST odds, WebSocket updates, and historical prices.

One odds engine, explicit source coverage, predictable API behavior.

Start with a [cURL](https://docs.oddswire.io/quickstart-curl.md), [Python](https://docs.oddswire.io/quickstart-python.md) or [TypeScript](https://docs.oddswire.io/quickstart-typescript.md) quick start. Read the [REST reference](https://docs.oddswire.io/reference/listOdds.md) when you need exact parameters.

## Before the first request

Oddswire is a **private pilot**. The customer workspace uses production Clerk login at `https://oddswire.io/app`; signup creates a workspace with zero data grants. The deployed API at `https://api.oddswire.io` requires separately reviewed access. Local quick starts still target `http://127.0.0.1:9113` and install clients from a private product checkout; packages are not published to registries. This public documentation repository does not contain the engine or SDK source.

1. Sign in to the [workspace](https://oddswire.io/app) and complete [invite-only onboarding](https://oddswire.io/beta). Production Clerk login is configured. CLI-issued sessions remain development-only access.
2. Review current API entitlements and [coverage](https://oddswire.io/app/coverage). New identities start with zero grants. Technical source access does not establish customer display or redistribution rights.
3. Create an account-owned key in [API keys](https://oddswire.io/app/keys). Copy it once into a private environment variable. API keys belong in headers.
4. Run one example. Successful data pages consume credits, including empty or insufficient results. Account/control calls and errors are free.

## Contracts and local clients

* [OpenAPI 3.1.2](https://docs.oddswire.io/openapi.json): REST requests, parameters, response schemas and account controls.
* [AsyncAPI](https://docs.oddswire.io/asyncapi.json) and [WebSocket wire schema](https://docs.oddswire.io/websocket.schema.json): the separate streaming protocol.
* [Authentication](https://docs.oddswire.io/authentication.md), [data and coverage](https://docs.oddswire.io/data.md), [errors and credits](https://docs.oddswire.io/errors.md), [streaming](https://docs.oddswire.io/websocket.md).
* Every guide has a `.md` representation. Machine-readable indexes: [/llms.txt](https://docs.oddswire.io/llms.txt) and [/llms-full.txt](https://docs.oddswire.io/llms-full.txt).

The documentation exposes technical contracts without collecting your credentials. Use the authenticated [playground](https://oddswire.io/app/playground) for requests. [Historical prices and closing lines](https://docs.oddswire.io/history.md) require separate grants and source-use review. Fair-price consensus currently has no configured eligible sharp reference.


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