Saxo Bank Prices API

Provides end points for polling and subscribing to a stream of potentially tradable prices. Compared to "InfoPrices": * A single price subscription can only return prices for a single valid instrument. * To setup a price subscription, you must supply all information to get a potentially tradable price. You must supply the uic and assettype, along with assettype specific optional parameters, strike and expiry for an option.

OpenAPI Specification

saxo-prices-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Services.AutoTrading Account Values Prices 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: Prices
  description: "Provides end points for polling and subscribing to a stream of potentially tradable prices.\n            Compared to \"InfoPrices\":\n            \n\n*   A single price subscription can only return prices for a single valid instrument.\n*   To setup a price subscription, you must supply all information to get a potentially tradable price. You must supply the uic and assettype, \n            along with assettype specific optional parameters, strike and expiry for an option."
paths:
  /trade/v1/prices/multileg/subscriptions/{ContextId}/{ReferenceId}:
    delete:
      tags:
      - Prices
      summary: Remove a multi-leg price subscription
      description: Removes an multi-leg price subscription for the current session.
      operationId: PricesV1DeleteMultiLegPricesSubscription
      parameters:
      - name: ContextId
        in: path
        description: Unique streaming context ID part of the streaming session.
        required: true
        style: simple
        schema:
          type: string
        example: '20160204125301453'
      - name: ReferenceId
        in: path
        description: Unique reference ID of the subscription.
        required: true
        style: simple
        schema:
          type: string
        example: TP340
      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
  /trade/v1/prices/multileg/subscriptions/{ContextId}:
    delete:
      tags:
      - Prices
      summary: Remove a multi-leg price subscriptions
      description: "Removes a multi-leg price subscriptions for the current session. \n            If the optional tag argument is supplied then only subscriptions with given tag will be removed."
      operationId: PricesV1DeleteMultiLegPricesSubscriptions
      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: '20160204125301453'
      - name: Tag
        in: query
        description: Optional.Tag that subscriptions are marked with.
        style: form
        explode: false
        schema:
          type: string
        example: '2345223'
      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
  /trade/v1/prices/multileg/subscriptions:
    post:
      tags:
      - Prices
      summary: Create a price subscription on a multi-leg strategy
      description: Sets up an active price subscription on a multi-leg strategy and returns an initial snapshot of the most recent price.
      operationId: PricesV1AddMultiLegPricesSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiLegPriceSubscriptionRequest'
            example:
              Arguments:
                AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86
                FieldGroups:
                - MarginImpactBuySell
                Legs:
                - Amount: 10
                  AssetType: CertificateCappedCapitalProtected
                  BuySell: Sell
                  OrderContext: {}
                  ToOpenClose: ToClose
                  Uic: 99
              ContextId: '-'
              Format: stringValue
              ReferenceId: '-'
              RefreshRate: 117
              ReplaceReferenceId: '-'
              Tag: stringValue
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiLegPriceSubscriptionResponse'
              example:
                ContextId: stringValue
                Format: stringValue
                InactivityTimeout: 99
                ReferenceId: stringValue
                RefreshRate: 99
                Snapshot:
                  BuySell: Sell
                  Commissions:
                    CostBuy: 0
                    CostIpoCashSubscription: 0
                    CostIpoSubscription: 0
                    CostSell: 0
                  Greeks:
                    Delta: 1
                    Gamma: 0
                    MidVol: 0
                    Phi: 0
                    Rho: 0
                    Theta: -0.0375
                    Vega: 0
                  InstrumentPriceDetails:
                    AverageVolume: 12345000
                    Barrier: 1
                    ExpiryDate: '2017-06-01'
                    IsMarketOpen: true
                    LowerBarrier: -2
                    MidForwardPrice: 1.71992423552514
                    ShortTradeDisabled: false
                    SpotAsk: 1.71782
                    SpotBid: 1.71692
                    SpotDate: '2017-06-03'
                    SpreadStrikePriceLower: 11
                    SpreadStrikePriceUpper: 12
                    StrikePrice: 1.7175
                    UpperBarrier: 4
                    ValueDate: '2017-06-05'
                  LastUpdated: '9999-12-31T23:59:59.999999Z'
                  Legs:
                  - Amount: 10
                    AssetType: CertificateCappedOutperformance
                    BuySell: Buy
                    Greeks:
                      Delta: 1
                      Gamma: 0
                      MidVol: 0
                      Phi: 0
                      Rho: 0
                      Theta: -0.0375
                      Vega: 0
                    InstrumentPriceDetails:
                      AverageVolume: 12345000
                      Barrier: 1
                      ExpiryDate: '2017-06-01'
                      IsMarketOpen: true
                      LowerBarrier: -2
                      MidForwardPrice: 1.71992423552514
                      ShortTradeDisabled: false
                      SpotAsk: 1.71782
                      SpotBid: 1.71692
                      SpotDate: '2017-06-03'
                      SpreadStrikePriceLower: 11
                      SpreadStrikePriceUpper: 12
                      StrikePrice: 1.7175
                      UpperBarrier: 4
                      ValueDate: '2017-06-05'
                    LegId: stringValue
                    Quote:
                      Amount: 100000
                      Ask: 1.0899
                      Bid: 1.0897
                      DelayedByMinutes: 15
                      ErrorCode: None
                      Mid: 1.0898
                      PriceTypeAsk: Indicative
                      PriceTypeBid: Indicative
                    ToOpenClose: ToOpen
                    Uic: 99
                  MarginImpactBuySell:
                    Currency: USD
                    InitialMarginAvailableBuy: 10447
                    InitialMarginAvailableCurrent: 10470
                    InitialMarginBuy: 12
                    MaintenanceMarginBuy: 11
                  MarketState: Open
                  PriceSource: stringValue
                  Quote:
                    Amount: 100000
                    Ask: 1.0899
                    Bid: 1.0897
                    DelayedByMinutes: 15
                    ErrorCode: None
                    Mid: 1.0898
                    PriceTypeAsk: Indicative
                    PriceTypeBid: Indicative
                  StrategyType: Condor
                State: Active
                Tag: stringValue
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InstrumentNotAllowed
                    - 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.
                      InstrumentNotAllowed: The account is not allowed to trade in or receive prices for the specified [AssetType]
                  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/MultiLegPriceResponseDomainEvent'
  /trade/v1/prices/multileg:
    post:
      tags:
      - Prices
      summary: Get a price snapshot for a multi-leg strategy
      description: Gets a single price snapshot for a multi-leg strategy using the specified parameters.
      operationId: PricesV1GetMultiLegPriceAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiLegPriceRequest'
            example:
              AccountKey: 01b64edf-da03-4145-bf33-ae21527d4c86
              FieldGroups:
              - Quote
              Legs:
              - Amount: 10
                AssetType: Warrant
                BuySell: Sell
                OrderContext: {}
                ToOpenClose: Undefined
                Uic: 99
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MultiLegPriceResponse'
              example:
                BuySell: Sell
                Commissions:
                  CostBuy: 0
                  CostIpoCashSubscription: 0
                  CostIpoSubscription: 0
                  CostSell: 0
                Greeks:
                  Delta: 1
                  Gamma: 0
                  MidVol: 0
                  Phi: 0
                  Rho: 0
                  Theta: -0.0375
                  Vega: 0
                InstrumentPriceDetails:
                  AverageVolume: 12345000
                  Barrier: 1
                  ExpiryDate: '2017-06-01'
                  IsMarketOpen: true
                  LowerBarrier: -2
                  MidForwardPrice: 1.71992423552514
                  ShortTradeDisabled: false
                  SpotAsk: 1.71782
                  SpotBid: 1.71692
                  SpotDate: '2017-06-03'
                  SpreadStrikePriceLower: 11
                  SpreadStrikePriceUpper: 12
                  StrikePrice: 1.7175
                  UpperBarrier: 4
                  ValueDate: '2017-06-05'
                LastUpdated: '9999-12-31T23:59:59.999999Z'
                Legs:
                - Amount: 10
                  AssetType: WarrantKnockOut
                  BuySell: Buy
                  Greeks:
                    Delta: 1
                    Gamma: 0
                    MidVol: 0
                    Phi: 0
                    Rho: 0
                    Theta: -0.0375
                    Vega: 0
                  InstrumentPriceDetails:
                    AverageVolume: 12345000
                    Barrier: 1
                    ExpiryDate: '2017-06-01'
                    IsMarketOpen: true
                    LowerBarrier: -2
                    MidForwardPrice: 1.71992423552514
                    ShortTradeDisabled: false
                    SpotAsk: 1.71782
                    SpotBid: 1.71692
                    SpotDate: '2017-06-03'
                    SpreadStrikePriceLower: 11
                    SpreadStrikePriceUpper: 12
                    StrikePrice: 1.7175
                    UpperBarrier: 4
                    ValueDate: '2017-06-05'
                  LegId: stringValue
                  Quote:
                    Amount: 100000
                    Ask: 1.0899
                    Bid: 1.0897
                    DelayedByMinutes: 15
                    ErrorCode: None
                    Mid: 1.0898
                    PriceTypeAsk: Indicative
                    PriceTypeBid: Indicative
                  ToOpenClose: ToOpen
                  Uic: 99
                MarginImpactBuySell:
                  Currency: USD
                  InitialMarginAvailableBuy: 10447
                  InitialMarginAvailableCurrent: 10470
                  InitialMarginBuy: 12
                  MaintenanceMarginBuy: 11
                MarketState: TradingAtLast
                PriceSource: stringValue
                Quote:
                  Amount: 100000
                  Ask: 1.0899
                  Bid: 1.0897
                  DelayedByMinutes: 15
                  ErrorCode: None
                  Mid: 1.0898
                  PriceTypeAsk: Indicative
                  PriceTypeBid: Indicative
                StrategyType: BackRatio
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InstrumentNotAllowed
                    - InstrumentTypeNotSupportedException
                    - InvalidPriceRequest
                    - InvalidUic
                    - Unknown
                    type: string
                    example: None
                    x-enum-descriptions:
                      Unknown: One or more of the provided parameters are invalid.
                      InstrumentNotAllowed: The account is not allowed to trade in or receive prices for the specified [AssetType]
                      InstrumentTypeNotSupportedException: Unsupported instrument type.
                      InvalidUic: UIC is either invalid or not specified at all.
                      InvalidPriceRequest: Invalid price request.
                  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'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Read
  /trade/v1/prices/subscriptions/{ContextId}:
    delete:
      tags:
      - Prices
      summary: Remove multiple instrument price subscriptions
      description: "Removes multiple instrument price subscriptions for the current session. \n            If the optional tag argument is supplied then only subscriptions with given tag will be removed."
      operationId: PricesV1DeleteSubscriptions
      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: '20160204125301453'
      - name: Tag
        in: query
        description: Optional.Tag that subscriptions are marked with.
        style: form
        explode: false
        schema:
          type: string
        example: '2345223'
      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
  /trade/v1/prices/subscriptions/{ContextId}/{ReferenceId}/MarginImpact:
    put:
      tags:
      - Prices
      summary: Request margin impact on one price update
      description: 'Request margin impact to come on one of the next following price updates.



        This will make a margin impact calculation, and send the result in the next possible price update, however only one impact calculation will be done per call.'
      operationId: PricesV1RequestMarginImpactOnSubscription
      parameters:
      - name: ContextId
        in: path
        description: Context for the streaming connection.
        required: true
        style: simple
        schema:
          type: string
        example: '20160204125301453'
      - name: ReferenceId
        in: path
        description: Unique id of the subscription.
        required: true
        style: simple
        schema:
          type: string
        example: TP340
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - RequestMarginImpactOnNextPriceFailed
                    type: string
                    example: None
                    x-enum-descriptions:
                      RequestMarginImpactOnNextPriceFailed: Price subscription cannot add margin impact.
                  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/PriceResponseDomainEvent'
  /trade/v1/prices/subscriptions/{ContextId}/{ReferenceId}:
    delete:
      tags:
      - Prices
      summary: Remove an instrument price subscription
      description: Removes an instrument price subscription for the current session.
      operationId: PricesV1DeleteSubscription
      parameters:
      - name: ContextId
        in: path
        description: Unique streaming context ID part of the streaming session.
        required: true
        style: simple
        schema:
          type: string
        example: '20160204125301453'
      - name: ReferenceId
        in: path
        description: Unique reference ID of the subscription.
        required: true
        style: simple
        schema:
          type: string
        example: TP340
      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
  /trade/v1/prices/subscriptions:
    post:
      tags:
      - Prices
      summary: Create a price subscription on an instrument
      description: Sets up an active price subscription on an instrument and returns an initial snapshot of the most recent price.
      operationId: PricesV1AddSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PriceSubscriptionRequest'
            example:
              Arguments:
                AccountKey: LZTc7DdejXODf-WSl2aCyQ==
                Amount: 100000
                AssetType: FxVanillaOption
                ExpiryDate: '2017-06-01T00:00:00Z'
                FieldGroups:
                - DisplayAndFormat
                - HistoricalChanges
                - InstrumentPriceDetails
                - Quote
                PutCall: Call
                Uic: 22
              ContextId: '20221030063404744'
              Format: application/json
              ReferenceId: IP72733
              RefreshRate: 1000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PriceSubscriptionResponse'
              example:
                ContextId: '20221030063404744'
                Format: application/json
                InactivityTimeout: 30
                ReferenceId: IP72733
                RefreshRate: 1000
                Snapshot:
                  AssetType: FxSpot
                  DisplayAndFormat:
                    Currency: AUD
                    Decimals: 4
                    Description: British Pound/Australian Dollar
                    Format: AllowDecimalPips
                    StrikeDecimals: 4
                    StrikeFormat: Normal
                    Symbol: GBPAUD
                  HistoricalChanges:
                    PercentChange1Month: 5.57
                    PercentChange2Months: 5.83
                    PercentChange3Months: 3.73
                    PercentChange6Months: 6.49
                    PercentChangeDaily: 0.2
                    PercentChangeWeekly: 0.88
                  InstrumentPriceDetails:
                    AverageVolume: 12345000
                    Barrier: 1
                    ExpiryDate: '2017-06-01'
                    IsMarketOpen: true
                    LowerBarrier: -2
                    MidForwardPrice: 1.71992423552514
                    ShortTradeDisabled: false
                    SpotAsk: 1.71782
                    SpotBid: 1.71692
                    SpotDate: '2017-06-03'
                    SpreadStrikePriceLower: 11
                    SpreadStrikePriceUpper: 12
                    StrikePrice: 1.7175
                    UpperBarrier: 4
                    ValueDate: '2017-06-05'
                  LastUpdated: '2017-05-01T00:00:00Z'
                  Quote:
                    Amount: 100000
                    Ask: 0.02257
                    Bid: 0.01962
                    DelayedByMinutes: 15
                    ErrorCode: None
                    Mid: 0.0210958157864443
                    PriceTypeAsk: Indicative
                    PriceTypeBid: Indicative
                    RFQState: None
                  Uic: 22
                State: Active
                Tag: PAGE1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InstrumentNotAllowed
                    - 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.
                      InstrumentNotAllowed: The account is not allowed to trade in or receive prices for the specified [AssetType]
                  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/PriceResponseDomainEvent'
  /trade/v1/prices/subscriptions/active:
    post:
      tags:
      - Prices
      summary: OBSOLETE Create an active price subscription on an instrument
      description: Sets up an active price subscription on an instrument and returns an initial snapshot of the most recent price.
      operationId: PricesV1AddActiveSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PriceSubscriptionRequest'
            example:
              Arguments:
                AccountKey: LZTc7DdejXODf-WSl2aCyQ==
                Amount: 100000
                AssetType: FxVanillaOption
                ExpiryDate: '2017-06-01T00:00:00Z'
                FieldGroups:
                - DisplayAndFormat
                - HistoricalChanges
                - InstrumentPriceDetails
                - Quote
                PutCall: Call
                Uic: 22
              ContextId: '20221030063404744'
              Format: application/json
              ReferenceId: IP72733
              RefreshRate: 1000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PriceSubscriptionResponse'
              example:
                ContextId: '20221030063404744'
                Format: application/json
                InactivityTimeout: 30
                ReferenceId: IP72733
                RefreshRate: 1000
                Snapshot:
                  AssetType: FxSpot
                  DisplayAndFormat:
                    Currency: AUD
                    Decimals: 4
                    Description: British Pound/Australian Dollar
                    Format: AllowDecimalPips
                    StrikeDecimals: 4
                    StrikeFormat: Normal
                    Symbol: GBPAUD
                  HistoricalChanges:
                    PercentChange1Month: 5.57
                    PercentChange2Months: 5.83
                    PercentChange3Months: 3.73
                    PercentChange6Months: 6.49
                    PercentChangeDaily: 0.2
                    PercentChangeWeekly: 0.88
                  InstrumentPriceDetails:
                    AverageVolume: 12345000
  

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