> ## 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.

# List odds

> List odds: request contract, authentication, parameters and response behavior for the Oddswire private pilot.

Private local pilot with account-wide included credits. Namespace-scoped IDs; overage off. Successful data pages cost one credit; account/errors/304/aborted or timed-out deliveries are free. No payment or source distribution rights are implied.

`GET /v1/odds`

## Authentication

`ApiKey`

## Parameters

| Name | Location | Required | Description |
| - | - | - | - |
| `namespace` | query | Yes | Explicit pilot namespace; numeric IDs are scoped to it. |
| `limit` | query | No | Page size 1..100; default 25. |
| `cursor` | query | No | Opaque query-bound cursor; restart on 409 after data changes. |
| `fixture` | query | No | Comma-separated namespace-scoped fixture/group IDs (max 25). |
| `competition` | query | No | Comma-separated competition IDs. |
| `sport` | query | No | Comma-separated sport IDs. |
| `books` | query | No | Source/region IDs, not brand IDs (comma separated). |
| `from` | query | No | Inclusive UTC-normalized RFC3339 kickoff bound. |
| `to` | query | No | Exclusive RFC3339 kickoff bound. |
| `status` | query | No | Stored fixture state. |
| `markets` | query | No | Families: 1x2,total,asian\_handicap. |
| `period` | query | No | Market period. |
| `format` | query | No | Display format; canonical decimal/native units remain unchanged. |
| `include_inactive` | query | No | Explicitly include stale/suspended/unavailable retained quotes; invalid quotes remain excluded. |
| `line_quarters` | query | No | Exact signed home-relative quarter line in group orientation. |
| `If-None-Match` | header | No | Weak semantic ETag; freshness and access are revalidated before 304. |

## Responses

