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

# List the reference-data values trade booking offers instead of free text.

> Returns the holiday calendars, dividend-future codes and interest-rate-swap fixing instruments a contract property may be set to, each pairing the wording a user reads with the exact value import matches on. The two are not interchangeable. A list is empty when reference data covers none. This synchronous operation is read-only.



## OpenAPI

````yaml /risk-and-pricing/atoti-risk-services/apis-endpoints/openapi/openapi.mintlify.json get /api/TradeBooking/ReferenceOptions
openapi: 3.0.4
info:
  title: Derivitec Api 1.0
  version: '1.0'
servers:
  - url: https://api.riskportal.activeviam.com
security:
  - oauth2: []
  - apikey: []
tags:
  - name: AdminUser
  - name: AtotiReport
  - name: AtotiSession
  - name: BloombergOAuth
  - name: Bond
  - name: BondYieldCurvePage
  - name: BookAccess
  - name: Books
  - name: Commodity
  - name: Counterparties
  - name: Currencies
  - name: Equity
  - name: EquityDividend
  - name: EquityPage
  - name: FeatureFlag
  - name: Fx
  - name: FxPage
  - name: GroupAccess
  - name: Home
  - name: LegacyPosition
  - name: MarketData
  - name: MarketDataProvider
  - name: MarketDataProviderAccess
  - name: Meta
  - name: Notification
  - name: Organisation
  - name: PnLReport
  - name: PortfolioAccess
  - name: Portfolios
  - name: Position
  - name: PositionFilter
  - name: PricingEnvironment
  - name: PricingEnvironmentAccess
  - name: RateAsset
  - name: RateAssetPage
  - name: Report
  - name: ReportDefinition
  - name: ReportHistoryLauncherQuery
  - name: ReportLauncher
  - name: ReportQuery
  - name: ReportQueryViewUser
  - name: ReportRestriction
  - name: ReportView
  - name: RiskReport
  - name: Tradable
  - name: TradeBooking
  - name: User
  - name: VarReport
  - name: VarReportQuery
  - name: YieldCurvePage
paths:
  /api/TradeBooking/ReferenceOptions:
    get:
      tags:
        - TradeBooking
      summary: >-
        List the reference-data values trade booking offers instead of free
        text.
      description: >-
        Returns the holiday calendars, dividend-future codes and
        interest-rate-swap fixing instruments a contract property may be set to,
        each pairing the wording a user reads with the exact value import
        matches on. The two are not interchangeable. A list is empty when
        reference data covers none. This synchronous operation is read-only.
      operationId: ReferenceOptions
      responses:
        '200':
          description: >-
            Returns the reference lists with `IsSuccess = true`, or `IsSuccess =
            false` with the reason reference data could not be read.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiGetTradeBookingReferenceOptionsResponse
        '400':
          description: BadRequest
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
        - oauth2: []
        - apikey: []
components:
  schemas:
    ApiGetTradeBookingReferenceOptionsResponse:
      required:
        - $type
      type: object
      properties:
        is_success:
          type: boolean
          description: >-
            Whether the operation completed successfully. The default is `true`;
            error outcomes set it to `false`.
          example: true
        error_messages:
          type: array
          items:
            type: string
          description: >-
            Messages explaining operation-level failures. The collection is
            empty by default.
          nullable: true
        calendars:
          type: array
          items:
            $ref: '#/components/schemas/TradeBookingReferenceOption'
          description: >-
            Holiday calendars available to contracts that adjust dates for
            business days. Empty when

            reference data lists none, or when the request failed.
          nullable: true
        dividend_future_codes:
          type: array
          items:
            $ref: '#/components/schemas/TradeBookingReferenceOption'
          description: >-
            Dividend-future codes available as the underlying of a dividend
            future or option. Empty when

            reference data lists none, or when the request failed.
          nullable: true
        ir_swap_fixing_instrument_ids:
          type: array
          items:
            $ref: '#/components/schemas/TradeBookingReferenceOption'
          description: >-
            Rate assets an interest-rate swap's floating leg can fix against.
            Empty when reference data

            lists none, or when the request failed.
          nullable: true
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.TradeBooking.ApiGetTradeBookingReferenceOptionsResponse,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        The reference-data lists trade booking offers where a contract property
        must match a known

        value, so those properties can be chosen rather than typed.
    TradeBookingReferenceOption:
      required:
        - $type
      type: object
      properties:
        title:
          type: string
          description: How the entry reads to the user.
          nullable: true
          example: London
        value:
          type: string
          description: >-
            The value written to the contract property when this entry is
            chosen. Import matches on this

            exact string, so it is not interchangeable with the title.
          nullable: true
          example: LON
        $type:
          type: string
          enum:
            - >-
              Derivitec.Web.Core.TradeBooking.TradeBookingReferenceOption,
              Derivitec.Web.Core
      additionalProperties: false
      description: >-
        One entry in a reference-data list a booking form offers, pairing what
        the user reads with what

        is stored on the contract.
  securitySchemes:
    oauth2:
      type: oauth2
      description: >-
        OAuth2 access-token requested from AWS Cognito and provided as a Auth
        Bearer header
      flows:
        implicit:
          authorizationUrl: https://auth.riskportal.derivitec.com/oauth2/authorize
          scopes: {}
    apikey:
      type: apiKey
      description: API-Key requested via the site and provided as a header
      name: x-api-key
      in: header

````