openapi: 3.0.1
info:
  title: Services.AutoTrading Account Values Info 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: Info Prices
  description: "Provides end points for polling and subscribing to Info prices. Info prices are primarily intended to serve application scenarios, where the user is anonymous, or where an application\n            wants to setup a pricelist/watchlist, but does not need the ability to let the user trade directly on the price shown.\n            Compared to \"Prices\":\n            \n\n*   An InfoPrice is not tradable.\n*   An InfoPrice contains fewer field groups.\n*   A single Infoprice subscription can return a list of InfoPrices for different instruments.\n*   To setup an Infoprice subscription, you must supply much less information. Where possible, appropriate default values will be assumed."
paths:
  /trade/v1/infoprices/subscriptions/{ContextId}/{ReferenceId}:
    delete:
      tags:
      - Info Prices
      summary: Remove info price subscription on an instrument
      description: Removes an info price subscription on a single instrument.
      operationId: InfoPricesV1DeleteSubscription
      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: ReferenceId
        in: path
        description: Unique reference ID of the subscription to remove.
        required: true
        style: simple
        schema:
          type: string
        example: IP24
      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
        community: Subscribe
  /trade/v1/infoprices/subscriptions/{ContextId}:
    delete:
      tags:
      - Info Prices
      summary: Remove info price subscriptions on instruments
      description: Removes info price subscriptions on one or more instruments for the current session.
      operationId: InfoPricesV1DeleteSubscriptions
      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: Tag
        in: query
        description: Tag that subscriptions are marked with
        style: form
        explode: false
        schema:
          type: string
        example: IP
      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
        community: Subscribe
  /trade/v1/infoprices/subscriptions:
    post:
      tags:
      - Info Prices
      summary: Create an active info price subscription on an list of instruments
      description: Sets up a subscription and returns an initial snapshot of an info  price list specified by the parameters in the request.
      operationId: InfoPricesV1AddSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InfoPriceListSubscriptionRequest'
            example:
              Arguments:
                AccountKey: LZTc7DdejXODf-WSl2aCyQ==
                AssetType: FxSpot
                FieldGroups:
                - DisplayAndFormat
                - HistoricalChanges
                - InstrumentPriceDetails
                - PriceInfo
                - PriceInfoDetails
                - Quote
                Uics: 22,23
              ContextId: '20221030063404713'
              ReferenceId: IP89383
              RefreshRate: 1000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoPriceListSubscriptionResponse'
              example:
                ContextId: '20221030063404713'
                Format: application/json
                InactivityTimeout: 60
                ReferenceId: IP89383
                RefreshRate: 1000
                Snapshot:
                  Data:
                  - AssetType: FxSpot
                    DisplayAndFormat:
                      Currency: AUD
                      Decimals: 4
                      Description: British Pound/Australian Dollar
                      Format: AllowDecimalPips
                      OrderDecimals: 4
                      Symbol: GBPAUD
                    HistoricalChanges:
                      PercentChange1Month: 1.21
                      PercentChange2Months: 2.95
                      PercentChange3Months: 1.85
                      PercentChange6Months: -1.83
                      PercentChangeDaily: 0.22
                      PercentChangeWeekly: 1.67
                    InstrumentPriceDetails:
                      IsMarketOpen: true
                      ShortTradeDisabled: false
                      ValueDate: '2017-05-19'
                    LastUpdated: '0001-01-01T00:00:00Z'
                    PriceInfo:
                      High: 1.09117
                      Low: 1.08853
                      NetChange: 0.00048
                      PercentChange: 0.04
                    PriceInfoDetails:
                      AskSize: 1000000
                      BidSize: 1000000
                      LastClose: 1.08932
                      LastTraded: 0
                      LastTradedSize: 0
                      Open: 0
                      Volume: 0
                    Quote:
                      Amount: 100000
                      Ask: 1.74948
                      Bid: 1.74858
                      DelayedByMinutes: 15
                      ErrorCode: None
                      Mid: 1.74903
                      PriceTypeAsk: Indicative
                      PriceTypeBid: Indicative
                    Uic: 22
                  - AssetType: FxSpot
                    DisplayAndFormat:
                      Currency: CAD
                      Decimals: 4
                      Description: British Pound/Canadian Dollar
                      Format: AllowDecimalPips
                      OrderDecimals: 4
                      Symbol: GBPCAD
                    InstrumentPriceDetails:
                      IsMarketOpen: true
                      ShortTradeDisabled: false
                      ValueDate: '2017-05-19'
                    LastUpdated: '0001-01-01T00:00:00Z'
                    Quote:
                      Amount: 100000
                      Ask: 1.76278
                      Bid: 1.76198
                      DelayedByMinutes: 15
                      ErrorCode: None
                      Mid: 1.76238
                      PriceTypeAsk: Indicative
                      PriceTypeBid: Indicative
                    Uic: 23
                State: Active
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InstrumentNotAllowed
                    - InstrumentTypeNotSupportedException
                    - InvalidModelState
                    - InvalidRequest
                    - InvalidUic
                    - UicsInListNotUnique
                    - Unknown
                    - 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.
                      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.
                      UicsInListNotUnique: The UICs in the list must be unique.
                  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:
        restricted: Subscribe
      x-streaming-type:
        $ref: '#/components/schemas/InfoPriceResponseArrayDomainEvent'
  /trade/v1/infoprices/subscriptions/active:
    post:
      tags:
      - Info Prices
      summary: OBSOLETE Create an active info price subscription on an list of instruments
      description: Sets up a subscription and returns an initial info price snapshot for a list of instruments, specified by the parameters in the request.
      operationId: InfoPricesV1AddActiveSubscriptionAsync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InfoPriceListSubscriptionRequest'
            example:
              Arguments:
                AccountKey: LZTc7DdejXODf-WSl2aCyQ==
                AssetType: FxSpot
                FieldGroups:
                - DisplayAndFormat
                - HistoricalChanges
                - InstrumentPriceDetails
                - PriceInfo
                - PriceInfoDetails
                - Quote
                Uics: 22,23
              ContextId: '20221030063404713'
              ReferenceId: IP89383
              RefreshRate: 1000
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoPriceListSubscriptionResponse'
              example:
                ContextId: '20221030063404713'
                Format: application/json
                InactivityTimeout: 60
                ReferenceId: IP89383
                RefreshRate: 1000
                Snapshot:
                  Data:
                  - AssetType: FxSpot
                    DisplayAndFormat:
                      Currency: AUD
                      Decimals: 4
                      Description: British Pound/Australian Dollar
                      Format: AllowDecimalPips
                      OrderDecimals: 4
                      Symbol: GBPAUD
                    HistoricalChanges:
                      PercentChange1Month: 1.21
                      PercentChange2Months: 2.95
                      PercentChange3Months: 1.85
                      PercentChange6Months: -1.83
                      PercentChangeDaily: 0.22
                      PercentChangeWeekly: 1.67
                    InstrumentPriceDetails:
                      IsMarketOpen: true
                      ShortTradeDisabled: false
                      ValueDate: '2017-05-19'
                    LastUpdated: '0001-01-01T00:00:00Z'
                    PriceInfo:
                      High: 1.09117
                      Low: 1.08853
                      NetChange: 0.00048
                      PercentChange: 0.04
                    PriceInfoDetails:
                      AskSize: 1000000
                      BidSize: 1000000
                      LastClose: 1.08932
                      LastTraded: 0
                      LastTradedSize: 0
                      Open: 0
                      Volume: 0
                    Quote:
                      Amount: 100000
                      Ask: 1.74948
                      Bid: 1.74858
                      DelayedByMinutes: 15
                      ErrorCode: None
                      Mid: 1.74903
                      PriceTypeAsk: Indicative
                      PriceTypeBid: Indicative
                    Uic: 22
                  - AssetType: FxSpot
                    DisplayAndFormat:
                      Currency: CAD
                      Decimals: 4
                      Description: British Pound/Canadian Dollar
                      Format: AllowDecimalPips
                      OrderDecimals: 4
                      Symbol: GBPCAD
                    InstrumentPriceDetails:
                      IsMarketOpen: true
                      ShortTradeDisabled: false
                      ValueDate: '2017-05-19'
                    LastUpdated: '0001-01-01T00:00:00Z'
                    Quote:
                      Amount: 100000
                      Ask: 1.76278
                      Bid: 1.76198
                      DelayedByMinutes: 15
                      ErrorCode: None
                      Mid: 1.76238
                      PriceTypeAsk: Indicative
                      PriceTypeBid: Indicative
                    Uic: 23
                State: Active
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InstrumentNotAllowed
                    - InstrumentTypeNotSupportedException
                    - InvalidModelState
                    - InvalidRequest
                    - InvalidUic
                    - UicsInListNotUnique
                    - Unknown
                    - 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.
                      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.
                      UicsInListNotUnique: The UICs in the list must be unique.
                  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:
        restricted: Subscribe
      x-streaming-type:
        $ref: '#/components/schemas/InfoPriceResponseArrayDomainEvent'
  /trade/v1/infoprices/list:
    get:
      tags:
      - Info Prices
      summary: Get info prices for a list of instruments
      description: Get a list of info prices for a list of instruments using the specified parameters.
      operationId: InfoPricesV1GetInfoPriceListAsync
      parameters:
      - name: AccountKey
        in: query
        description: "Unique key identifying the account used in retrieving the infoprice.\n                Only required when calling context represents an authenticated user.\n                If not supplied a default account is assumed."
        style: form
        explode: false
        schema:
          title: "Unique key identifying the account used in retrieving the infoprice.\n                Only required when calling context represents an authenticated user.\n                If not supplied a default account is assumed."
          minLength: 1
          type: string
          x-type-name: AccountKey
        example: 01b64edf-da03-4145-bf33-ae21527d4c86
      - name: Amount
        in: query
        description: Order size, defaults to minimal order size for given instrument.
        style: form
        explode: false
        schema:
          title: Order size, defaults to minimal order size for given instrument.
          type: number
        example: 10
      - name: AmountType
        in: query
        style: form
        explode: false
        schema:
          allOf:
          - $ref: '#/components/schemas/OrderAmountType'
        example: CashAmount
      - name: AssetType
        in: query
        description: The instrument's asset type
        required: true
        style: form
        explode: false
        schema:
          title: The instrument's asset type
          allOf:
          - $ref: '#/components/schemas/AssetType'
        example: FxKnockOutOption
      - name: ExpiryDate
        in: query
        description: Optional expiry date - only relevant for options
        style: form
        explode: false
        schema:
          title: Optional expiry date - only relevant for options
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: FieldGroups
        in: query
        description: Specification of field groups to return in results. Default is "Quote"
        style: form
        explode: false
        schema:
          title: Specification of field groups to return in results. Default is "Quote"
          type: array
          items:
            $ref: '#/components/schemas/InfoPriceGroupSpec'
        example:
        - Commissions
      - name: ForwardDate
        in: query
        description: Forward date
        style: form
        explode: false
        schema:
          title: Forward date
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: ForwardDateFarLeg
        in: query
        description: Forward date for far leg
        style: form
        explode: false
        schema:
          title: Forward date for far leg
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: ForwardDateNearLeg
        in: query
        description: Forward date for near leg
        style: form
        explode: false
        schema:
          title: Forward date for near leg
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: LowerBarrier
        in: query
        description: Lower barrier
        style: form
        explode: false
        schema:
          title: Lower barrier
          type: number
        example: 10
      - name: OrderAskPrice
        in: query
        description: Order ask price. When specified, a corresponding cost of buying will be calculated for that price; otherwise the current market ask price will be used.
        style: form
        explode: false
        schema:
          title: Order ask price. When specified, a corresponding cost of buying will be calculated for that price; otherwise the current market ask price will be used.
          type: number
        example: 10
      - name: OrderBidPrice
        in: query
        description: Order bid price. When specified, a corresponding cost of selling will be calculated for that price; otherwise the current market bid price will be used.
        style: form
        explode: false
        schema:
          title: Order bid price. When specified, a corresponding cost of selling will be calculated for that price; otherwise the current market bid price will be used.
          type: number
        example: 10
      - name: PutCall
        in: query
        description: Put/call
        style: form
        explode: false
        schema:
          title: Put/call
          allOf:
          - $ref: '#/components/schemas/PutCall'
        example: None
      - name: QuoteCurrency
        in: query
        style: form
        explode: false
        schema:
          type: boolean
        example: true
      - name: StrikePrice
        in: query
        description: Strike price
        style: form
        explode: false
        schema:
          title: Strike price
          type: number
        example: 10
      - name: ToOpenClose
        in: query
        style: form
        explode: false
        schema:
          allOf:
          - $ref: '#/components/schemas/ToOpenClose'
        example: ToOpen
      - name: Uics
        in: query
        description: A comma separated list of Uics.
        required: true
        style: form
        explode: false
        schema:
          title: A comma separated list of Uics.
          type: string
        example: stringValue
      - name: UpperBarrier
        in: query
        description: Upper barrier
        style: form
        explode: false
        schema:
          title: Upper barrier
          type: number
        example: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoPriceResponseListResult'
              example:
                Data:
                - AssetType: FxSpot
                  DisplayAndFormat:
                    Currency: AUD
                    Decimals: 4
                    Description: British Pound/Australian Dollar
                    Format: AllowDecimalPips
                    OrderDecimals: 4
                    Symbol: GBPAUD
                  HistoricalChanges:
                    PercentChange1Month: 1.21
                    PercentChange2Months: 2.95
                    PercentChange3Months: 1.85
                    PercentChange6Months: -1.83
                    PercentChangeDaily: 0.22
                    PercentChangeWeekly: 1.67
                  InstrumentPriceDetails:
                    IsMarketOpen: true
                    ShortTradeDisabled: false
                    ValueDate: '2017-05-19'
                  LastUpdated: '0001-01-01T00:00:00Z'
                  PriceInfo:
                    High: 1.09117
                    Low: 1.08853
                    NetChange: 0.00048
                    PercentChange: 0.04
                  PriceInfoDetails:
                    AskSize: 1000000
                    BidSize: 1000000
                    LastClose: 1.08932
                    LastTraded: 0
                    LastTradedSize: 0
                    Open: 0
                    Volume: 0
                  Quote:
                    Amount: 100000
                    Ask: 1.74948
                    Bid: 1.74858
                    DelayedByMinutes: 15
                    ErrorCode: None
                    Mid: 1.74903
                    PriceTypeAsk: Indicative
                    PriceTypeBid: Indicative
                  Uic: 22
                - AssetType: FxSpot
                  DisplayAndFormat:
                    Currency: CAD
                    Decimals: 4
                    Description: British Pound/Canadian Dollar
                    Format: AllowDecimalPips
                    OrderDecimals: 4
                    Symbol: GBPCAD
                  InstrumentPriceDetails:
                    IsMarketOpen: true
                    ShortTradeDisabled: false
                    ValueDate: '2017-05-19'
                  LastUpdated: '0001-01-01T00:00:00Z'
                  Quote:
                    Amount: 100000
                    Ask: 1.76278
                    Bid: 1.76198
                    DelayedByMinutes: 15
                    ErrorCode: None
                    Mid: 1.76238
                    PriceTypeAsk: Indicative
                    PriceTypeBid: Indicative
                  Uic: 23
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InstrumentNotAllowed
                    - InstrumentTypeNotSupportedException
                    - InvalidRequest
                    - InvalidUic
                    - UicsInListNotUnique
                    - Unknown
                    type: string
                    example: None
                    x-enum-descriptions:
                      InvalidRequest: Invalid request.
                      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.
                      UicsInListNotUnique: The UICs in the list must be unique.
                  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
                    - InvalidPriceRequest
                    type: string
                    example: None
                    x-enum-descriptions:
                      IllegalInstrumentId: Unknown instrument name
                      InvalidPriceRequest: Invalid price 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:
        restricted: Read
  /trade/v1/infoprices:
    get:
      tags:
      - Info Prices
      summary: Get an info price for a specific instrument
      description: Gets an info price for an instrument using the specified parameters.
      operationId: InfoPricesV1GetInfoPriceAsync
      parameters:
      - name: AccountKey
        in: query
        description: "Unique key identifying the account used in retrieving the price.\n                Only required when calling context represents an authenticated user."
        style: form
        explode: false
        schema:
          title: "Unique key identifying the account used in retrieving the price.\n                Only required when calling context represents an authenticated user."
          minLength: 1
          type: string
          x-type-name: AccountKey
        example: 01b64edf-da03-4145-bf33-ae21527d4c86
      - name: Amount
        in: query
        description: Order size, defaults to minimal order size for given instrument.
        style: form
        explode: false
        schema:
          title: Order size, defaults to minimal order size for given instrument.
          type: number
        example: 10
      - name: AmountType
        in: query
        style: form
        explode: false
        schema:
          allOf:
          - $ref: '#/components/schemas/OrderAmountType'
        example: CashAmount
      - name: AssetType
        in: query
        description: The instrument's asset type
        required: true
        style: form
        explode: false
        schema:
          title: The instrument's asset type
          allOf:
          - $ref: '#/components/schemas/AssetType'
        example: FxKnockOutOption
      - name: ExpiryDate
        in: query
        description: Optional expiry date - only relevant for options
        style: form
        explode: false
        schema:
          title: Optional expiry date - only relevant for options
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: FieldGroups
        in: query
        description: Specification of fields to return in results
        style: form
        explode: false
        schema:
          title: Specification of fields to return in results
          type: array
          items:
            $ref: '#/components/schemas/InfoPriceGroupSpec'
        example:
        - Commissions
      - name: ForwardDate
        in: query
        description: Forward date
        style: form
        explode: false
        schema:
          title: Forward date
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: ForwardDateFarLeg
        in: query
        description: Forward date for far leg
        style: form
        explode: false
        schema:
          title: Forward date for far leg
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: ForwardDateNearLeg
        in: query
        description: Forward date for near leg
        style: form
        explode: false
        schema:
          title: Forward date for near leg
          type: string
          format: date-time
          x-type-name: UtcDateTime
        example: '9999-12-31T23:59:59.9999990+00:00'
      - name: LowerBarrier
        in: query
        description: Lower barrier
        style: form
        explode: false
        schema:
          title: Lower barrier
          type: number
        example: 10
      - name: OrderAskPrice
        in: query
        description: Price when buying. Used when subscribing on a price to get a corresponsing cost of buying.
        style: form
        explode: false
        schema:
          title: Price when buying. Used when subscribing on a price to get a corresponsing cost of buying.
          type: number
        example: 10
      - name: OrderBidPrice
        in: query
        description: Price when selling. Used when subscribing on a price to get a corresponsing cost of buying.
        style: form
        explode: false
        schema:
          title: Price when selling. Used when subscribing on a price to get a corresponsing cost of buying.
          type: number
        example: 10
      - name: PutCall
        in: query
        description: Put/call of an Option.
        style: form
        explode: false
        schema:
          title: Put/call of an Option.
          allOf:
          - $ref: '#/components/schemas/PutCall'
        example: None
      - name: QuoteCurrency
        in: query
        style: form
        explode: false
        schema:
          type: boolean
        example: true
      - name: StrikePrice
        in: query
        description: Strike price
        style: form
        explode: false
        schema:
          title: Strike price
          type: number
        example: 10
      - name: ToOpenClose
        in: query
        style: form
        explode: false
        schema:
          allOf:
          - $ref: '#/components/schemas/ToOpenClose'
        example: ToOpen
      - name: Uic
        in: query
        description: Unique id of the instrument
        required: true
        style: form
        explode: false
        schema:
          title: Unique id of the instrument
          type: integer
          format: int32
        example: 99
      - name: UpperBarrier
        in: query
        description: Upper barrier
        style: form
        explode: false
        schema:
          title: Upper barrier
          type: number
        example: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoPriceResponse'
              example:
                AssetType: FxSpot
                DisplayAndFormat:
                  Currency: AUD
                  Decimals: 4
                  Description: British Pound/Australian Dollar
                  Format: AllowDecimalPips
                  OrderDecimals: 4
                  Symbol: GBPAUD
                HistoricalChanges:
                  PercentChange1Month: 1.21
                  PercentChange2Months: 2.95
                  PercentChange3Months: 1.85
                  PercentChange6Months: -1.83
                  PercentChangeDaily: 0.22
                  PercentChangeWeekly: 1.67
                InstrumentPriceDetails:
                  IsMarketOpen: true
                  ShortTradeDisabled: false
                  ValueDate: '2017-05-19'
                LastUpdated: '0001-01-01T00:00:00Z'
                PriceInfo:
                  High: 1.09117
                  Low: 1.08853
                  NetChange: 0.00048
                  PercentChange: 0.04
                PriceInfoDetails:
                  AskSize: 1000000
                  BidSize: 1000000
                  LastClose: 1.08932
                  LastTraded: 0
                  LastTradedSize: 0
                  Open: 0
                  Volume: 0
                Quote:
                  Amount: 100000
                  Ask: 1.74948
                  Bid: 1.74858
                  DelayedByMinutes: 15
                  ErrorCode: None
                  Mid: 1.74903
                  PriceTypeAsk: Indicative
                  PriceTypeBid: Indicative
                Uic: 22
        '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:
        restricted: Read
