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

# Get coverage

> Check whether selected Rook markets, listings or a family support the capabilities your workflow needs. Supply one selector scope, or omit selectors for the coverage overview; venue can narrow the results.

Results distinguish catalog presence from analytical support and market-data availability. They disclose supported settlement conventions, history ranges, sampling intervals, freshness and service limits where applicable. A market may be known and have family membership while its payout analysis remains unsupported. Check coverage before selecting analysis inputs rather than treating missing support as a zero payout.

See the [integration guide](/guides/coverage-versioning) for the workflow and interpretation of this response.


## OpenAPI

````yaml GET /coverage
openapi: 3.1.0
info:
  title: Rook API
  version: 0.1.0-design
  description: Markets, settlement relationships, scenarios, payouts and market data.
servers:
  - url: https://api.rook.pm/v1
    description: Proposed API origin; not an assertion these operations are callable.
security:
  - ApiKeyBearer: []
tags:
  - name: Reference data
    description: Events, unified markets and native-ID resolution.
  - name: Families and scenarios
    description: Family scope and versioned scenario columns.
  - name: Relationships and Combos
    description: Related-market discovery, selected-set inference and Combo interpretation.
  - name: Payouts and exposure
    description: Scoped per-unit payouts and stateless portfolio/candidate calculations.
  - name: Market data
    description: Current prices, history, L2 books, prints, statistics and published fees.
  - name: Fair values
    description: Future private customer estimates; not Rook forecasts.
  - name: Coverage and updates
    description: Supported capabilities and incremental semantic changes.
paths:
  /coverage:
    get:
      tags:
        - Coverage and updates
      summary: Get coverage
      description: >-
        Check whether selected Rook markets, listings or a family support the
        capabilities your workflow needs. Supply one selector scope, or omit
        selectors for the coverage overview; venue can narrow the results.


        Results distinguish catalog presence from analytical support and
        market-data availability. They disclose supported settlement
        conventions, history ranges, sampling intervals, freshness and service
        limits where applicable. A market may be known and have family
        membership while its payout analysis remains unsupported. Check coverage
        before selecting analysis inputs rather than treating missing support as
        a zero payout.
      operationId: getCoverage
      parameters:
        - name: listing_ids
          in: query
          required: false
          description: >-
            Rook listing IDs from /markets or /markets:resolve. Select the venue
            and outcome side explicitly; repeat the query parameter for multiple
            listings.
          schema:
            type: array
            items:
              type: string
              description: Opaque text identifier. Preserve its exact value.
              minLength: 1
            minItems: 1
          style: form
          explode: true
        - name: market_ids
          in: query
          required: false
          description: >-
            Rook market IDs in this resource. On an event these reflect its
            source venue membership; on a family they identify the related
            market members.
          schema:
            type: array
            items:
              type: string
              description: Opaque text identifier. Preserve its exact value.
              minLength: 1
            minItems: 1
          style: form
          explode: true
          example:
            - mkt_fed_dec_2026_cut
        - name: family_id
          in: query
          required: false
          description: >-
            Rook family ID connecting related markets across original venue
            events. Narrows the selection to this resource.
          schema:
            type: string
            description: Opaque text identifier. Preserve its exact value.
            minLength: 1
        - name: venue
          in: query
          required: false
          description: >-
            Venue identifier, such as polymarket or kalshi. Required when
            looking up a venue-native ID; never inferred from the ID.
          schema:
            type: string
        - name: page_size
          in: query
          required: false
          description: >-
            Requested maximum items; service caps disclosed by coverage.
            Oversize requests fail explicitly.
          schema:
            type: integer
            minimum: 1
            default: 50
        - name: page_token
          in: query
          required: false
          description: >-
            Opaque continuation; reuse the same filters/order. Cursor pins the
            original snapshot.
          schema:
            type: string
        - name: X-Client-Request-Id
          in: header
          required: false
          schema:
            type: string
          description: Caller correlation reference; not an idempotency guarantee.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCoverageResponse'
              example:
                items:
                  - input_id: mkt_fed_dec_2026_cut
                    venue: polymarket
                    family_id: fam_fed_dec_2026
                    catalog_status: KNOWN
                    analytical_status: SUPPORTED
                    capabilities:
                      - CONTRACT_DETAILS
                      - RELATIONSHIPS
                      - SCENARIOS
                      - PAYOUTS
                      - EXPOSURE
                      - QUOTES
                      - PRICE_HISTORY
                      - ORDERBOOKS
                      - TRADES
                    supported_convention_ids:
                      - demo_all_legs_win_v1
                    history_start: '2026-10-01T00:00:00Z'
                    available_intervals:
                      - 1m
                      - 1h
                    observed_at: '2026-10-19T12:00:00Z'
                next_page_token: null
                snapshot_id: snap_rates_20261019_120000
                as_of: '2026-10-19T12:00:00Z'
          headers:
            X-Request-Id:
              description: Server request trace ID.
              schema:
                type: string
                description: Opaque text identifier. Preserve its exact value.
                minLength: 1
components:
  schemas:
    GetCoverageResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CoverageRecord'
        next_page_token:
          anyOf:
            - type: string
            - type: 'null'
        snapshot_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        as_of:
          type: string
          format: date-time
      required:
        - items
        - next_page_token
        - snapshot_id
        - as_of
      additionalProperties: true
    CoverageRecord:
      type: object
      properties:
        input_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        venue:
          type: string
        family_id:
          type: string
          minLength: 1
          description: >-
            Rook family ID connecting related markets across original venue
            events.
        catalog_status:
          type: string
          enum:
            - KNOWN
            - UNKNOWN
        analytical_status:
          type: string
          enum:
            - SUPPORTED
            - PARTIAL
            - UNSUPPORTED
        capabilities:
          type: array
          items:
            type: string
        supported_convention_ids:
          type: array
          items:
            type: string
            description: Opaque text identifier. Preserve its exact value.
            minLength: 1
        history_start:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        available_intervals:
          type: array
          items:
            type: string
        reason:
          anyOf:
            - type: string
            - type: 'null'
        observed_at:
          type: string
          format: date-time
      required:
        - input_id
        - catalog_status
        - analytical_status
        - capabilities
        - observed_at
      additionalProperties: true
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      description: >-
        Proposed server-to-server API key. No client request HMAC signing scheme
        is specified.

````

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