Saxo Bank

Saxo Bank Options Chain API

The Options Chain is a construct made specifically for displaying a number of options (ETOs or FxOptions) in a classic "Options Board" that orders the options according to Expiries and Strikes. It is made with the common UI needs of such a board in mind. The service provides endpoints for subscribing to a stream of (limited) price-data for a number of options (FX or ETO) and managing such subscriptions to provide e.g. scrolling.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.developer.saxo/openapi/learn
📖
Authentication
https://www.developer.saxo/openapi/learn/oauth-authorization-code
📖
RateLimits
https://www.developer.saxo/openapi/learn/rate-limiting
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/saxo/refs/heads/main/rate-limits/rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/saxo/refs/heads/main/openapi/saxo-options-chain-api-openapi.yml

Other Resources

🔗
ReferenceDocumentation
https://www.developer.saxo/openapi/referencedocs
🔗
OpenAPIExplorer
https://www.developer.saxo/openapi/explorer
🔗
ErrorCodes
https://developer.saxobank.com/openapi/learn/status-codes
🔗
Tutorial
https://www.developer.saxo/openapi/learn/the-tutorial
🔗
SupportCenter
https://openapi.help.saxo/hc/en-us
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/saxo/refs/heads/main/plans/plans.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/saxo/refs/heads/main/finops/finops.yml

OpenAPI Specification

saxo-options-chain-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Services.AutoTrading Account Values Options Chain API
  description: 'The AutoTrading service group provides endpoints for interacting with Saxo Bank''s SaxoSelect offering.Through these interfaces a client application can get Saxo Select trade leaders, portfolios and investments. Portfolio investments can be created and modifed.<div class=well style=''border: 1px solid rgb(204, 82, 0); border-image: none; background-color: rgb(255, 209, 179);padding:1px;''><strong> Note:</strong> </br>This service is subject to special licensing agreements and not generally available to all OpenAPI applications.</div>'
  version: 2.4.138+710c760591
  x-framework-version: 38.0.2+439c5b0ec3
  x-machine: SIMOAWEB11-DK2
servers:
- url: https://gateway.saxobank.com/sim/openapi
tags:
- name: Options Chain
  description: "The Options Chain is a construct made specifically for displaying a number of options (ETOs or FxOptions) in a classic \"Options Board\" that orders the options according to\n            Expiries and Strikes. It is made with the common UI needs of such a board in mind.\n            \n            The service provides endpoints for subscribing to a stream of (limited) price-data for a number of options (FX or ETO) and managing such subscriptions to provide e.g. scrolling."