components:
  schemas:
    MarketState:
      title: Defines the possible states of the Market.
      enum:
      - Closed
      - ClosingAuction
      - IntraDayAuction
      - Open
      - OpeningAuction
      - PostMarket
      - PreMarket
      - TradingAtLast
      - Unknown
      type: string
      example: ClosingAuction
      x-enum-descriptions:
        Unknown: Default value.
        Open: Market is open for trades (Automatic Trading, usually).
        Closed: Market is closed
        PreMarket: Market is in Pre Market Auction state
        PostMarket: Market is in Post Market Auction state
        IntraDayAuction: "Market is temporary out of normal Trading. In an Auction state This state is\n            for Intraday Auction. We have 2 specific states for Opening and Closing Auction"
        OpeningAuction: "Market is temporary out of normal Trading. This is the Auction that occur before \n            the market opens"
        ClosingAuction: "Market is temporary out of normal Trading. This is the Auction that occur after\n            the market closes."
        TradingAtLast: This state is after the Auction has finished, before normal Trading starts.
    InfoPriceListSubscriptionResponse:
      title: Public response contract returned after setting up a price subscription.
      type: object
      properties:
        ContextId:
          title: The streaming context id that this response is associated with.
          type: string
          example: ContextId-1
          x-display-order: 1
        ReferenceId:
          title: The reference id that (along with streaming context id and session id) identifies the subscription (within the context of a specific service/subscription type)
          type: string
          example: ReferenceId-1
          x-display-order: 2
        Format:
          title: The media type (RFC 2046), of the serialized data updates that are streamed to the client.
          type: string
          example: application/json
        InactivityTimeout:
          title: The time (in seconds) that the client should accept the subscription to be inactive before considering it invalid.
          type: integer
          format: int32
          example: 0
        RefreshRate:
          title: Actual refresh rate assigned to the subscription according to the customers SLA.
          type: integer
          format: int32
          example: 0
        Snapshot:
          title: Snapshot of the current data on hand, when subscription was created.
          allOf:
          - $ref: '#/components/schemas/InfoPriceResponseListResult'
        State:
          title: The value "Active".
          type: string
          description: This property is kept for backwards compatibility.
          example: Active
        Tag:
          title: Client specified tag assigned to the subscription, if specified in the request.
          type: string
          example: ClientTag
      additionalProperties: false
      example:
        ContextId: '20221030063404713'
        Format: application/json
        InactivityTimeout: 60
        ReferenceId: IP89383
        RefreshRate: 1000
        Snapshot:
          Data:
          - AssetType: FxSpot
            DisplayAndFormat:
              Currency: AUD
              Decimals: 4
              Description: British Pound/Australian Dollar
              Format: AllowDecimalPips
              OrderDecimals: 4
              Symbol: GBPAUD
            HistoricalChanges:
              PercentChange1Month: 1.21
              PercentChange2Months: 2.95
              PercentChange3Months: 1.85
              PercentChange6Months: -1.83
              PercentChangeDaily: 0.22
              PercentChangeWeekly: 1.67
            InstrumentPriceDetails:
              IsMarketOpen: true
              ShortTradeDisabled: false
              ValueDate: '2017-05-19'
            LastUpdated: '0001-01-01T00:00:00Z'
            PriceInfo:
              High: 1.09117
              Low: 1.08853
              NetChange: 0.00048
              PercentChange: 0.04
            PriceInfoDetails:
              AskSize: 1000000
              BidSize: 1000000
              LastClose: 1.08932
              LastTraded: 0
              LastTradedSize: 0
              Open: 0
              Volume: 0
            Quote:
              Amount: 100000
              Ask: 1.74948
              Bid: 1.74858
              DelayedByMinutes: 15
              ErrorCode: None
              Mid: 1.74903
              PriceTypeAsk: Indicative
              PriceTypeBid: Indicative
            Uic: 22
          - AssetType: FxSpot
            DisplayAndFormat:
              Currency: CAD
              Decimals: 4
              Description: British Pound/Canadian Dollar
              Format: AllowDecimalPips
              OrderDecimals: 4
              Symbol: GBPCAD
            InstrumentPriceDetails:
              IsMarketOpen: true
              ShortTradeDisabled: false
              ValueDate: '2017-05-19'
            LastUpdated: '0001-01-01T00:00:00Z'
            Quote:
              Amount: 100000
              Ask: 1.76278
              Bid: 1.76198
              DelayedByMinutes: 15
              ErrorCode: None
              Mid: 1.76238
              PriceTypeAsk: Indicative
              PriceTypeBid: Indicative
            Uic: 23
        State: Active
    InfoPriceListRequest:
      title: Use this to request a list of InfoPrices
      required:
      - Uics
      - AssetType
      type: object
      properties:
        AccountKey:
          title: "Unique key identifying the account used in retrieving the infoprice.\n                Only required when calling context represents an authenticated user.\n                If not supplied a default account is assumed."
          minLength: 1
          type: string
          x-type-name: AccountKey
        Amount:
          title: Order size, defaults to minimal order size for given instrument.
          type: number
        AmountType:
          allOf:
          - $ref: '#/components/schemas/OrderAmountType'
        AssetType:
          title: The instrument's asset type
          allOf:
          - $ref: '#/components/schemas/AssetType'
        ExpiryDate:
          title: Optional expiry date - only relevant for options
          type: string
          format: date-time
          x-type-name: UtcDateTime
        FieldGroups:
          title: Specification of field groups to return in results. Default is "Quote"
          type: array
          items:
            $ref: '#/components/schemas/InfoPriceGroupSpec'
        ForwardDate:
          title: Forward date
          type: string
          format: date-time
          x-type-name: UtcDateTime
        ForwardDateFarLeg:
          title: Forward date for far leg
          type: string
          format: date-time
          x-type-name: UtcDateTime
        ForwardDateNearLeg:
          title: Forward date for near leg
          type: string
          format: date-time
          x-type-name: UtcDateTime
        LowerBarrier:
          title: Lower barrier
          type: number
        OrderAskPrice:
          title: Order ask price. When specified, a corresponding cost of buying will be calculated for that price; otherwise the current market ask price will be used.
          type: number
        OrderBidPrice:
          title: Order bid price. When specified, a corresponding cost of selling will be calculated for that price; otherwise the current market bid price will be used.
          type: number
        PutCall:
          title: Put/call
          allOf:
          - $ref: '#/components/schemas/PutCall'
        QuoteCurrency:
          type: boolean
        StrikePrice:
          title: Strike price
          type: number
        ToOpenClose:
          allOf:
          - $ref: '#/components/schemas/ToOpenClose'
        Uics:
          title: A comma separated list of Uics.
          type: string
        UpperBarrier:
          title: Upper barrier
          type: number
      additionalProperties: false
      example:
        AccountKey: LZTc7DdejXODf-WSl2aCyQ==
        Amount: 100000
        AssetType: FxSpot
        FieldGroups:
        - DisplayAndFormat
        - HistoricalChanges
        - InstrumentPriceDetails
        - PriceInfo
        - PriceInfoDetails
        - Quote
        Uics: 22,23
    MarketDepth:
      title: Contains information about the market depth.
      type: object
      properties:
        Ask:
          title: List of prices of the current offers to sell in the market.
          type: array
          items:
            type: number
            example: 10
          example:
          - 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        AskOrders:
          title: List of order counts of the current offers to sell in the market.
          type: array
          items:
            type: number
            example: 10
          example:
          - 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        AskSize:
          title: List of amounts of the current offers to sell in the market.
          type: array
          items:
            type: number
            example: 10
          example:
          - 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Bid:
          title: List of prices of the current offers to buy in the market.
          type: array
          items:
            type: number
            example: 10
          example:
          - 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        BidOrders:
          title: List of order counts of the current offers to buy in the market.
          type: array
          items:
            type: number
            example: 10
          example:
          - 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        BidSize:
          title: List of amounts of the current offers to buy in the market.
          type: array
          items:
            type: number
            example: 10
          example:
          - 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        NoOfBids:
          title: Number of current bids on the instrument.
          type: integer
          format: int32
          example: 99
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        NoOfOffers:
          title: Number of current offers on the instrument.
          type: integer
          format: int32
          example: 99
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        UsingOrders:
          title: Using Orders.
          type: boolean
          example: true
      additionalProperties: false
      example:
        Ask:
        - 1.76671
        - 1.76676
        - 1.76706
        AskOrders:
        - 0
        - 0
        - 0
        AskSize:
        - 4000000
        - 7000000
        - 10000000
        Bid:
        - 1.76591
        - 1.76586
        - 1.76556
        BidOrders:
        - 0
        - 0
        - 0
        BidSize:
        - 4000000
        - 7000000
        - 10000000
        NoOfBids: 3
        NoOfOffers: 3
        UsingOrders: false
    HistoricalChanges:
      title: Historical data about the price changes (in %) for a number of periods, from 1 week to 5 years.
      type: object
      properties:
        FiftyTwoWeekHigh:
          title: The 52 week high
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        FiftyTwoWeekLow:
          title: The 52 week low
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange1Month:
          title: The 1 month percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange1Year:
          title: The 1 year percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange2Months:
          title: The 2 months percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange2Years:
          title: The 2 years percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange3Months:
          title: The 3 months percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange3Years:
          title: The 3 years percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange5Years:
          title: The 5 years percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange6Months:
          title: The 6 months percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChangeDaily:
          title: The daily percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChangeWeekly:
          title: The weekly percent change
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
      additionalProperties: false
      example:
        PercentChange1Month: 5.57
        PercentChange2Months: 5.83
        PercentChange3Months: 3.73
        PercentChange6Months: 6.49
        PercentChangeDaily: 0.2
        PercentChangeWeekly: 0.88
    OrderAmountType:
      title: Indicates if the order Amount is specified as an absolute amount of lots/shares/contracts or as a currency value.
      enum:
      - CashAmount
      - Quantity
      type: string
      example: Quantity
      x-enum-descriptions:
        Quantity: Default. Order Amount is specified as an amount of lots/shares/contracts.
        CashAmount: Order amount is specified as a monetary value.
    InfoPriceResponseArrayDomainEvent:
      type: object
      properties:
        Data:
          title: The type of data transported by the DomainEvent instance (e.g. price update, position list update etc.).
          type: array
          items:
            $ref: '#/components/schemas/InfoPriceResponse'
          example:
          - AssetType: FxSpot
            DisplayAndFormat:
              Currency: AUD
              Decimals: 4
              Description: British Pound/Australian Dollar
              Format: AllowDecimalPips
              OrderDecimals: 4
              Symbol: GBPAUD
            HistoricalChanges:
              PercentChange1Month: 1.21
              PercentChange2Months: 2.95
              PercentChange3Months: 1.85
              PercentChange6Months: -1.83
              PercentChangeDaily: 0.22
              PercentChangeWeekly: 1.67
            InstrumentPriceDetails:
              IsMarketOpen: true
              ShortTradeDisabled: false
              ValueDate: '2017-05-19'
            LastUpdated: '0001-01-01T00:00:00Z'
            PriceInfo:
              High: 1.09117
              Low: 1.08853
              NetChange: 0.00048
              PercentChange: 0.04
            PriceInfoDetails:
              AskSize: 1000000
              BidSize: 1000000
              LastClose: 1.08932
              LastTraded: 0
              LastTradedSize: 0
              Open: 0
              Volume: 0
            Quote:
              Amount: 100000
              Ask: 1.74948
              Bid: 1.74858
              DelayedByMinutes: 15
              ErrorCode: None
              Mid: 1.74903
              PriceTypeAsk: Indicative
              PriceTypeBid: Indicative
            Uic: 22
        PartitionNumber:
          title: The partition number if this DomainEvent is a partition.
          type: integer
          format: int32
          example: 99
        ReferenceId:
          title: Client specified id, which is sent back to the client with every data update.
          type: string
          example: stringValue
        Timestamp:
          title: The UTC date and time of the event.
          type: string
          format: date-time
          x-type-name: UtcDateTime
        TotalPartitions:
          title: The total number of partitions if this DomainEvent is a partition.
          type: integer
          format: int32
          example: 99
      additionalProperties: false
      example:
        Data:
        - AssetType: FxSpot
          DisplayAndFormat:
            Currency: AUD
            Decimals: 4
            Description: British Pound/Australian Dollar
            Format: AllowDecimalPips
            OrderDecimals: 4
            Symbol: GBPAUD
          HistoricalChanges:
            PercentChange1Month: 1.21
            PercentChange2Months: 2.95
            PercentChange3Months: 1.85
            PercentChange6Months: -1.83
            PercentChangeDaily: 0.22
            PercentChangeWeekly: 1.67
          InstrumentPriceDetails:
            IsMarketOpen: true
            ShortTradeDisabled: false
            ValueDate: '2017-05-19'
          LastUpdated: '0001-01-01T00:00:00Z'
          PriceInfo:
            High: 1.09117
            Low: 1.08853
            NetChange: 0.00048
            PercentChange: 0.04
          PriceInfoDetails:
            AskSize: 1000000
            BidSize: 1000000
            LastClose: 1.08932
            LastTraded: 0
            LastTradedSize: 0
            Open: 0
            Volume: 0
          Quote:
            Amount: 100000
            Ask: 1.74948
            Bid: 1.74858
            DelayedByMinutes: 15
            ErrorCode: None
            Mid: 1.74903
            PriceTypeAsk: Indicative
            PriceTypeBid: Indicative
          Uic: 22
        ReferenceId: IP89383
        Timestamp: '2022-10-30T06:43:04.4607500+00:00'
    PriceQuality:
      title: "This enumeration describes the reliability of the price. This is for spot trading on FX Options where a price must be\n            tradable in order for a spot trade to be accepted.Price access is controlled by\n            price feed subscriptions and lack of permission may lead to delayed (Indicative) or even complete absense of prices (NoAccess)"
      enum:
      - Indicative
      - NoAccess
      - NoMarket
      - None
      - OldIndicative
      - Pending
      - Tradable
      type: string
      example: None
      x-enum-descriptions:
        None: Price orgin is unknown.
        Tradable: "Directly tradable price. If this price was received from the /Prices endpoint, as opposed to the /InfoPrices endpoint, the caller use it as the basis for\n            making a trade, by posting to the /Positions endpoint (\"TradeOnQuote\")."
        Indicative: This is  valid price, but you cannot directly create a position on that price (normally shown as a yellow price).
        OldIndicative: This is  valid price, but the price is "old", so you the market may have moved significantly from the price.
        NoMarket: There is currently no access to the market on which the instrument is traded.
        NoAccess: User does not have permission to the price feed. While FX prices are normally free, access to other price feeds depends on application type, the partner's default price feeds and feed subscriptions held by the user
        Pending: A price is currently not available, but it will be shortly
    Quote:
      title: Provides quote data.
      type: object
      properties:
        Amount:
          title: The amount for which the quote is calculated.
          type: integer
          format: int32
          example: 99
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Ask:
          title: The ask price.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Bid:
          title: The bid price.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        DelayedByMinutes:
          title: If set, it defines the number of minutes by which the price is delayed.
          type: integer
          format: int32
          example: 99
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        ErrorCode:
          title: Gets or sets the error code.
          allOf:
          - $ref: '#/components/schemas/ErrorCode'
        MarketState:
          title: The source for the price information
          allOf:
          - $ref: '#/components/schemas/MarketState'
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Mid:
          title: The mid price.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PriceSource:
          title: The source for the price information
          type: string
          example: stringValue
        PriceTypeAsk:
          title: The price type for ask.
          allOf:
          - $ref: '#/components/schemas/PriceQuality'
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PriceTypeBid:
          title: The price type for bid.
          allOf:
          - $ref: '#/components/schemas/PriceQuality'
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        ReferencePrice:
          title: Suggested price based on best available price information. Typically used as suggested price when exchange is closed.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
      additionalProperties: false
      example:
        Amount: 100000
        Ask: 1.0899
        Bid: 1.0897
        DelayedByMinutes: 15
        ErrorCode: None
        Mid: 1.0898
        PriceTypeAsk: Indicative
        PriceTypeBid: Indicative
    AssetType:
      title: The possible AssetTypes for which you can get a quote or place an order or a trade.
      enum:
      - Bond
      - Cash
      - CertificateBonus
      - CertificateCappedBonus
      - CertificateCappedCapitalProtected
      - CertificateCappedOutperformance
      - CertificateConstantLeverage
      - CertificateDiscount
      - CertificateExpress
      - CertificateTracker
      - CertificateUncappedCapitalProtection
      - CertificateUncappedOutperformance
      - CfdIndexOption
      - CfdOnCompanyWarrant
      - CfdOnEtc
      - CfdOnEtf
      - CfdOnEtn
      - CfdOnFund
      - CfdOnFutures
      - CfdOnIndex
      - CfdOnRights
      - CfdOnStock
      - CompanyWarrant
      - ContractFutures
      - Etc
      - Etf
      - Etn
      - Fund
      - FuturesOption
      - FuturesStrategy
      - FxBinaryOption
      - FxForwards
      - FxKnockInOption
      - FxKnockOutOption
      - FxNoTouchOption
      - FxOneTouchOption
      - FxSpot
      - FxVanillaOption
      - GuaranteeNote
      - IpoOnStock
      - ManagedFund
      - MiniFuture
      - MutualFund
      - PortfolioNote
      - Rights
      - SrdOnEtf
      - SrdOnStock
      - Stock
      - StockIndex
      - StockIndexOption
      - StockOption
      - Warrant
      - WarrantDoubleKnockOut
      - WarrantKnockOut
      - WarrantOpenEndKnockOut
      - WarrantSpread
      type: string
      example: FxKnockOutOption
      x-enum-descriptions:
        FxSpot: Forex Spot.
        FxForwards: Forex Forward.
        FxVanillaOption: Forex Vanilla Option.
        FxKnockInOption: Forex Knock In Option.
        FxKnockOutOption: Forex Knock Out Option.
        FxBinaryOption: Forex Binary Option.
        FxOneTouchOption: Forex One Touch Option.
        FxNoTouchOption: Forex No Touch Option.
        ContractFutures: Contract Futures.
        FuturesStrategy: Futures Strategy.
        Stock: Stock.
        StockOption: Stock Option.
        Bond: Bond.
        FuturesOption: Futures Option.
        StockIndexOption: Stock Index Option.
        ManagedFund: 'Obsolete: Managed Fund.'
        Cash: Cash. Not tradeable!
        CfdOnStock: Cfd on Stock.
        CfdOnIndex: Cfd on Stock Index.
        CfdOnFutures: Cfd on Futures.
        StockIndex: Stock Index.
        MutualFund: Mutual Fund.
        CfdIndexOption: Cfd Index Option.
        CfdOnEtf: Cfd on Etf
        CfdOnEtc: Cfd on Etc
        CfdOnEtn: Cfd on Etn
        CfdOnFund: Cfd on Fund
        CfdOnRights: Cfd on Rights
        CfdOnCompanyWarrant: Cfd on unlisted warrant issued by a corporation.
        Etf: Exchange traded fund.
        Etc: Etc
        Etn: Etn
        Fund: Fund
        Rights: Rights
        Warrant: Warrant
        MiniFuture: MiniFuture.
        WarrantSpread: Warrant with built-in spread.
        WarrantKnockOut: Warrant with a knock-out barrier.
        WarrantOpenEndKnockOut: Knock-out Warrant with no expiry.
        WarrantDoubleKnockOut: Warrant with two knock-out barriers.
        CertificateUncappedCapitalProtection: Guarantees a percentage increase of the underlying asset's value above the issue price at expiry/maturity. Max loss is the amount invested multiplied by the CapitalProtection percentage.
        CertificateCappedCapitalProtected: Guarantees a capped percentage increase of the underlying asset's value above the issue price at expiry/maturity. Max loss is the amount invested multiplied by the CapitalProtection percentage.
        CertificateDiscount: Yields a capped return if the underlying asset's value is above the specified cap level at expiry. If the underlying's value is below the strike at expiry, the investor received the underlying or equivalent value. Offers direct exposure in underlying at a lower price (discount) with a capped potential profit and limited loss.
        CertificateCappedOutperformance: Capped Outperformance Certificate.
        CertificateCappedBonus: Certificate Capped Bonus.
        CertificateExpress: Certificate Express kick out.
        CertificateTracker: A certificate that mirrors the price movement of the underlying instrument. Often used to trade movements in indicies. Movements can be a fixed ratio of the underlying and can be inverted for bearish/short speculation. Risk is equivalent to owning the underlying.
        CertificateUncappedOutperformance: Provides leveraged returns when the underlying price exceeds the threshold strike price. The amount leverage is defined by the Participation %. When the underlying is below the strike price, the certificate mirrors the underlying price 1:1.
        CertificateBonus: Mirrors the price movement of the underlying only if and when the underlying price exceeds the defined barrier. If the certificate expires below the barrier, it offers partial protection/return of investment.
        CertificateConstantLeverage: Certificate Constant Leverage.
        SrdOnStock: SRD. (Service de Règlement Différé) on Stock.
        SrdOnEtf: SRD. (Service de Règlement Différé) on Etf.
        IpoOnStock: IPO on Stock
        CompanyWarrant: Unlisted warrant issued by a corporation, often physically settled.
        PortfolioNote: Danish pooled investment scheme (“Pulje”). Not online tradeable.
        GuaranteeNote: Danish investment scheme (“Grantbevis”). Not online tradeable.
    PutCall:
      title: Describes the direction of an option.
      enum:
      - Call
      - None
      - Put
      type: string
      example: Call
      x-enum-descriptions:
        None: Not specified.
        Put: Put.
        Call: Call.
    InfoPriceResponse:
      title: Public contract providing the latest info price information upon a request.
      required:
      - Uic
      type: object
      properties:
        AssetType:
          title: Asset Type of the instrument
          allOf:
          - $ref: '#/components/schemas/AssetType'
        Commissions:
          title: The commissions
          allOf:
          - $ref: '#/components/schemas/Commissions'
        DisplayAndFormat:
          title: Information about the instrument of the net position and how to display it.
          allOf:
          - $ref: '#/components/schemas/InstrumentDisplayAndFormat'
        ErrorCode:
          title: Error code, only there if instrument doesn't exist
          allOf:
          - $ref: '#/components/schemas/TradingErrorCode'
        ErrorMessage:
          title: Error message, only there if instrument doesn't exist
          type: string
          example: stringValue
        HistoricalChanges:
          title: The historical price changes
          allOf:
          - $ref: '#/components/schemas/HistoricalChanges'
        InstrumentPriceDetails:
          title: Instrument Specific Price Details. Contents vary by AssetType
          allOf:
          - $ref: '#/components/schemas/InstrumentPriceDetails'
        LastUpdated:
          title: Time of last price update.
          type: string
          format: date-time
          x-type-name: UtcDateTime
        MarketDepth:
          title: The market depth
          allOf:
          - $ref: '#/components/schemas/MarketDepth'
        PriceInfo:
          title: Brief price information.
          allOf:
          - $ref: '#/components/schemas/PriceInfo'
        PriceInfoDetails:
          title: Detailed price information
          allOf:
          - $ref: '#/components/schemas/PriceInfoDetails'
        PriceSource:
          title: The source for the price information
          type: string
          example: stringValue
        Quote:
          title: The quote data.
          allOf:
          - $ref: '#/components/schemas/Quote'
        Uic:
          title: Uic of instrument
          type: integer
          format: int32
          example: 99
      additionalProperties: false
      example:
        AssetType: FxSpot
        DisplayAndFormat:
          Currency: AUD
          Decimals: 4
          Description: British Pound/Australian Dollar
          Format: AllowDecimalPips
          OrderDecimals: 4
          Symbol: GBPAUD
        HistoricalChanges:
          PercentChange1Month: 1.21
          PercentChange2Months: 2.95
          PercentChange3Months: 1.85
          PercentChange6Months: -1.83
          PercentChangeDaily: 0.22
          PercentChangeWeekly: 1.67
        InstrumentPriceDetails:
          IsMarketOpen: true
          ShortTradeDisabled: false
          ValueDate: '2017-05-19'
        LastUpdated: '0001-01-01T00:00:00.0000000+00:00'
        PriceInfo:
          High: 1.09117
          Low: 1.08853
          NetChange: 0.00048
          PercentChange: 0.04
        PriceInfoDetails:
          AskSize: 1000000
          BidSize: 1000000
          LastClose: 1.08932
          LastTraded: 0
          LastTradedSize: 0
          Open: 0
          Volume: 0
        Quote:
          Amount: 100000
          Ask: 1.74948
          Bid: 1.74858
          DelayedByMinutes: 15
          ErrorCode: None
          Mid: 1.74903
          PriceTypeAsk: Indicative
          PriceTypeBid: Indicative
        Uic: 22
    InstrumentDisplayAndFormat:
      title: Public data contract containing information about the instrument of a position, which is useful for display and formatting.
      type: object
      properties:
        BarrierDecimals:
          title: Optional separate display information for option barrier prices
          type: integer
          format: int32
          example: 99
        BarrierFormat:
          title: Optional separate display information for option barrier prices
          allOf:
          - $ref: '#/components/schemas/PriceDisplayFormatType'
        Currency:
          title: The ISO currency code of the instrument.
          type: string
          example: stringValue
        Decimals:
          title: "The resolution in which e.g. a price must be displayed and possibly edited.\n            Positive numbers are represents digits, and negative numbers represent fractions using this formula: 1/(2^x)."
          type: integer
          description: Decimals and DisplayDecimals have the same value. Moving forward, DisplayDecimals will be removed.
          format: int32
          example: 99
        Description:
          title: Description of instrument (DAX Index - Nov 2013), in English.
          type: string
          example: stringValue
        DisplayHint:
          title: Hint to the client application about how it should display the instrument.
          allOf:
          - $ref: '#/components/schemas/DisplayHintType'
        Format:
          title: Format code specifying how price should be formatted.
          allOf:
          - $ref: '#/components/schemas/PriceDisplayFormatType'
        LotSizeText:
          title: Lot size description of the instrument. Futures only.
          type: string
          example: stringValue
        NumeratorDecimals:
          title: Some fractional prices have decimals in the numerator, e.g. 2.5/32.  This is relevant for futures and cfds on futures.
          type: integer
          format: int32
          example: 99
        OrderDecimals:
          title: The number of decimals trigger price for orders should be formatted with.
          type: integer
          format: int32
          example: 99
        StrikeDecimals:
          title: Optional separate display information for option strike prices
          type: integer
          format: int32
          example: 99
        StrikeFormat:
          title: Optional separate display information for option strike prices
          allOf:
          - $ref: '#/components/schemas/PriceDisplayFormatType'
        Symbol:
          title: Symbol- A combination of letters used to uniquely identify a traded instrument. e.g. ODAX/X13C8950:xeur.
          type: string
          example: stringValue
      additionalProperties: false
      example:
        Currency: USD
        Decimals: 4
        Description: Euro/US Dollar
        Format: AllowDecimalPips
        Symbol: EURUSD
    PriceInfo:
      title: Brief information about the price.
      type: object
      properties:
        High:
          title: The high.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Low:
          title: The low.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        NetChange:
          title: The net change in price (Mid price – LastClose price)
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        PercentChange:
          title: "The percent change in price.\n            If LastClose greater than 0 , value = NetChange/LastClose * 100\n            If NetChange less than 0 , value = -100\n            If NetChange equal to 0 , value = 0\n            If NetChange greater than 100 , value = +100"
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
      additionalProperties: false
      example:
        High: 1.09117
        Low: 1.08853
        NetChange: 0.00048
        PercentChange: 0.04
    ToOpenClose:
      title: Specifies whether the order will be created to open/increase or close/decrease a position (only relevant for options).
      enum:
      - ToClose
      - ToOpen
      - Undefined
      type: string
      example: Undefined
      x-enum-descriptions:
        Undefined: Undefined.
        ToOpen: Order/Position is ToOpen.
        ToClose: Order/Position is ToClose.
    Commissions:
      title: Commissions for buying and selling the instrument.
      type: object
      properties:
        CostBuy:
          title: The cost to pay if instrument is bought.
          type: number
          example: 10
        CostIpoCashSubscription:
          title: The cost to pay for Ipo Subscription in case of Cash option
          type: number
          example: 10
        CostIpoSubscription:
          title: The cost to pay for Ipo Subscription in case of Finance option
          type: number
          example: 10
        CostSell:
          title: The cost to pay if instrument is sold.
          type: number
          example: 10
      additionalProperties: false
      example:
        CostBuy: 0
        CostIpoCashSubscription: 0
        CostIpoSubscription: 0
        CostSell: 0
    PriceInfoDetails:
      title: Additional information related to the instrument
      type: object
      properties:
        AskSize:
          title: The ask size.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        AskYield:
          title: Optional ask yield, if available.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        BidSize:
          title: The bid size.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        BidYield:
          title: Optional bid yield, if available.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        LastClose:
          title: The last close.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        LastTraded:
          title: The last traded.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        LastTradedSize:
          title: The last traded size.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Open:
          title: The open.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        Volume:
          title: Optional volume, if available.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
      additionalProperties: false
      example:
        AskSize: 1000000
        BidSize: 1000000
        LastClose: 1.729595
        LastTraded: 0
        LastTradedSize: 0
        Open: 0
        Volume: 0
    InfoPriceGroupSpec:
      title: Specification of fieldsets to include in results.
      enum:
      - Commissions
      - DisplayAndFormat
      - HistoricalChanges
      - InstrumentPriceDetails
      - MarketDepth
      - PriceInfo
      - PriceInfoDetails
      - Quote
      type: string
      example: MarketDepth
      x-enum-descriptions:
        Quote: Quote data fields are returned in results.
        PriceInfo: Informational price fields are returned in results.
        PriceInfoDetails: Detailed price fields are returned in results.
        InstrumentPriceDetails: "Fields related to the asset type are returned in results.\n            Fields in this group are only returned when issuing a GET and in the initial snapshot if setting up a subscription."
        MarketDepth: Market depth fields are returned in results.
        Commissions: Commission fields are returned in results.
        HistoricalChanges: Historical price changes are returned in results.
        DisplayAndFormat: Display and Format
      x-type-warning: FlaggableEnum
    ModelStateDictionary:
      type: object
      additionalProperties:
        type: array
        items:
          type: string
    InfoPriceResponseListResult:
      type: object
      properties:
        Data:
          type: array
          items:
            $ref: '#/components/schemas/InfoPriceResponse'
          description: The collection of entities for this feed.
        MaxRows:
          type: number
          description: The maximum number of rows that can be returned (if applicable).
        __count:
          type: number
          description: The total count of items in the feed.
        __next:
          type: string
          description: The link for the next page of items in the feed.
      additionalProperties: false
      example:
        Data:
        - AssetType: FxSpot
          DisplayAndFormat:
            Currency: AUD
            Decimals: 4
            Description: British Pound/Australian Dollar
            Format: AllowDecimalPips
            OrderDecimals: 4
            Symbol: GBPAUD
          HistoricalChanges:
            PercentChange1Month: 1.21
            PercentChange2Months: 2.95
            PercentChange3Months: 1.85
            PercentChange6Months: -1.83
            PercentChangeDaily: 0.22
            PercentChangeWeekly: 1.67
          InstrumentPriceDetails:
            IsMarketOpen: true
            ShortTradeDisabled: false
            ValueDate: '2017-05-19'
          LastUpdated: '0001-01-01T00:00:00Z'
          PriceInfo:
            High: 1.09117
            Low: 1.08853
            NetChange: 0.00048
            PercentChange: 0.04
          PriceInfoDetails:
            AskSize: 1000000
            BidSize: 1000000
            LastClose: 1.08932
            LastTraded: 0
            LastTradedSize: 0
            Open: 0
            Volume: 0
          Quote:
            Amount: 100000
            Ask: 1.74948
            Bid: 1.74858
            DelayedByMinutes: 15
            ErrorCode: None
            Mid: 1.74903
            PriceTypeAsk: Indicative
            PriceTypeBid: Indicative
          Uic: 22
        - AssetType: FxSpot
          DisplayAndFormat:
            Currency: CAD
            Decimals: 4
            Description: British Pound/Canadian Dollar
            Format: AllowDecimalPips
            OrderDecimals: 4
            Symbol: GBPCAD
          InstrumentPriceDetails:
            IsMarketOpen: true
            ShortTradeDisabled: false
            ValueDate: '2017-05-19'
          LastUpdated: '0001-01-01T00:00:00Z'
          Quote:
            Amount: 100000
            Ask: 1.76278
            Bid: 1.76198
            DelayedByMinutes: 15
            ErrorCode: None
            Mid: 1.76238
            PriceTypeAsk: Indicative
            PriceTypeBid: Indicative
          Uic: 23
    InstrumentPriceDetails:
      title: Additional instrument specific price details
      type: object
      properties:
        AccruedInterest:
          title: 'Accrued Interest. Valid for: Bonds'
          type: number
          example: 10
        AskYield:
          title: AskYield are only valid for the bond asset type.
          type: number
          example: 10
        BidYield:
          title: BidYield are only valid for the bond asset type.
          type: number
          example: 10
        CfdBorrowingCost:
          title: Costs applicable to shorting the CFD.
          type: number
          example: 10
        CfdHardToFinanceRate:
          title: A rate relevant for certain long cfd positions
          type: number
          example: 10
        CfdPriceAdjustment:
          title: Is returned as true when the instrument subscribed for is a CFD and the user is on a special mark-up price configuration. If true, the values in EstPriceBuy and EstPriceSell are relevant (but still only provided given a share price)
          type: boolean
          example: true
        Dma:
          title: Trade is routed to trading venue. Trade on quote not allowed.
          type: boolean
          example: true
        EstPriceBuy:
          title: May be returned when the instrument subscribed for is a CFD on a stock and the user is set up to trade on the share price, but pay a markup on top. In that case the EstPriceBuy is the markup paied for an eventual buy order. Not relevant for info prices.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        EstPriceSell:
          title: May be returned when the instrument subscribed for is a CFD and the user is set up to trade on the share price, but pay a markup on top. In that case the EstPriceSell is the markup paied for an eventual sell order. Not relevant for info prices.
          type: number
          example: 10
          x-license-terms:
            description: Price values are depending on a subscription to a feed. This can mean no data, delayed data or real time data dependent on the callers subscription setup.
        ExpiryDate:
          title: 'Expiry date for contract. Valid for: CFD Futures, FxOptions'
          type: string
          format: date
          x-type-name: Date
        ForwardDateFarLeg:
          title: The far leg value date. Applicable for FxSwap
          type: string
          format: date
          x-type-name: Date
        ForwardDateNearLeg:
          title: The near leg value date. Applicable for FxSwap
          type: string
          format: date
          x-type-name: Date
        IndexRatio:
          title: IndexRatio, Applicable for  inflation linked bond
          type: number
          example: 10
        IsMarketOpen:
          title: Gets or sets a value indicating whether the market on which the instrument is traded is currently open.
          type: boolean
          example: true
        LowerBarrier:
          title: 'Lower Barrier. Valid for: FX One Touch, No TouchOptions and certian derivatives such as Turbos.'
          type: number
          example: 10
        MidForwardPrice:
          title: The mid forward price.
          type: number
          example: 10
        MidSpotPrice:
          title: 'The post mid price. Valid for: Fx Options.'
          type: number
          example: 10
        MidYield:
          title: MidYield are only valid for the bond asset type.
          type: number
          example: 10
        NoticeDate:
          title: Futures only - The date on which the owner may be required to take physical delivery of the instrument commodity.
          type: string
          format: date
          x-type-name: Date
        OpenInterest:
          title: The number of currently open contracts (available for contract options and futures)
          type: number
          example: 10
        PaidCfdInterest:
          title: A rate representing the interest to be paid when holding a CFD short position overnight.
          type: number
          example: 10
        PaidSrdInterest:
          title: A rate representing the interest to be paid when holding a SRD short position overnight.
          type: number
          example: 10
        ReceivedCfdInterest:
          title: A rate representing the interest received when with holding a CFD long position overnight.
          type: number
          example: 10
        ReceivedSrdInterest:
          title: A rate representing the interest received when with holding a SRD long position overnight.
          type: number
          example: 10
        ShortTradeDisabled:
          title: Set to true if short trading is disabled for this instrument.
          type: boolean
          example: true
        SpotAsk:
          title: 'The spot ask price Valid for: FX Forwards.'
          type: number
          example: 10
        SpotBid:
          title: 'The post bid price. Valid for: Fx Forwards.'
          type: number
          example: 10
        SpotDate:
          title: The Spot Date. Valid for Fx Forwards.
          type: string
          format: date
          x-type-name: Date
        SrdLastTradeDate:
          title: Liquidation/Last Trade Date of the SRD
          type: string
          example: stringValue
        SrdSettlementDate:
          title: Settlement Date of the SRD
          type: string
          example: stringValue
        StrikePrice:
          title: Option Strike Price.
          type: number
          example: 10
        SwapAsk:
          title: 'Swap rate for ask, Valid for: FxForwards and FxSwap'
          type: number
          example: 10
        SwapBid:
          title: 'Swap rate for bid, Valid for: FxForwards and FxSwap'
          type: number
          example: 10
        UpperBarrier:
          title: 'Upper Barrier. Valid for: FX One Touch, No TouchOptions and certian derivatives such as Turbos.'
          type: number
          example: 10
        ValueDate:
          title: Actual ValueDate (could be different from what was specified in request due to holidays etc.).
          type: string
          format: date
          x-type-name: Date
      additionalProperties: false
      example:
        ExpiryDate: '2017-06-01'
        IsMarketOpen: true
        LowerBarrier: -2
        MidForwardPrice: 1.71992423552514
        ShortTradeDisabled: false
        SpotAsk: 1.71782
        SpotBid: 1.71692
        SpotDate: '2017-06-03'
        StrikePrice: 1.7175
        UpperBarrier: 4
        ValueDate: '2017-06-05'
    DisplayHintType:
      title: Display Hint Type.
      enum:
      - Continuous
      - CryptoCurrencies
      - Etc
      - Etf
      - Etn
      - Forex
      - Fund
      - Interests
      - None
      - PreciousMetal
      - Rights
      - StockIndices
      - Warrant
      type: string
      example: Continuous
      x-enum-descriptions:
        None: Indicates not special display hint is required.
        PreciousMetal: Metals like XAUUSD.
        Continuous: Used for the parent ContractFutures.
        Etf: Exchange Traded Funds.
        Etn: Exchange Traded Notes.
        Etc: Exchange Traded Certificates/Currencies.
        Rights: Rights.
        Warrant: Warrants.
        Forex: Forex. Intended to be used for Cfds on Futures on Forex.
        Interests: Interest rates. Intended to be used for Cfds on Futures on bonds.
        StockIndices: Stock indices. Intended to be used for Cfds on Futures on stock indices.
        Fund: Fund.
        CryptoCurrencies: Crypto currencies.
    PriceDisplayFormatType:
      title: The format modifiers in which e.g. a price must be displayed and possibly edited.
      enum:
      - AllowDecimalPips
      - Fractions
      - ModernFractions
      - Normal
      - Percentage
      type: string
      example: ModernFractions
      x-enum-descriptions:
        Normal: No special display format for this price.
        Fractions: Decimals are denoted in as a fractions. Common for commodity futures. PriceDecimals indicated the nominator.
        ModernFractions: Special US Bonds futures fractional format (1/32s or 1/128s without nominator). If PriceDecimals = -5 then the nominator is 32, else 128.
        Percentage: Display as percentage, e.g. 12.34%.
        AllowDecimalPips: "Display the last digit as a smaller than the rest of the numbers. Note that this digit is not included in the number of decimals, effectively\n            increasing the number of decimals by one. E.g. 12.345 when Decimals is 2 and DisplayFormat is AllowDecimalPips."
    InfoPriceListSubscriptionRequest:
      title: Public request contract for setting up a price subscription.
      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/InfoPriceListRequest'
        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:
          title: "Optional custom refresh rate, measured in milliseconds, between each data update.\n            Note that it is not possible to get a refresh rate lower than the rate specified in the\n            customer service level agreement (SLA)."
          maximum: 2147483647
          minimum: 0
          type: integer
          format: int32
          example: 0
        ReplaceReferenceId:
          title: Reference id of the subscription that should be replaced.
          pattern: ^[a-zA-Z0-9-][a-zA-Z0-9_-]{0,49}$
          type: string
          example: ReplaceReferenceId-1
        Tag:
          title: Optional client specified tag used for grouping subscriptions.
          type: string
          example: ClientTag
      additionalProperties: false
      example:
        Arguments:
          AccountKey: LZTc7DdejXODf-WSl2aCyQ==
          AssetType: FxSpot
          FieldGroups:
          - DisplayAndFormat
          - HistoricalChanges
          - InstrumentPriceDetails
          - PriceInfo
          - PriceInfoDetails
          - Quote
          Uics: 22,23
        ContextId: '20221030063404713'
        ReferenceId: IP89383
        RefreshRate: 1000
    TradingErrorCode:
      title: Enumeration of Trading errors and related descriptions returned by endpoints.
      enum:
      - AccountIsTradeRestricted
      - ActiveFollowerCannotCancelOrderManually
      - AlgoOrderErrorInParameterValue
      - AlgoOrderIllegalAssetType
      - AlgoOrderIllegalDurationType
      - AlgoOrderMissingMandatoryParameter
      - AllocationKeyNotFound
      - AllocationKeyPercentDoesNotSumToOneHundred
      - AlreadyPendingCancelReplace
      - AmountBelowMinimumLotSize
      - AmountDiffersFromAmountOnRelatedOrder
      - AmountLowerThanAllocationKeyUnits
      - AmountNotInLotSize
      - BarrierTooCloseToSpot
      - BrokerOption
      - ClientCannotCancelMarketExpiryOrder
      - ClientExposureLimitation
      - ClmDataFeedClientExceptionCommissionRuleMissing
      - CloseAllPositionsAlreadyBeingClosed
      - DirectAccessNotAllowed
      - DurationNotSupported
      - ExchangeNotSupported
      - ExchangeRateNotAvailable
      - ExpirationDateInPast
      - ExpirationDateRequired
      - ForwardDateInPast
      - ForwardDateRequired
      - FxSwapLegsValueDateRequired
      - IllegalAccount
      - IllegalAmount
      - IllegalDate
      - IllegalInstrumentId
      - IllegalStrike
      - IllegalWatchlistId
      - InstrumentDisabledForTrading
      - InstrumentHasExpired
      - InstrumentNotAllowed
      - InstrumentNotFoundOrNotAllowedForMarketTrades
      - InstrumentNotTradableAsTheSelectedType
      - InstrumentSuspended
      - InstrumentTypeNotSupportedException
      - InsufficentCash
      - InsufficientTradeLevelException
      - InternalServerError
      - InvalidAllocationKeyUsed
      - InvalidCurrencyPair
      - InvalidExpiryTimeOnExchange
      - InvalidFxSwapLegsValueDate
      - InvalidMessageId
      - InvalidOptionRootId
      - InvalidPriceRequest
      - InvalidRefreshRate
      - InvalidRequest
      - InvalidTimeInExpiationDateTime
      - InvalidTraderId
      - InvalidUic
      - MarginBorderline
      - MarketClosed
      - MissingTimeInExpirationDateTime
      - NoChatMessageEntered
      - NoDataAccess
      - NoValidQuote
      - NotTradableAtPresent
      - OnWrongSideOfMarket
      - OpeningShortFXOptionPositionsNotAllowed
      - OptionExerciseAfterCutoff
      - OptionsChainNotSupportedForAssetType
      - OrderCannotBeCancelledAtThisTime
      - OrderNotFound
      - OrderNotPlaced
      - OrderRelatedPositionMissMatch
      - OrderRequestAfterLastTradingDate
      - OrderValueToSmall
      - OrderValueTooLarge
      - PendingTradeRequests
      - PositionBuildupNotValidForInstrument
      - PriceExceedsAggressiveTolerance
      - PriceNotFound
      - PriceNotInTickSizeIncrements
      - PriceRequestRequiresExpiryDate
      - PriceRequestRequiresPutCall
      - QuoteHasTimedOut
      - RelatedOrderWasRejected
      - RequestForQuoteFailed
      - RequestForQuoteNotAllowed
      - RequestMarginImpactOnNextPriceFailed
      - RequoteRequired
      - ShortTradeDisabled
      - TooCloseToEntryOrder
      - TooCloseToMarket
      - TooCloseToOcoRelatedOrderPrice
      - TooFarFromEntryOrder
      - TooFarFromMarket
      - TooLateToCancelOrder
      - TooManyStrikesRequested
      - TooSmallTrade
      - TradeSessionNotPrimary
      - TraderIdIsRequired
      - UicsInListNotUnique
      - UnexpectedTimeInExpirationDateTime
      - Unknown
      - WarningAmountLargeOrderSize
      - WouldExceedEquityConcentrationLimit
      - WouldExceedMargin
      - WouldExceedMarginCeiling
      - WouldExceedTradingLine
      type: string
      description: "Each value in the enumeration should have a  with a human readable description of the error.\n            Values must be &gt; 100 as this is reserved by global Open API error codes."
      example: Unknown
      x-enum-descriptions:
        Unknown: Unknown or no error code.
        InstrumentNotAllowed: Error code returned when the account is not allowed to trade in or receive prices for the specified asset type.
        InvalidUic: Error code returned when the UIC is either invalid or not specified.
        InvalidRequest: Invalid request.
        InvalidRefreshRate: Invalid refresh rate.
        NoChatMessageEntered: No chat message entered.
        InvalidOptionRootId: Invalid option root id specified.
        IllegalInstrumentId: Instrument cannot be found.
        InstrumentTypeNotSupportedException: Unsupported instrument type
        IllegalStrike: Illegal strike price.
        IllegalAmount: Illegal amount.
        UicsInListNotUnique: Info price uic list is not distinct
        IllegalDate: Illegal Date.
        MarketClosed: Market is closed.
        IllegalAccount: Account not allowed.
        NoValidQuote: No valid quote to buy or sell on.
        OrderNotFound: Requested order id not found.
        QuoteHasTimedOut: Quote has timed out.
        InsufficentCash: Insufficient cash for trade.
        WouldExceedMargin: Trade would exceed margin limits.
        MarginBorderline: Trade would result in borderline margin
        TooCloseToMarket: Guaranteed stop is too close to market.
        RequoteRequired: Price has changed to much, requote required.
        TooSmallTrade: Trade contract size is to small
        OnWrongSideOfMarket: Order price is on wrong side of market.
        TooLateToCancelOrder: Too late to cancel order.
        BrokerOption: Request rejected by broker.
        TooFarFromMarket: Limit price is too far from market.
        ShortTradeDisabled: Trading Short for selected instrument disabled.
        InstrumentSuspended: Trading in instrument is suspended
        AlreadyPendingCancelReplace: Request to Cancel or Replace order already send.
        NotTradableAtPresent: Not tradable at present.
        DirectAccessNotAllowed: Instrument invalid for Direct Access trading
        PendingTradeRequests: Limit of pending trade requests is exceeded
        ClientExposureLimitation: Trade would exceed client exposure limitation.
        TooCloseToEntryOrder: Contingent guaranteed stop price is too close to entry order price.
        OrderValueTooLarge: Order value is too large.
        TooFarFromEntryOrder: Order price is too far from the entry order.
        AmountDiffersFromAmountOnRelatedOrder: Amount differs from amount on related order.
        InstrumentHasExpired: Instrument has expired
        ClientCannotCancelMarketExpiryOrder: Client cannot cancel Market Expiry Order.
        TooCloseToOcoRelatedOrderPrice: Order price is too close to OCO related order price.
        RequestForQuoteFailed: Price subscription cannot enter Request For Quote.
        RequestMarginImpactOnNextPriceFailed: Price subscription cannot add margin impact.
        RequestForQuoteNotAllowed: Request For Quote is not allowed for an existing price subscription.
        OrderCannotBeCancelledAtThisTime: Order cannot be canceled at this time
        OrderNotPlaced: Order not placed
        InvalidAllocationKeyUsed: Order or trade placed with an allocationkey thats invalid or marked as inactive or deleted
        AmountLowerThanAllocationKeyUnits: Order or trade placed or changed to amount lower than sum of units in allocation key.
        CloseAllPositionsAlreadyBeingClosed: The specified closeAll key covers positions already closed by a closeAll key.
        PositionBuildupNotValidForInstrument: A trade or order was placed with position buildup on an instrument not supporting this.
        AccountIsTradeRestricted: Account is trade restricted.
        BarrierTooCloseToSpot: Barrier is too close to spot.
        OptionExerciseAfterCutoff: Exercise not allowed after exercise cut-off time or on last trading day or later.
        RelatedOrderWasRejected: Order request rejected due to failure for related order.
        WouldExceedMarginCeiling: Would exceed margin ceiling.
        OpeningShortFXOptionPositionsNotAllowed: Opening short FX option positions is not allowed.
        WouldExceedEquityConcentrationLimit: Would exceed equity concentration limit.
        WouldExceedTradingLine: Trade would exceed trading line limits.
        AmountNotInLotSize: Order size is not valid for the exchange.
        OrderValueToSmall: Order value must be above the minimum order value for this exchange.
        OrderRequestAfterLastTradingDate: The instruments's last trading date has passed.
        ActiveFollowerCannotCancelOrderManually: An active trade follower is not allowed to cancel order manually.
        PriceNotFound: Price from client trade request was not found in price history.
        InstrumentDisabledForTrading: Trading is disabled for the instrument.
        ExpirationDateInPast: 'Error code when expiration date is not set on order request having order duration: GoodTillDate'
        ExpirationDateRequired: 'Error code when expiration date in the past on order request having order duration: GoodTillDate'
        ForwardDateRequired: Error code when forward date is not set on FxForwards order.
        ForwardDateInPast: Error code when forward date is in the past on FxForwards order request.
        InvalidExpiryTimeOnExchange: 'Error code when expiration date is not set on order request having order duration: GoodTillDate'
        InvalidTimeInExpiationDateTime: 'Error code when expiration date is not set on order request having order duration: GoodTillDate'
        UnexpectedTimeInExpirationDateTime: 'Error code when expiration date is not set on order request having order duration: GoodTillDate'
        MissingTimeInExpirationDateTime: 'Error code when expiration date is not set on order request having order duration: GoodTillDate'
        TooManyStrikesRequested: Error code when too many strikes are quested for one options-chain.
        OptionsChainNotSupportedForAssetType: Error code when OptionsChain subscriptions are not supported for the given AssetType.
        ClmDataFeedClientExceptionCommissionRuleMissing: Error code return when commission rule is missing.
        InvalidPriceRequest: Error code returned when an invalid price request is submitted
        PriceRequestRequiresExpiryDate: Error code returned price request requires expiry date
        PriceRequestRequiresPutCall: Error code returned price request requires setting put or call
        TradeSessionNotPrimary: Error code return when a position cannot be created, updated or exercised, because the session is not the primary trade session
        InsufficientTradeLevelException: Indicates that an operation cannot be performed because the resource requires a higher TradeLevel that the current session has.
        InvalidMessageId: The provided message id is either invalid or not found.
        InstrumentNotTradableAsTheSelectedType: The instrument is not tradable as the selected asset type
        NoDataAccess: No data access to instrument prices
        PriceNotInTickSizeIncrements: The price is not in valid ticksize increments
        DurationNotSupported: The supplied duration is not supported for the current order
        AmountBelowMinimumLotSize: The supplied duration is not supported for the current order
        OrderRelatedPositionMissMatch: The related position was not found or the current order is on a different account than the position
        PriceExceedsAggressiveTolerance: The price exceeds the aggressive tolerance
        InvalidTraderId: Invalid TraderId - The TraderId does not conform to the formatting rules for TraderIds
        TraderIdIsRequired: The TraderId is required for this application
        AlgoOrderIllegalDurationType: The order duration type is not supported by the strategy
        AlgoOrderIllegalAssetType: The assettype is not supported by the strategy
        AlgoOrderMissingMandatoryParameter: One or more mandatory parameters are missing
        AlgoOrderErrorInParameterValue: One or more mandatory parameters are missing
        InvalidCurrencyPair: Invalid currency pair
        ExchangeRateNotAvailable: Exchange rate not available
        AllocationKeyNotFound: Allocation key not found
        AllocationKeyPercentDoesNotSumToOneHundred: Participation with Percentage distribution type should sum up to 100%
        FxSwapLegsValueDateRequired: Error code when near leg and far leg value dates are not set on FxSwap order.
        InvalidFxSwapLegsValueDate: Error code when near leg value date is greater than far leg value date.
        IllegalWatchlistId: Error code returned when the watch list cannot be found.
        InstrumentNotFoundOrNotAllowedForMarketTrades: Instrument not found or not allowed for market trades subscription.
        ExchangeNotSupported: Time and sales is not supported for this exchange.
        WarningAmountLargeOrderSize: Returned when a price request is for a an amount that is larger than will be automatically accepted. For IOC orders, this means that an order on that amount will always be rejected.
        InternalServerError: Internal Server Error.
    ErrorCode:
      title: Errorcode used in RFQ.
      enum:
      - DealerCancelsQuote
      - DealerCannotQuote
      - DealerCannotTrade
      - DealerDisconnected
      - DealerIsBusy
      - DealerIsUnavailable
      - DealerRejectsQuoteRequest
      - None
      - QuoteHasTimedOut
      - TooSmallTrade
      - WarningAmountLargeOrderSize
      - WarningAmountTooSmall
      type: string
      example: None
      x-enum-descriptions:
        None: No error code.
        DealerCancelsQuote: Dealer cancels quote.
        DealerCannotQuote: Dealer can not give quote at this time.
        DealerIsBusy: Dealer is handling other request for client.
        DealerIsUnavailable: Dealer is not available.
        DealerCannotTrade: Dealer can not trade at this time.
        DealerDisconnected: Dealer disconnected.
        TooSmallTrade: Trade contract size is too small
        QuoteHasTimedOut: Quote has timed out
        DealerRejectsQuoteRequest: Dealer rejects quote request.
        WarningAmountLargeOrderSize: Returned when a price request is for a an amount that is larger than will be automatically accepted. For IOC orders, this means that an order on that amount will always be rejected.
        WarningAmountTooSmall: Returned when an amount for an FXO is so small that we do not accept request for quotes on it.
  responses:
    ServiceUnavailable:
      description: Service Unavailable.
    Unauthorized:
      description: Indicates that the request was rejected because the 'Authorization' header was missing in the request or contained an invalid security token.
    TooManyRequests:
      description: The request was rejected due to rate limit being exceeded.
    BadRequest:
      description: One or more of the provided parameters are invalid.
      content:
        application/json:
          schema:
            required:
            - ErrorCode
            - Message
            type: object
            properties:
              ErrorCode:
                enum:
                - InvalidRequest
                type: string
                example: None
                x-enum-descriptions:
                  InvalidRequest: Default error code returned when it cannot be determined which part of the request is malformed.
              Message:
                type: string
              ModelState:
                $ref: '#/components/schemas/ModelStateDictionary'
  securitySchemes:
    OpenApiJWTSecurityScheme:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OpenApiOAuthSecurityScheme:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://sim.logonvalidation.net/authorize
          tokenUrl: https://sim.logonvalidation.net/token
          scopes: {}