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

# Evaluate exposure

> Calculate what supplied positions pay at settlement, and compare the effect of explicitly supplied hypothetical trades. Positions identify a Rook outcome/listing, a positive exact quantity and HELD or OWED convention. Candidates supply signed quantity changes; each candidate is evaluated separately against the same baseline.

Results include baseline and after-candidate payout groups, candidate deltas, best/worst cases with feasible witnesses, and requested contributions or rankings. Contributions reconcile to totals. Unrelated families or currencies remain separate; whole-book extrema are exact only when compatible joint witnesses exist.

Terminal payout is the settlement cash flow, not a probability or historical-entry P&L. Optional MIDPOINT or LIQUIDATION pricing uses Rook observations and reports missing or stale valuation inputs. No candidate fills, inventory writes or hedge discovery occur. Pin scenario versions to reproduce a result.

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


## OpenAPI

````yaml POST /evaluations:run
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:
  /evaluations:run:
    post:
      tags:
        - Payouts and exposure
      summary: Evaluate exposure
      description: >-
        Calculate what supplied positions pay at settlement, and compare the
        effect of explicitly supplied hypothetical trades. Positions identify a
        Rook outcome/listing, a positive exact quantity and HELD or OWED
        convention. Candidates supply signed quantity changes; each candidate is
        evaluated separately against the same baseline.


        Results include baseline and after-candidate payout groups, candidate
        deltas, best/worst cases with feasible witnesses, and requested
        contributions or rankings. Contributions reconcile to totals. Unrelated
        families or currencies remain separate; whole-book extrema are exact
        only when compatible joint witnesses exist.


        Terminal payout is the settlement cash flow, not a probability or
        historical-entry P&L. Optional MIDPOINT or LIQUIDATION pricing uses Rook
        observations and reports missing or stale valuation inputs. No candidate
        fills, inventory writes or hedge discovery occur. Pin scenario versions
        to reproduce a result.
      operationId: runEvaluation
      parameters:
        - name: X-Client-Request-Id
          in: header
          required: false
          schema:
            type: string
          description: Caller correlation reference; not an idempotency guarantee.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunEvaluationRequest'
            example:
              positions:
                - position_id: inventory_cut
                  instrument:
                    outcome_id: out_fed_dec_2026_cut_yes
                  position_type: HELD
                  quantity: '1000'
                - position_id: inventory_hold
                  instrument:
                    outcome_id: out_fed_dec_2026_hold_yes
                  position_type: HELD
                  quantity: '300'
              candidates:
                - candidate_id: sell_250_cut
                  trades:
                    - trade_id: trade_cut_250
                      instrument:
                        outcome_id: out_fed_dec_2026_cut_yes
                      quantity_delta: '-250'
              scenario_pins:
                - family_id: fam_fed_dec_2026
                  scenario_version: '1'
              include:
                - SUMMARY
                - PAYOUTS
                - CONTRIBUTIONS
                - SCENARIOS
              pricing:
                mode: NONE
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RunEvaluationResponse'
              example:
                evaluation_id: eval_rates_sell_250_cut
                baseline:
                  groups:
                    - scenario_pins:
                        - family_id: fam_fed_dec_2026
                          scenario_version: '1'
                      scenario_columns:
                        - family_id: fam_fed_dec_2026
                          scenario_version: '1'
                          scenario_id: scn_cut
                        - family_id: fam_fed_dec_2026
                          scenario_version: '1'
                          scenario_id: scn_hold
                        - family_id: fam_fed_dec_2026
                          scenario_version: '1'
                          scenario_id: scn_hike
                      currency: USDC
                      total_scenario_count: 3
                      terminal_payouts:
                        - '1000'
                        - '300'
                        - '0'
                      minimum_payout: '0'
                      maximum_payout: '1000'
                      minimum_witnesses:
                        - family_id: fam_fed_dec_2026
                          scenario_version: '1'
                          scenario_id: scn_hike
                      maximum_witnesses:
                        - family_id: fam_fed_dec_2026
                          scenario_version: '1'
                          scenario_id: scn_cut
                      minimum_tie_count: 1
                      maximum_tie_count: 1
                      contributions:
                        - position_id: inventory_cut
                          outcome_id: out_fed_dec_2026_cut_yes
                          values:
                            - '1000'
                            - '0'
                            - '0'
                        - position_id: inventory_hold
                          outcome_id: out_fed_dec_2026_hold_yes
                          values:
                            - '0'
                            - '300'
                            - '0'
                  whole_book:
                    - status: EXACT
                      currency: USDC
                      minimum: '0'
                      maximum: '1000'
                      minimum_witness:
                        family_id: fam_fed_dec_2026
                        scenario_version: '1'
                        scenario_id: scn_hike
                      maximum_witness:
                        family_id: fam_fed_dec_2026
                        scenario_version: '1'
                        scenario_id: scn_cut
                candidates:
                  - candidate_id: sell_250_cut
                    after:
                      groups:
                        - scenario_pins:
                            - family_id: fam_fed_dec_2026
                              scenario_version: '1'
                          scenario_columns:
                            - family_id: fam_fed_dec_2026
                              scenario_version: '1'
                              scenario_id: scn_cut
                            - family_id: fam_fed_dec_2026
                              scenario_version: '1'
                              scenario_id: scn_hold
                            - family_id: fam_fed_dec_2026
                              scenario_version: '1'
                              scenario_id: scn_hike
                          currency: USDC
                          total_scenario_count: 3
                          terminal_payouts:
                            - '750'
                            - '300'
                            - '0'
                          minimum_payout: '0'
                          maximum_payout: '750'
                          minimum_witnesses:
                            - family_id: fam_fed_dec_2026
                              scenario_version: '1'
                              scenario_id: scn_hike
                          maximum_witnesses:
                            - family_id: fam_fed_dec_2026
                              scenario_version: '1'
                              scenario_id: scn_cut
                          minimum_tie_count: 1
                          maximum_tie_count: 1
                          contributions:
                            - position_id: inventory_cut
                              outcome_id: out_fed_dec_2026_cut_yes
                              values:
                                - '750'
                                - '0'
                                - '0'
                            - position_id: inventory_hold
                              outcome_id: out_fed_dec_2026_hold_yes
                              values:
                                - '0'
                                - '300'
                                - '0'
                      whole_book:
                        - status: EXACT
                          currency: USDC
                          minimum: '0'
                          maximum: '750'
                          minimum_witness:
                            family_id: fam_fed_dec_2026
                            scenario_version: '1'
                            scenario_id: scn_hike
                          maximum_witness:
                            family_id: fam_fed_dec_2026
                            scenario_version: '1'
                            scenario_id: scn_cut
                    delta_groups:
                      - scenario_columns:
                          - family_id: fam_fed_dec_2026
                            scenario_version: '1'
                            scenario_id: scn_cut
                          - family_id: fam_fed_dec_2026
                            scenario_version: '1'
                            scenario_id: scn_hold
                          - family_id: fam_fed_dec_2026
                            scenario_version: '1'
                            scenario_id: scn_hike
                        currency: USDC
                        payout_deltas:
                          - '-250'
                          - '0'
                          - '0'
                        improved_count: 0
                        worsened_count: 1
                coverage:
                  complete: true
                  submitted_count: 2
                  supported_count: 2
                  items:
                    - input_reference: out_fed_dec_2026_cut_yes
                      outcome_id: out_fed_dec_2026_cut_yes
                      status: SUPPORTED
                      family_ids:
                        - fam_fed_dec_2026
                    - input_reference: out_fed_dec_2026_hold_yes
                      outcome_id: out_fed_dec_2026_hold_yes
                      status: SUPPORTED
                      family_ids:
                        - fam_fed_dec_2026
                versions:
                  market_versions:
                    - market_id: mkt_fed_dec_2026_cut
                      version: '1'
                    - market_id: mkt_fed_dec_2026_hold
                      version: '1'
                  mapping_version: '1'
                  scenario_pins:
                    - family_id: fam_fed_dec_2026
                      scenario_version: '1'
                  as_of: '2026-10-19T12:00:00Z'
                pricing: []
                warnings: []
          headers:
            X-Request-Id:
              description: Server request trace ID.
              schema:
                type: string
                description: Opaque text identifier. Preserve its exact value.
                minLength: 1