| Status | Meaning |
| - | - |
| 200 | A typed page. Each successful data page costs one included credit, including explicit missing/insufficient states; account introspection is free. missing\[] covers the full query. |
| 304 | Semantically unchanged after authentication and eligibility validation; always zero credits, including at exhausted quota. |
| 400 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 401 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 402 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 403 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 404 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 405 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 409 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 414 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 422 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 429 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 500 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 503 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |
| 504 | Structured problem; see [error handling](https://docs.oddswire.io/errors.md). |

Full request and response schemas: [OpenAPI](https://docs.oddswire.io/openapi.json). [Authentication](https://docs.oddswire.io/authentication.md) · [Prices and coverage](https://docs.oddswire.io/data.md) · [Errors and credits](https://docs.oddswire.io/errors.md).


## OpenAPI

````yaml GET /v1/odds
openapi: 3.1.2
info:
  description: >-
    Generated from canonical/account/usage DTOs and handler registries. Atomic
    included credits and durable usage, UTC monthly cycles, overage off. Full
    local response write/flush is the observable completion boundary; uncertain
    crash/outage deliveries recover free. Live Clerk login needs provider setup.
    Test-only Stripe billing uses signed durable receipts and reconciled app
    entitlements; real sandbox verification remains open. Dashboard and
    WebSocket are local pilots. Bounded history/as-of/lines and CSV/Parquet
    exports require separate current history/export grants and source-purpose
    reviews. Public launch remains gated. Namespaces are never joined by
    coincident IDs.
  title: Oddswire REST v1 local pilot
  version: 1.0.0
servers:
  - url: http://127.0.0.1:9113
security: []
externalDocs:
  description: WebSocket v1 AsyncAPI contract
  url: http://127.0.0.1:9113/asyncapi.json
paths:
  /v1/odds:
    get:
      summary: listOdds
      description: >-
        Private local pilot with account-wide included credits. Namespace-scoped
        IDs; overage off. Successful data pages cost one credit;
        account/errors/304/aborted or timed-out deliveries are free. No payment
        or source distribution rights are implied.
      operationId: listOdds
      parameters:
        - description: Explicit pilot namespace; numeric IDs are scoped to it.
          in: query
          name: namespace
          required: true
          schema:
            type: string
        - description: Page size 1..100; default 25.
          in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            type: integer
        - description: Opaque query-bound cursor; restart on 409 after data changes.
          in: query
          name: cursor
          required: false
          schema:
            type: string
        - description: Comma-separated namespace-scoped fixture/group IDs (max 25).
          in: query
          name: fixture
          required: false
          schema:
            type: string
        - description: Comma-separated competition IDs.
          in: query
          name: competition
          required: false
          schema:
            type: string
        - description: Comma-separated sport IDs.
          in: query
          name: sport
          required: false
          schema:
            type: string
        - description: Source/region IDs, not brand IDs (comma separated).
          in: query
          name: books
          required: false
          schema:
            type: string
        - description: Inclusive UTC-normalized RFC3339 kickoff bound.
          in: query
          name: from
          required: false
          schema:
            type: string
        - description: Exclusive RFC3339 kickoff bound.
          in: query
          name: to
          required: false
          schema:
            type: string
        - description: Stored fixture state.
          in: query
          name: status
          required: false
          schema:
            enum:
              - scheduled
              - live
              - ended
              - cancelled
            type: string
        - description: 'Families: 1x2,total,asian_handicap.'
          in: query
          name: markets
          required: false
          schema:
            type: string
        - description: Market period.
          in: query
          name: period
          required: false
          schema:
            enum:
              - full_time
              - first_half
            type: string
        - description: Display format; canonical decimal/native units remain unchanged.
          in: query
          name: format
          required: false
          schema:
            enum:
              - decimal
              - american
            type: string
        - description: >-
            Explicitly include stale/suspended/unavailable retained quotes;
            invalid quotes remain excluded.
          in: query
          name: include_inactive
          required: false
          schema:
            type: boolean
        - description: Exact signed home-relative quarter line in group orientation.
          in: query
          name: line_quarters
          required: false
          schema:
            type: integer
        - description: Weak semantic ETag; freshness and access are revalidated before 304.
          in: header
          name: If-None-Match
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OddsPage'
          description: >-
            A typed page. Each successful data page costs one included credit,
            including explicit missing/insufficient states; account
            introspection is free. missing[] covers the full query.
          headers:
            X-Oddswire-Credit-Cost:
              $ref: '#/components/headers/X-Oddswire-Credit-Cost'
            X-Oddswire-Credits-Limit:
              $ref: '#/components/headers/X-Oddswire-Credits-Limit'
            X-Oddswire-Credits-Remaining:
              $ref: '#/components/headers/X-Oddswire-Credits-Remaining'
            X-Oddswire-Credits-Reserved:
              $ref: '#/components/headers/X-Oddswire-Credits-Reserved'
            X-Oddswire-Credits-Reset:
              $ref: '#/components/headers/X-Oddswire-Credits-Reset'
            X-Oddswire-Credits-Used:
              $ref: '#/components/headers/X-Oddswire-Credits-Used'
            X-Oddswire-Metering:
              $ref: '#/components/headers/X-Oddswire-Metering'
            X-Oddswire-Overage:
              $ref: '#/components/headers/X-Oddswire-Overage'
            X-Oddswire-Usage-State:
              $ref: '#/components/headers/X-Oddswire-Usage-State'
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '304':
          description: >-
            Semantically unchanged after authentication and eligibility
            validation; always zero credits, including at exhausted quota.
          headers:
            X-Oddswire-Credit-Cost:
              $ref: '#/components/headers/X-Oddswire-Credit-Cost'
            X-Oddswire-Credits-Limit:
              $ref: '#/components/headers/X-Oddswire-Credits-Limit'
            X-Oddswire-Credits-Remaining:
              $ref: '#/components/headers/X-Oddswire-Credits-Remaining'
            X-Oddswire-Credits-Reserved:
              $ref: '#/components/headers/X-Oddswire-Credits-Reserved'
            X-Oddswire-Credits-Reset:
              $ref: '#/components/headers/X-Oddswire-Credits-Reset'
            X-Oddswire-Credits-Used:
              $ref: '#/components/headers/X-Oddswire-Credits-Used'
            X-Oddswire-Metering:
              $ref: '#/components/headers/X-Oddswire-Metering'
            X-Oddswire-Overage:
              $ref: '#/components/headers/X-Oddswire-Overage'
            X-Oddswire-Usage-State:
              $ref: '#/components/headers/X-Oddswire-Usage-State'
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '402':
          $ref: '#/components/responses/Problem'
        '403':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/Problem'
        '405':
          $ref: '#/components/responses/Problem'
        '409':
          $ref: '#/components/responses/Problem'
        '414':
          $ref: '#/components/responses/Problem'
        '422':
          $ref: '#/components/responses/Problem'
        '429':
          $ref: '#/components/responses/Problem'
        '500':
          $ref: '#/components/responses/Problem'
        '503':
          $ref: '#/components/responses/Problem'
        '504':
          $ref: '#/components/responses/Problem'
      security:
        - ApiKey: []
components:
  schemas:
    OddsPage:
      additionalProperties: false
      properties:
        data:
          items:
            $ref: '#/components/schemas/Quote'
          type: array
        meta:
          $ref: '#/components/schemas/Meta'
        missing:
          items:
            $ref: '#/components/schemas/Missing'
          type: array
      required:
        - data
        - missing
        - meta
      type: object
    Quote:
      additionalProperties: false
      properties:
        age_seconds:
          type: number
        delivery:
          $ref: '#/components/schemas/PriceDelivery'
        display_format:
          enum:
            - decimal
            - american
          type: string
        display_odds:
          anyOf:
            - oneOf:
                - type: string
                - type: 'null'
            - type: 'null'
        fixture_id:
          $ref: '#/components/schemas/ID'
        fixture_phase:
          enum:
            - scheduled
            - live
            - ended
            - cancelled
          type: string
        freshness_limit_seconds:
          type: integer
        identity_scope:
          enum:
            - reviewed_group
            - source_local
          type: string
        inplay:
          $ref: '#/components/schemas/InPlayCoverage'
        mapping_revision:
          type: integer
        mapping_swapped:
          type: boolean
        market:
          $ref: '#/components/schemas/Market'
        outcome:
          $ref: '#/components/schemas/Outcome'
        quote_key:
          type: string
        reason:
          type: string
        source_swapped:
          type: boolean
        source_ts:
          anyOf:
            - oneOf:
                - format: date-time
                  type: string
                - type: 'null'
            - type: 'null'
        status:
          enum:
            - active
            - stale
            - suspended
            - unavailable
          type: string
        target_code:
          type: string
        target_line_quarters:
          anyOf:
            - oneOf:
                - type: integer
                - type: 'null'
            - type: 'null'
        terms:
          $ref: '#/components/schemas/Terms'
      required:
        - fixture_phase
        - quote_key
        - fixture_id
        - identity_scope
        - market
        - outcome
        - target_code
        - target_line_quarters
        - mapping_revision
        - source_swapped
        - mapping_swapped
        - delivery
        - source_ts
        - status
        - age_seconds
        - freshness_limit_seconds
        - display_format
        - display_odds
        - terms
      type: object
    Meta:
      additionalProperties: false
      properties:
        consistency:
          type: string
        count:
          type: integer
        namespace:
          type: string
        next_cursor:
          type: string
        request_id:
          type: string
        sent_ts:
          format: date-time
          type: string
        snapshot_ts:
          format: date-time
          type: string
        version:
          type: string
      required:
        - version
        - request_id
        - sent_ts
        - snapshot_ts
        - next_cursor
        - count
        - consistency
      type: object
    Missing:
      additionalProperties: false
      properties:
        detail:
          type: string
        family:
          $ref: '#/components/schemas/Family'
        fixture_id:
          $ref: '#/components/schemas/ID'
        quote_key:
          type: string
        reason:
          type: string
        source_id:
          $ref: '#/components/schemas/ID'
      required:
        - reason
        - detail
      type: object
    Problem:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          type: string
        invalid_params:
          items:
            $ref: '#/components/schemas/InvalidParam'
          type: array
        missing:
          items:
            $ref: '#/components/schemas/Missing'
          type: array
        request_id:
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      required:
        - type
        - title
        - status
        - detail
        - code
        - request_id
        - invalid_params
        - missing
      type: object
    PriceDelivery:
      additionalProperties: false
      properties:
        price:
          $ref: '#/components/schemas/LatestPrice'
        sent_ts:
          format: date-time
          type: string
      required:
        - price
        - sent_ts
      type: object
    ID:
      maximum: 9007199254740991
      minimum: 1
      type: integer
    InPlayCoverage:
      additionalProperties: false
      properties:
        families:
          items:
            $ref: '#/components/schemas/Family'
          type: array
        freshness_limit_seconds:
          type: integer
        mode:
          enum:
            - pre_match_only
            - local_test_only
          type: string
        reason:
          type: string
      required:
        - mode
        - families
        - freshness_limit_seconds
        - reason
      type: object
    Market:
      additionalProperties: false
      properties:
        family:
          $ref: '#/components/schemas/Family'
        id:
          $ref: '#/components/schemas/ID'
        line_quarters:
          type: integer
        name:
          minLength: 1
          type: string
        participant_id:
          $ref: '#/components/schemas/ID'
        period:
          $ref: '#/components/schemas/Period'
        settlement_rule:
          minLength: 1
          type: string
        sport_id:
          $ref: '#/components/schemas/ID'
      required:
        - id
        - sport_id
        - family
        - period
        - settlement_rule
        - name
      type: object
    Outcome:
      additionalProperties: false
      properties:
        code:
          enum:
            - home
            - draw
            - away
            - over
            - under
          type: string
        id:
          $ref: '#/components/schemas/ID'
        market_id:
          $ref: '#/components/schemas/ID'
        name:
          minLength: 1
          type: string
      required:
        - id
        - market_id
        - code
        - name
      type: object
    Terms:
      additionalProperties: false
      properties:
        fee_model:
          enum:
            - sportsbook_gross
            - native_schedule_unreviewed
            - unknown
          type: string
        fee_schedule:
          type: object
        fees_enabled:
          anyOf:
            - oneOf:
                - type: boolean
                - type: 'null'
            - type: 'null'
        rules_sha256:
          type: string
      required:
        - fee_model
        - fees_enabled
        - fee_schedule
      type: object
    Family:
      enum:
        - 1x2
        - total
        - asian_handicap
      type: string
    InvalidParam:
      additionalProperties: false
      properties:
        name:
          type: string
        reason:
          type: string
      required:
        - name
        - reason
      type: object
    LatestPrice:
      additionalProperties: false
      properties:
        confirmed_ts:
          format: date-time
          type: string
        observation:
          $ref: '#/components/schemas/PriceObservation'
      required:
        - observation
        - confirmed_ts
      type: object
    Period:
      enum:
        - full_time
        - first_half
      type: string
    PriceObservation:
      additionalProperties: false
      properties:
        event_id:
          format: uuid
          type: string
        key:
          $ref: '#/components/schemas/PriceKey'
        raw_payload_id:
          format: uuid
          type: string
        seen_ts:
          format: date-time
          type: string
        source_sequence:
          type: string
        source_ts:
          format: date-time
          type: string
        value:
          $ref: '#/components/schemas/PriceValue'
      required:
        - event_id
        - raw_payload_id
        - key
        - value
        - seen_ts
      type: object
    PriceKey:
      additionalProperties: false
      properties:
        depth:
          maximum: 3
          type: integer
        fixture_id:
          $ref: '#/components/schemas/ID'
        market_id:
          $ref: '#/components/schemas/ID'
        outcome_id:
          $ref: '#/components/schemas/ID'
        side:
          $ref: '#/components/schemas/Side'
        source_fixture_id:
          minLength: 1
          type: string
        source_id:
          $ref: '#/components/schemas/ID'
        source_market_id:
          minLength: 1
          type: string
        source_outcome_id:
          minLength: 1
          type: string
      required:
        - source_id
        - fixture_id
        - market_id
        - outcome_id
        - source_fixture_id
        - source_market_id
        - source_outcome_id
        - side
        - depth
      type: object
    PriceValue:
      additionalProperties: false
      properties:
        available_size:
          $ref: '#/components/schemas/Decimal'
        commission_rate:
          $ref: '#/components/schemas/Decimal'
        currency:
          pattern: ^[A-Z]{3}$
          type: string
        decimal_odds:
          $ref: '#/components/schemas/Decimal'
        fee_rate:
          $ref: '#/components/schemas/Decimal'
        main_line:
          type: boolean
        native_unit:
          $ref: '#/components/schemas/NativeUnit'
        native_value:
          $ref: '#/components/schemas/Decimal'
        size_unit:
          enum:
            - currency
            - contracts
          type: string
        state:
          $ref: '#/components/schemas/PriceState'
      required:
        - state
        - native_unit
      type: object
    Side:
      enum:
        - quote
        - back
        - lay
        - bid
        - ask
      type: string
    Decimal:
      pattern: ^(0|[1-9][0-9]{0,15})\.[0-9]{8}$
      type: string
    NativeUnit:
      enum:
        - decimal_odds
        - probability
      type: string
    PriceState:
      enum:
        - active
        - suspended
        - unavailable
      type: string
  headers:
    X-Oddswire-Credit-Cost:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Credits-Limit:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Credits-Remaining:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Credits-Reserved:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Credits-Reset:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Credits-Used:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Metering:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Overage:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Oddswire-Usage-State:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
    X-Request-ID:
      description: >-
        Account-scoped admission snapshot where authenticated: remaining
        excludes holds; used counts settled calls. Cost 1 reserves one credit;
        actual charge settles only after complete local write/flush. Inspect
        free account/usage by request ID for final state. UTC reset is RFC3339;
        overage is off. Unknown credentials disclose no account counters.
      schema:
        type: string
  responses:
    Problem:
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
      description: >-
        Structured actionable problem; errors consume zero credits. Quota
        exhaustion/unconfigured returns 402 with counters/reset headers and free
        usage guidance. 429 Retry-After is separate abuse control. No database
        details or credentials.
      headers:
        X-Oddswire-Credit-Cost:
          $ref: '#/components/headers/X-Oddswire-Credit-Cost'
        X-Oddswire-Credits-Limit:
          $ref: '#/components/headers/X-Oddswire-Credits-Limit'
        X-Oddswire-Credits-Remaining:
          $ref: '#/components/headers/X-Oddswire-Credits-Remaining'
        X-Oddswire-Credits-Reserved:
          $ref: '#/components/headers/X-Oddswire-Credits-Reserved'
        X-Oddswire-Credits-Reset:
          $ref: '#/components/headers/X-Oddswire-Credits-Reset'
        X-Oddswire-Credits-Used:
          $ref: '#/components/headers/X-Oddswire-Credits-Used'
        X-Oddswire-Metering:
          $ref: '#/components/headers/X-Oddswire-Metering'
        X-Oddswire-Overage:
          $ref: '#/components/headers/X-Oddswire-Overage'
        X-Oddswire-Usage-State:
          $ref: '#/components/headers/X-Oddswire-Usage-State'
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
  securitySchemes:
    ApiKey:
      in: header
      name: X-API-Key
      type: apiKey

````

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