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

# Get account coverage

> Get account coverage: 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/account/coverage`

## Authentication

`ApiKey` or `AccountSession`

## Parameters

| Name | Location | Required | Description |
| - | - | - | - |
| `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/account/coverage
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/account/coverage:
    get:
      summary: getAccountCoverage
      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: getAccountCoverage
      parameters:
        - 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/CoveragePage'
          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: []
        - AccountSession: []
components:
  schemas:
    CoveragePage:
      additionalProperties: false
      properties:
        data:
          items:
            $ref: '#/components/schemas/CoverageView'
          type: array
        meta:
          $ref: '#/components/schemas/Meta'
        missing:
          items:
            $ref: '#/components/schemas/Missing'
          type: array
      required:
        - data
        - missing
        - meta
      type: object
    CoverageView:
      additionalProperties: false
      properties:
        competitions:
          items:
            $ref: '#/components/schemas/Competition'
          type: array
        fixtures:
          items:
            $ref: '#/components/schemas/NamespaceFixture'
          type: array
        measured_at:
          format: date-time
          type: string
        scope:
          type: string
        sources:
          items:
            $ref: '#/components/schemas/CoverageSource'
          type: array
      required:
        - sources
        - fixtures
        - competitions
        - measured_at
        - scope
      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
    Competition:
      additionalProperties: false
      properties:
        country:
          type: string
        external_ids:
          additionalProperties:
            type: string
          type: object
        id:
          $ref: '#/components/schemas/ID'
        name:
          minLength: 1
          type: string
        slug:
          minLength: 1
          type: string
        sport_id:
          $ref: '#/components/schemas/ID'
      required:
        - id
        - sport_id
        - slug
        - name
      type: object
    NamespaceFixture:
      additionalProperties: false
      properties:
        fixture:
          $ref: '#/components/schemas/FixtureInfo'
        namespace:
          type: string
      required:
        - namespace
        - fixture
      type: object
    CoverageSource:
      additionalProperties: false
      properties:
        brand:
          $ref: '#/components/schemas/Brand'
        collection:
          type: string
        entitled:
          type: boolean
        families:
          items:
            $ref: '#/components/schemas/Family'
          type: array
        fixture_count:
          type: integer
        fresh_slots:
          type: integer
        inplay:
          $ref: '#/components/schemas/InPlayCoverage'
        last_confirmed:
          format: date-time
          type: string
        namespace:
          type: string
        quote_slots:
          type: integer
        rights:
          type: string
        source:
          $ref: '#/components/schemas/Source'
        state:
          type: string
      required:
        - inplay
        - source
        - brand
        - namespace
        - collection
        - families
        - entitled
        - state
        - rights
      type: object
    Family:
      enum:
        - 1x2
        - total
        - asian_handicap
      type: string
    ID:
      maximum: 9007199254740991
      minimum: 1
      type: integer
    InvalidParam:
      additionalProperties: false
      properties:
        name:
          type: string
        reason:
          type: string
      required:
        - name
        - reason
      type: object
    FixtureInfo:
      additionalProperties: false
      properties:
        away:
          $ref: '#/components/schemas/Participant'
        bindings:
          items:
            $ref: '#/components/schemas/Binding'
          type: array
        fixture:
          $ref: '#/components/schemas/Fixture'
        home:
          $ref: '#/components/schemas/Participant'
        identity_scope:
          enum:
            - reviewed_group
            - source_local
          type: string
      required:
        - fixture
        - home
        - away
        - identity_scope
        - bindings
      type: object
    Brand:
      additionalProperties: false
      properties:
        id:
          $ref: '#/components/schemas/ID'
        name:
          minLength: 1
          type: string
        slug:
          minLength: 1
          type: string
      required:
        - id
        - slug
        - name
      type: object
    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
    Source:
      additionalProperties: false
      properties:
        brand_id:
          $ref: '#/components/schemas/ID'
        enabled:
          type: boolean
        feed_group_id:
          $ref: '#/components/schemas/ID'
        id:
          $ref: '#/components/schemas/ID'
        kind:
          $ref: '#/components/schemas/SourceKind'
        region:
          minLength: 1
          type: string
        slug:
          minLength: 1
          type: string
      required:
        - id
        - slug
        - brand_id
        - region
        - kind
        - enabled
      type: object
    Participant:
      additionalProperties: false
      properties:
        external_ids:
          additionalProperties:
            type: string
          type: object
        id:
          $ref: '#/components/schemas/ID'
        kind:
          enum:
            - team
            - player
          type: string
        name:
          minLength: 1
          type: string
        sport_id:
          $ref: '#/components/schemas/ID'
      required:
        - id
        - sport_id
        - name
        - kind
      type: object
    Binding:
      additionalProperties: false
      properties:
        group_fixture_id:
          $ref: '#/components/schemas/ID'
        native_fixture_id:
          $ref: '#/components/schemas/ID'
        revision:
          type: integer
        source_fixture_id:
          type: string
        source_id:
          $ref: '#/components/schemas/ID'
        source_swapped:
          type: boolean
        state:
          type: string
        swapped:
          type: boolean
      required:
        - source_id
        - source_fixture_id
        - native_fixture_id
        - state
        - revision
        - swapped
        - source_swapped
      type: object
    Fixture:
      additionalProperties: false
      properties:
        away_id:
          $ref: '#/components/schemas/ID'
        competition_id:
          $ref: '#/components/schemas/ID'
        external_ids:
          additionalProperties:
            type: string
          type: object
        home_id:
          $ref: '#/components/schemas/ID'
        id:
          $ref: '#/components/schemas/ID'
        previous_fixture_id:
          $ref: '#/components/schemas/ID'
        reissued_fixture_id:
          $ref: '#/components/schemas/ID'
        sport_id:
          $ref: '#/components/schemas/ID'
        start_ts:
          format: date-time
          type: string
        status:
          enum:
            - scheduled
            - live
            - ended
            - cancelled
          type: string
      required:
        - id
        - sport_id
        - competition_id
        - home_id
        - away_id
        - start_ts
        - status
      type: object
    SourceKind:
      enum:
        - sportsbook
        - exchange
        - prediction
      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
    AccountSession:
      description: >-
        Clerk session JWT, or one-hour CLI-only local session. No cookie
        authentication.
      scheme: bearer
      type: http

````

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