components:
  schemas:
    RunEvaluationRequest:
      type: object
      properties:
        positions:
          type: array
          items:
            $ref: '#/components/schemas/Position'
          description: >-
            Current client positions with HELD/OWED convention and positive
            exact quantities; may be empty for standalone candidates.
        candidates:
          type: array
          items:
            $ref: '#/components/schemas/Candidate'
          description: >-
            Optional independently evaluated alternatives; trades inside each
            candidate form one simultaneous package.
        scenario_pins:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioPin'
          description: >-
            Optional family/version pins for the supplied book plus all
            candidates; current compatible versions chosen once otherwise.
        scenarios:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioColumn'
          minItems: 1
          description: >-
            Optional selected column references; conditions results on exactly
            that scenario domain.
        include:
          type: array
          items:
            type: string
            enum:
              - SUMMARY
              - PAYOUTS
              - CONTRIBUTIONS
              - OFFSETS
              - SCENARIOS
          description: >-
            Requested result detail; default SUMMARY. Full vectors must fit
            declared scope or fail explicitly.
          default:
            - SUMMARY
        ranking:
          $ref: '#/components/schemas/RankingRequest'
          description: >-
            Metric, direction and positive result limit; ranks the whole stated
            domain before limiting returned results.
        pricing:
          $ref: '#/components/schemas/PricingRequest'
          description: >-
            Rook price convention and optional maximum quote age; default mode
            NONE means payout-only.
        require_complete_coverage:
          type: boolean
          default: true
          description: >-
            True rejects incomplete structural coverage; false preserves
            explicitly scoped partial results.
      required:
        - positions
      additionalProperties: false
      description: >-
        At least one position or candidate is required. Empty positions is valid
        for standalone candidate analysis. All supplied holdings and candidates
        use a common comparison scope; selected scenarios condition the result.
      anyOf:
        - properties:
            positions:
              minItems: 1
        - required:
            - candidates
          properties:
            candidates:
              minItems: 1
    RunEvaluationResponse:
      type: object
      properties:
        evaluation_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        baseline:
          $ref: '#/components/schemas/BookResult'
        candidates:
          type: array
          items:
            $ref: '#/components/schemas/CandidateResult'
        coverage:
          $ref: '#/components/schemas/Coverage'
        versions:
          $ref: '#/components/schemas/VersionContext'
        pricing:
          type: array
          items:
            $ref: '#/components/schemas/PricingObservation'
        warnings:
          type: array
          items:
            type: string
      required:
        - evaluation_id
        - baseline
        - candidates
        - coverage
        - versions
        - pricing
        - warnings
      additionalProperties: true
      description: >-
        Trace ID does not imply a saved portfolio or GET-able evaluation.
        Full-scope extrema are not calculated from a truncated response page.
    Position:
      type: object
      properties:
        position_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        instrument:
          $ref: '#/components/schemas/InstrumentRef'
        position_type:
          type: string
          enum:
            - HELD
            - OWED
        quantity:
          $ref: '#/components/schemas/Decimal'
      required:
        - position_id
        - instrument
        - position_type
        - quantity
      additionalProperties: false
      description: >-
        Quantity must be strictly positive; position_type determines receipt
        versus obligation. No entry-price or RFQ quote inputs in the initial
        service.
    Candidate:
      type: object
      properties:
        candidate_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        trades:
          type: array
          items:
            $ref: '#/components/schemas/CandidateTrade'
          minItems: 1
      required:
        - candidate_id
        - trades
      additionalProperties: false
      description: >-
        A simultaneous trade package; distinct candidates are independent
        alternatives against the same baseline.
    ScenarioPin:
      type: object
      properties:
        family_id:
          type: string
          minLength: 1
          description: >-
            Rook family ID connecting related markets across original venue
            events.
        scenario_version:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
      required:
        - family_id
        - scenario_version
      additionalProperties: false
    ScenarioColumn:
      oneOf:
        - $ref: '#/components/schemas/ScenarioRef'
        - $ref: '#/components/schemas/JointScenarioRef'
    RankingRequest:
      type: object
      properties:
        metric:
          type: string
          enum:
            - TERMINAL_PAYOUT
            - MARK_TO_SETTLEMENT
        direction:
          type: string
          enum:
            - ASC
            - DESC
        limit:
          type: integer
          minimum: 1
          default: 10
      required:
        - metric
        - direction
      additionalProperties: false
    PricingRequest:
      type: object
      properties:
        mode:
          type: string
          enum:
            - NONE
            - MIDPOINT
            - LIQUIDATION
          default: NONE
        max_quote_age_ms:
          type: integer
          minimum: 0
      required:
        - mode
      additionalProperties: false
      description: >-
        Prices come from Rook. LIQUIDATION uses available bid/ask depth;
        incomplete execution-side coverage is disclosed, never assumed filled.
    BookResult:
      type: object
      properties:
        groups:
          type: array
          items:
            $ref: '#/components/schemas/ExposureGroup'
        whole_book:
          type: array
          items:
            $ref: '#/components/schemas/WholeBookExtreme'
      required:
        - groups
        - whole_book
      additionalProperties: true
    CandidateResult:
      type: object
      properties:
        candidate_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        after:
          $ref: '#/components/schemas/BookResult'
        delta_groups:
          type: array
          items:
            type: object
            properties:
              scenario_columns:
                type: array
                items:
                  $ref: '#/components/schemas/ScenarioColumn'
              currency:
                type: string
              payout_deltas:
                type: array
                items:
                  $ref: '#/components/schemas/ExactValue'
              improved_count:
                type: integer
                minimum: 0
              worsened_count:
                type: integer
                minimum: 0
            required:
              - currency
              - improved_count
              - worsened_count
            additionalProperties: false
      required:
        - candidate_id
        - after
        - delta_groups
      additionalProperties: true
    Coverage:
      type: object
      properties:
        complete:
          type: boolean
        submitted_count:
          type: integer
          minimum: 0
        supported_count:
          type: integer
          minimum: 0
        items:
          type: array
          items:
            $ref: '#/components/schemas/CoverageItem'
      required:
        - complete
        - submitted_count
        - supported_count
        - items
      additionalProperties: true
    VersionContext:
      type: object
      properties:
        market_versions:
          type: array
          items:
            type: object
            properties:
              market_id:
                type: string
                minLength: 1
                description: >-
                  Rook canonical market ID; obtain it by resolving a venue and
                  native market ID.
              version:
                type: string
                description: Opaque text identifier. Preserve its exact value.
                minLength: 1
            required:
              - market_id
              - version
            additionalProperties: false
        mapping_version:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        scenario_pins:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioPin'
        as_of:
          type: string
          format: date-time
      required:
        - market_versions
        - scenario_pins
        - as_of
      additionalProperties: true
    PricingObservation:
      type: object
      properties:
        listing_id:
          type: string
          minLength: 1
          description: >-
            Rook ID for one outcome listing on one venue; preserves venue
            provenance.
        quote_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        status:
          type: string
          enum:
            - AVAILABLE
            - STALE
            - INCOMPLETE
            - UNAVAILABLE
        price:
          anyOf:
            - $ref: '#/components/schemas/Decimal'
            - type: 'null'
        currency:
          type: string
        source_timestamp:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        received_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        fee_status:
          type: string
          enum:
            - KNOWN
            - PARTIAL
            - UNKNOWN
      required:
        - listing_id
        - status
        - price
        - currency
        - source_timestamp
        - received_at
        - fee_status
      additionalProperties: true
    InstrumentRef:
      type: object
      properties:
        outcome_id:
          type: string
          minLength: 1
          description: Rook payout-side ID. YES and NO have separate IDs.
        listing_id:
          type: string
          minLength: 1
          description: >-
            Rook ID for one outcome listing on one venue; preserves venue
            provenance.
      required: []
      additionalProperties: false
      description: Supply exactly one outcome_id or listing_id; never both.
      oneOf:
        - required:
            - outcome_id
        - required:
            - listing_id
    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]+)?$
    CandidateTrade:
      type: object
      properties:
        trade_id:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        instrument:
          $ref: '#/components/schemas/InstrumentRef'
        quantity_delta:
          $ref: '#/components/schemas/Decimal'
      required:
        - trade_id
        - instrument
        - quantity_delta
      additionalProperties: false
      description: >-
        Nonzero signed delta in desk payout units: positive acquires/increases a
        claim; negative decreases/writes an obligation under the stated
        convention. Does not assert execution eligibility.
    ScenarioRef:
      type: object
      properties:
        family_id:
          type: string
          minLength: 1
          description: >-
            Rook family ID connecting related markets across original venue
            events.
        scenario_version:
          type: string
          description: Opaque text identifier. Preserve its exact value.
          minLength: 1
        scenario_id:
          type: string
          minLength: 1
          description: Rook scenario ID within its family and published scenario version.
      required:
        - family_id
        - scenario_version
        - scenario_id
      additionalProperties: false
    JointScenarioRef:
      type: object
      properties:
        components:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioRef'
          minItems: 2
      required:
        - components
      additionalProperties: false
      description: >-
        Compatible tuple of Rook family scenario references; components have
        distinct family/version scopes.
    ExposureGroup:
      type: object
      properties:
        scenario_columns:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioColumn'
        scenario_pins:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioPin'
        currency:
          type: string
        total_scenario_count:
          type: integer
          minimum: 0
        terminal_payouts:
          type: array
          items:
            $ref: '#/components/schemas/ExactValue'
        minimum_payout:
          $ref: '#/components/schemas/ExactValue'
        maximum_payout:
          $ref: '#/components/schemas/ExactValue'
        minimum_witnesses:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioColumn'
        maximum_witnesses:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioColumn'
        minimum_tie_count:
          type: integer
          minimum: 0
        maximum_tie_count:
          type: integer
          minimum: 0
        ranked_outcomes:
          type: array
          items:
            $ref: '#/components/schemas/RankedOutcome'
        contributions:
          type: array
          items:
            $ref: '#/components/schemas/Contribution'
        offsets:
          type: array
          items:
            $ref: '#/components/schemas/OffsetFinding'
      required:
        - scenario_pins
        - currency
        - total_scenario_count
        - minimum_payout
        - maximum_payout
        - minimum_witnesses
        - maximum_witnesses
        - minimum_tie_count
        - maximum_tie_count
      additionalProperties: true
    WholeBookExtreme:
      type: object
      properties:
        status:
          type: string
          enum:
            - EXACT
            - BOUND
            - UNAVAILABLE
        currency:
          type: string
        minimum:
          anyOf:
            - $ref: '#/components/schemas/ExactValue'
            - type: 'null'
        maximum:
          anyOf:
            - $ref: '#/components/schemas/ExactValue'
            - type: 'null'
        minimum_witness:
          anyOf:
            - $ref: '#/components/schemas/ScenarioColumn'
            - type: 'null'
        maximum_witness:
          anyOf:
            - $ref: '#/components/schemas/ScenarioColumn'
            - type: 'null'
        reason:
          type: string
      required:
        - status
        - currency
        - minimum
        - maximum
      additionalProperties: true
    ExactValue:
      oneOf:
        - $ref: '#/components/schemas/Decimal'
        - type: object
          properties:
            numerator:
              type: string
              pattern: ^-?(0|[1-9][0-9]*)$
            denominator:
              type: string
              pattern: ^[1-9][0-9]*$
          required:
            - numerator
            - denominator
          additionalProperties: false
      description: >-
        Exact calculation value: finite decimal string, or reduced rational with
        positive denominator. Never round a repeating rational to pretend it is
        exact.
    CoverageItem:
      type: object
      properties:
        input_reference:
          type: string
        outcome_id:
          type: string
          minLength: 1
          description: Rook payout-side ID. YES and NO have separate IDs.
        listing_id:
          type: string
          minLength: 1
          description: >-
            Rook ID for one outcome listing on one venue; preserves venue
            provenance.
        status:
          type: string
          enum:
            - SUPPORTED
            - UNRESOLVED
            - UNSUPPORTED
            - STALE
            - CONFLICTING
        reason_code:
          type: string
        reason:
          type: string
        family_ids:
          type: array
          items:
            type: string
            description: Opaque text identifier. Preserve its exact value.
            minLength: 1
      required:
        - input_reference
        - status
      additionalProperties: true
    RankedOutcome:
      type: object
      properties:
        scenario:
          $ref: '#/components/schemas/ScenarioColumn'
        terminal_payout:
          $ref: '#/components/schemas/ExactValue'
        mark_to_settlement:
          anyOf:
            - $ref: '#/components/schemas/ExactValue'
            - type: 'null'
      required:
        - scenario
        - terminal_payout
      additionalProperties: true
    Contribution:
      type: object
      properties:
        position_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.
        listing_id:
          type: string
          minLength: 1
          description: >-
            Rook ID for one outcome listing on one venue; preserves venue
            provenance.
        values:
          type: array
          items:
            $ref: '#/components/schemas/ExactValue'
      required:
        - position_id
        - outcome_id
        - values
      additionalProperties: true
    OffsetFinding:
      type: object
      properties:
        position_ids:
          type: array
          items:
            type: string
            description: Opaque text identifier. Preserve its exact value.
            minLength: 1
          minItems: 2
        classification:
          type: string
          enum:
            - EXACT
            - PARTIAL
            - CONDITIONAL
            - NONE
        residual_range:
          $ref: '#/components/schemas/ExactValue'
        explanation:
          type: string
        failure_scenarios:
          type: array
          items:
            $ref: '#/components/schemas/ScenarioColumn'
        heuristic_method:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - position_ids
        - classification
        - residual_range
        - explanation
        - failure_scenarios
      additionalProperties: true
      description: >-
        Exact identities and heuristic rankings are labeled separately; no
        independent universe search.
  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.