paths:
  /trade/v1/optionschain/subscriptions/{ContextId}/{ReferenceId}/ResetATM:
    put:
      tags:
      - Options Chain
      summary: Reset an options chain subscription "At The Money"
      description: "Resets subscription for the current session identified by contextId and referenceId, to show strikes \"at the money\" for \n            all the previously configured expiries. This method will not change the number of strikes, or which expires are subscribed to."
      operationId: OptionsChainsV1ResetSubscriptionAtTheMoney
      parameters:
      - name: ContextId
        in: path
        description: The context id part of the streaming session (used to identify the subscription within a streaming session).
        required: true
        style: simple
        schema:
          type: string
        example: '29931122'
      - name: ReferenceId
        in: path
        description: Unique id of the subscription
        required: true
        style: simple
        schema:
          type: string
        example: 0f8fad5b-d9cb-469f-a165-70867728950e
      responses:
        '204':
          description: No Content
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
  /trade/v1/optionschain/subscriptions/{ContextId}/{ReferenceId}:
    delete:
      tags:
      - Options Chain
      summary: Remove an options chain subscription
      description: Removes subscription for the current session identified by contextId and referenceId.
      operationId: OptionsChainsV1DeleteSubscription
      parameters:
      - name: ContextId
        in: path
        description: The context id part of the streaming session (used to identify the subscription within a streaming session).
        required: true
        style: simple
        schema:
          type: string
        example: '29931122'
      - name: ReferenceId
        in: path
        description: Unique id of the subscription
        required: true
        style: simple
        schema:
          type: string
        example: 0f8fad5b-d9cb-469f-a165-70867728950e
      responses:
        '204':
          description: No Content
        '202':
          description: Subscription delete request will be processed eventually.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
    patch:
      tags:
      - Options Chain
      summary: Modify an existing options chain subscription. This replaces the obsolete version subscriptions/active/{contextId}/{referenceId}
      description: "Modifies an existing subscription. This is used for scrolling the options board, by providing either another set of expiries, \n            or specifying another set of strikes to subscribe to. \n            For changing to another instrument, it is recommended to create a new subscription and discard the old."
      operationId: OptionsChainsV1ModifySubscription
      parameters:
      - name: ContextId
        in: path
        required: true
        style: simple
        schema:
          type: string
      - name: ReferenceId
        in: path
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyOptionsChainSubscriptionRequest'
            example:
              Expiries:
              - Index: 99
                StrikeStartIndex: 99
              MaxStrikesPerExpiry: 99
      responses:
        '204':
          description: No Content
        '404':
          description: ''
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidRequest
                    type: string
                    example: None
                    x-enum-descriptions:
                      InvalidRequest: Invalid request.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
  /trade/v1/optionschain/subscriptions/active/{ContextId}/{ReferenceId}:
    patch:
      tags:
      - Options Chain
      summary: OBSOLETE Modify an existing options chain subscription. This endpoint is obsolete. Use subscriptions/{contextId}/{referenceId}.
      description: "Modifies an existing subscription. This is used for scrolling the options board, by providing either another set of expiries, \n            or specifying another set of strikes to subscribe to. \n            For changing to another instrument, it is recommended to create a new subscription and discard the old."
      operationId: OptionsChainsV1ModifyActiveSubscription
      parameters:
      - name: ContextId
        in: path
        required: true
        style: simple
        schema:
          type: string
      - name: ReferenceId
        in: path
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyOptionsChainSubscriptionRequest'
            example:
              Expiries:
              - Index: 99
                StrikeStartIndex: 99
              MaxStrikesPerExpiry: 99
      responses:
        '204':
          description: No Content
        '404':
          description: ''
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidRequest
                    type: string
                    example: None
                    x-enum-descriptions:
                      InvalidRequest: Invalid request.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: true
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
  /trade/v1/optionschain/subscriptions:
    post:
      tags:
      - Options Chain
      summary: Create an active options chain subscription
      description: Sets up a subscription and returns an initial snapshot of the options chain specified by the parameters in the request.
      operationId: OptionsChainsV1AddSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptionsChainSubscriptionRequest'
            example:
              Arguments:
                AccountKey: LZTc7DdejXODf-WSl2aCyQ==
                AssetType: StockIndexOption
                Expiries:
                - Index: 1
                  StrikeStartIndex: 0
                Identifier: 18
                MaxStrikesPerExpiry: 3
              ContextId: '20221030063404760'
              ReferenceId: C0142897
              RefreshRate: 1000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsChainSubscriptionResponse'
              example:
                ContextId: '20221030063404760'
                InactivityTimeout: 60
                ReferenceId: C0142897
                RefreshRate: 1000
                Snapshot:
                  AssetType: StockIndexOption
                  Expiries:
                  - DisplayDate: '0001-01-01'
                    DisplayDaysToExpiry: 30
                    Expiry: '2017-05-31T11:10:00Z'
                    Index: 0
                    LastTradeDate: '0201-05-31T21:00:00Z'
                    MidStrikePrice: 0
                    StrikeCount: 50
                    Strikes:
                    - Index: 0
                      Strike: 97.25
                    - Index: 1
                      Strike: 97.375
                    - Index: 2
                      Strike: 97.5
                    - Index: 3
                      Strike: 97.625
                    - Index: 4
                      Strike: 97.75
                    - Index: 5
                      Strike: 97.8125
                    - Index: 6
                      Strike: 97.875
                    - Index: 7
                      Strike: 97.9375
                    - Index: 8
                      Strike: 98
                    - Index: 9
                      Strike: 98.0625
                    - Index: 10
                      Strike: 98.125
                    - Index: 11
                      Strike: 98.1875
                    - Index: 12
                      Strike: 98.25
                    - Index: 13
                      Strike: 98.3125
                    - Index: 14
                      Strike: 98.375
                    - Index: 15
                      Strike: 98.4375
                    - Index: 16
                      Strike: 98.5
                    - Index: 17
                      Strike: 98.5625
                    - Index: 18
                      Strike: 98.625
                    - Index: 19
                      Strike: 98.6875
                    - Index: 20
                      Strike: 98.75
                    - Index: 21
                      Strike: 98.8125
                    - Index: 22
                      Strike: 98.875
                    - Index: 23
                      Strike: 98.9375
                    - Call:
                        High: 0
                        LastClose: 0.095
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.095
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485090
                        Volume: 0
                      Index: 24
                      Put:
                        High: 0
                        LastClose: 0
                        LastTraded: 0
                        Low: 0
                        NetChange: 0
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485130
                        Volume: 0
                      Strike: 99
                    - Call:
                        High: 0
                        LastClose: 0.035
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.035
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485091
                        Volume: 0
                      Index: 25
                      Put:
                        High: 0
                        LastClose: 0.0025
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.0025
                        Open: 0
                        OpenInterest: 250
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485131
                        Volume: 0
                      Strike: 99.0625
                    - Call:
                        High: 0
                        LastClose: 0.0025
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.0025
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485092
                        Volume: 0
                      Index: 26
                      Put:
                        High: 0
                        LastClose: 0.0325
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.0325
                        Open: 0
                        OpenInterest: 250
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485132
                        Volume: 0
                      Strike: 99.125
                    - Index: 27
                      Strike: 99.1875
                    - Index: 28
                      Strike: 99.25
                    - Index: 29
                      Strike: 99.3125
                    - Index: 30
                      Strike: 99.375
                    - Index: 31
                      Strike: 99.4375
                    - Index: 32
                      Strike: 99.5
                    - Index: 33
                      Strike: 99.5625
                    - Index: 34
                      Strike: 99.625
                    - Index: 35
                      Strike: 99.6875
                    - Index: 36
                      Strike: 99.75
                    - Index: 37
                      Strike: 99.8125
                    - Index: 38
                      Strike: 99.875
                    - Index: 39
                      Strike: 99.9375
                    - Index: 40
                      Strike: 100
                    - Index: 41
                      Strike: 100.0625
                    - Index: 42
                      Strike: 100.125
                    - Index: 43
                      Strike: 100.1875
                    - Index: 44
                      Strike: 100.25
                    - Index: 45
                      Strike: 100.375
                    - Index: 46
                      Strike: 100.5
                    - Index: 47
                      Strike: 100.625
                    - Index: 48
                      Strike: 100.75
                    - Index: 49
                      Strike: 100.875
                    StrikeWindowStartIndex: 24
                    UnderlyingUic: 2456777
                  ExpiryCount: 0
                  LastUpdated: '0001-01-01T00:00:00Z'
                State: Active
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidModelState
                    - InvalidRequest
                    - UnsupportedSubscriptionFormat
                    type: string
                    example: None
                    x-enum-descriptions:
                      InvalidRequest: Invalid request.
                      InvalidModelState: Error code returned when model state is invalid.
                      UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - IllegalInstrumentId
                    type: string
                    example: None
                    x-enum-descriptions:
                      IllegalInstrumentId: Unknown instrument name
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - SubscriptionLimitExceeded
                    type: string
                    example: None
                    x-enum-descriptions:
                      SubscriptionLimitExceeded: Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
      x-streaming-type:
        $ref: '#/components/schemas/OptionsChainResponseDomainEvent'
  /trade/v1/optionschain/subscriptions/active:
    post:
      tags:
      - Options Chain
      summary: OBSOLETE Create an active options chain subscription
      description: Sets up a subscription and returns an initial snapshot of the options chain specified by the parameters in the request.
      operationId: OptionsChainsV1AddActiveSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OptionsChainSubscriptionRequest'
            example:
              Arguments:
                AccountKey: LZTc7DdejXODf-WSl2aCyQ==
                AssetType: StockIndexOption
                Expiries:
                - Index: 1
                  StrikeStartIndex: 0
                Identifier: 18
                MaxStrikesPerExpiry: 3
              ContextId: '20221030063404760'
              ReferenceId: C0142897
              RefreshRate: 1000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OptionsChainSubscriptionResponse'
              example:
                ContextId: '20221030063404760'
                InactivityTimeout: 60
                ReferenceId: C0142897
                RefreshRate: 1000
                Snapshot:
                  AssetType: StockIndexOption
                  Expiries:
                  - DisplayDate: '0001-01-01'
                    DisplayDaysToExpiry: 30
                    Expiry: '2017-05-31T11:10:00Z'
                    Index: 0
                    LastTradeDate: '0201-05-31T21:00:00Z'
                    MidStrikePrice: 0
                    StrikeCount: 50
                    Strikes:
                    - Index: 0
                      Strike: 97.25
                    - Index: 1
                      Strike: 97.375
                    - Index: 2
                      Strike: 97.5
                    - Index: 3
                      Strike: 97.625
                    - Index: 4
                      Strike: 97.75
                    - Index: 5
                      Strike: 97.8125
                    - Index: 6
                      Strike: 97.875
                    - Index: 7
                      Strike: 97.9375
                    - Index: 8
                      Strike: 98
                    - Index: 9
                      Strike: 98.0625
                    - Index: 10
                      Strike: 98.125
                    - Index: 11
                      Strike: 98.1875
                    - Index: 12
                      Strike: 98.25
                    - Index: 13
                      Strike: 98.3125
                    - Index: 14
                      Strike: 98.375
                    - Index: 15
                      Strike: 98.4375
                    - Index: 16
                      Strike: 98.5
                    - Index: 17
                      Strike: 98.5625
                    - Index: 18
                      Strike: 98.625
                    - Index: 19
                      Strike: 98.6875
                    - Index: 20
                      Strike: 98.75
                    - Index: 21
                      Strike: 98.8125
                    - Index: 22
                      Strike: 98.875
                    - Index: 23
                      Strike: 98.9375
                    - Call:
                        High: 0
                        LastClose: 0.095
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.095
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485090
                        Volume: 0
                      Index: 24
                      Put:
                        High: 0
                        LastClose: 0
                        LastTraded: 0
                        Low: 0
                        NetChange: 0
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485130
                        Volume: 0
                      Strike: 99
                    - Call:
                        High: 0
                        LastClose: 0.035
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.035
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485091
                        Volume: 0
                      Index: 25
                      Put:
                        High: 0
                        LastClose: 0.0025
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.0025
                        Open: 0
                        OpenInterest: 250
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485131
                        Volume: 0
                      Strike: 99.0625
                    - Call:
                        High: 0
                        LastClose: 0.0025
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.0025
                        Open: 0
                        OpenInterest: 0
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485092
                        Volume: 0
                      Index: 26
                      Put:
                        High: 0
                        LastClose: 0.0325
                        LastTraded: 0
                        Low: 0
                        NetChange: -0.0325
                        Open: 0
                        OpenInterest: 250
                        PriceTypeAsk: NoMarket
                        PriceTypeBid: NoMarket
                        Uic: 2485132
                        Volume: 0
                      Strike: 99.125
                    - Index: 27
                      Strike: 99.1875
                    - Index: 28
                      Strike: 99.25
                    - Index: 29
                      Strike: 99.3125
                    - Index: 30
                      Strike: 99.375
                    - Index: 31
                      Strike: 99.4375
                    - Index: 32
                      Strike: 99.5
                    - Index: 33
                      Strike: 99.5625
                    - Index: 34
                      Strike: 99.625
                    - Index: 35
                      Strike: 99.6875
                    - Index: 36
                      Strike: 99.75
                    - Index: 37
                      Strike: 99.8125
                    - Index: 38
                      Strike: 99.875
                    - Index: 39
                      Strike: 99.9375
                    - Index: 40
                      Strike: 100
                    - Index: 41
                      Strike: 100.0625
                    - Index: 42
                      Strike: 100.125
                    - Index: 43
                      Strike: 100.1875
                    - Index: 44
                      Strike: 100.25
                    - Index: 45
                      Strike: 100.375
                    - Index: 46
                      Strike: 100.5
                    - Index: 47
                      Strike: 100.625
                    - Index: 48
                      Strike: 100.75
                    - Index: 49
                      Strike: 100.875
                    StrikeWindowStartIndex: 24
                    UnderlyingUic: 2456777
                  ExpiryCount: 0
                  LastUpdated: '0001-01-01T00:00:00Z'
                State: Active
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidModelState
                    - InvalidRequest
                    - UnsupportedSubscriptionFormat
                    type: string
                    example: None
                    x-enum-descriptions:
                      InvalidRequest: Invalid request.
                      InvalidModelState: Error code returned when model state is invalid.
                      UnsupportedSubscriptionFormat: Error code returned when a subscription format that isn't supported by the publisher is requested.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - IllegalInstrumentId
                    type: string
                    example: None
                    x-enum-descriptions:
                      IllegalInstrumentId: Unknown instrument name
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - SubscriptionLimitExceeded
                    type: string
                    example: None
                    x-enum-descriptions:
                      SubscriptionLimitExceeded: Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      deprecated: true
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
      x-streaming-type:
        $ref: '#/components/schemas/OptionsChainResponseDomainEvent'
