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

# List fair values

> Future extension. Read your saved estimates in an authorized private scope_id. Optionally filter by outcome IDs, value type or update time; follow next_page_token with unchanged filters.

Each record retains its outcome/market version, source, observation and expiry times, revision and stale/superseded status. A rule amendment does not silently transfer an estimate to new settlement terms. Estimates stay private to the authenticated customer and scope; explicitly select any values used by future analytics.

*Future extension.*

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


## OpenAPI

````yaml GET /fair-values
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:
  /fair-values:
    get:
      tags:
        - Fair values
      summary: List fair values
      description: >-
        Future extension. Read your saved estimates in an authorized private
        scope_id. Optionally filter by outcome IDs, value type or update time;
        follow next_page_token with unchanged filters.


        Each record retains its outcome/market version, source, observation and
        expiry times, revision and stale/superseded status. A rule amendment
        does not silently transfer an estimate to new settlement terms.
        Estimates stay private to the authenticated customer and scope;
        explicitly select any values used by future analytics.
      operationId: listFairValues
      parameters:
        - name: scope_id
          in: query
          required: true
          description: >-
            Your authorized private book or strategy namespace; access comes
            from the API key.
          schema:
            type: string
            description: Opaque text identifier. Preserve its exact value.
            minLength: 1
          example: rates_desk
        - name: outcome_ids
          in: query
          required: false
          description: >-
            Only return estimates for these Rook outcome IDs. Repeat the
            parameter for multiple outcomes.
          schema:
            type: array
            items:
              type: string
              description: Opaque text identifier. Preserve its exact value.
              minLength: 1
            minItems: 1
          style: form
          explode: true
          example:
            - out_fed_dec_2026_cut_yes
        - name: value_type
          in: query
          required: false
          description: >-
            Filter customer estimates to PROBABILITY or EXPECTED_PAYOUT; these
            values have different units and meanings.
          schema:
            type: string
            enum:
              - PROBABILITY
              - EXPECTED_PAYOUT
        - name: updated_since
          in: query
          required: false
          description: Only saved estimates updated at or after this UTC timestamp.
          schema:
            type: string
            format: date-time
        - 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/ListFairValuesResponse'
              example:
                items:
                  - fair_value_id: fv_rates_cut_desk
                    scope_id: rates_desk
                    outcome_id: out_fed_dec_2026_cut_yes
                    market_version: '1'
                    value_type: PROBABILITY
                    probability_event: FULL_PAYOUT
                    value: '0.46'
                    source: rates-desk-model-v3
                    observed_at: '2026-10-19T11:45:00Z'
                    valid_until: '2026-10-19T18:00:00Z'
                    updated_at: '2026-10-19T12:00:00Z'
                    revision: '1'
                    status: CURRENT
                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:
    ListFairValuesResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/FairValue'
        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
    FairValue:
      type: object
      properties:
        fair_value_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        scope_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        outcome_id:
          type: string
          minLength: 1
          description: Rook payout-side ID. YES and NO have separate IDs.
        market_version:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        value_type:
          type: string
          enum:
            - PROBABILITY
            - EXPECTED_PAYOUT
        probability_event:
          anyOf:
            - type: string
              enum:
                - FULL_PAYOUT
            - type: 'null'
        value:
          $ref: '#/components/schemas/Decimal'
        currency:
          anyOf:
            - type: string
            - type: 'null'
        source:
          type: string
        observed_at:
          type: string
          format: date-time
        valid_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        updated_at:
          type: string
          format: date-time
        revision:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        status:
          type: string
          enum:
            - CURRENT
            - EXPIRED
            - SUPERSEDED
      required:
        - fair_value_id
        - scope_id
        - outcome_id
        - market_version
        - value_type
        - value
        - source
        - observed_at
        - updated_at
        - revision
        - status
      additionalProperties: true
    Decimal:
      type: string
      description: >-
        Exact base-10 value encoded as a string; no exponent or non-finite
        values.
      pattern: ^-?(0|[1-9][0-9]*)(\.[0-9]+)?$
  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.