components:
  schemas:
    OptionsChainSubscriptionRequest:
      title: Type used for requesting options chain subscriptions.
      required:
      - Arguments
      - ContextId
      - ReferenceId
      type: object
      properties:
        ContextId:
          title: "The streaming context id that this request is associated with.\n            This parameter must only contain letters (a-z) and numbers (0-9) as well as - (dash) and _ (underscore). It is case insensitive. Max length is 50 characters."
          pattern: ^[a-zA-Z0-9_-]{1,50}$
          type: string
          example: ContextId-1
          x-display-order: 1
        ReferenceId:
          title: "Mandatory client specified reference id for the subscription.\n            This parameter must only contain alphanumberic characters as well as - (dash) and _ (underscore). Cannot start with _. It is case insensitive. Max length is 50 characters."
          pattern: ^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$
          type: string
          example: ReferenceId-1
          x-display-order: 2
        Arguments:
          title: Arguments for the subscription request.
          allOf:
          - $ref: '#/components/schemas/OptionsChainRequest'
        Format:
          title: "Optional Media type (RFC 2046) of the serialized data updates that are streamed to the client.\n            Currently only application/json and application/x-protobuf is supported.\n            If an unrecognized format is specified, the subscription end point will return HTTP status code 400 - Bad format."
          type: string
          example: application/json
        RefreshRate:
        

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/saxo/refs/heads/main/openapi/saxo-options-chain-api-openapi.yml