Saxo Bank Balances API

openapi: 3.2.0
info:
  title: Services.AutoTrading Account Values Balances 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: Balances
  description: "Read-only endpoint serving client and account balances. The client or account balance is identified by the supplied ClientKey, AccountGroupKey or AccountKey. \n            Access to balance data is further restricted by the access rights of the identity represented by the authorization token."
paths:
  /port/v1/balances/subscriptions/{ContextId}/{ReferenceId}:
    delete:
      tags:
      - Balances
      summary: Remove subscription
      description: Removes subscription for the current session identified by subscription id.
      operationId: BalancesV1DeleteSubscription
      parameters:
      - name: ContextId
        in: path
        description: Unique streaming context ID part of the streaming session.
        required: true
        schema:
          type: string
        example: '29931122'
      - name: ReferenceId
        in: path
        description: Unique ID of the subscription
        required: true
        schema:
          type: string
        example: B345356
      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
  /port/v1/balances/subscriptions/{ContextId}:
    delete:
      tags:
      - Balances
      summary: Remove all subscriptions marked with a specific tag
      description: Removes multiple subscriptions for the current session on this resource and frees all resources on the server.
      operationId: BalancesV1DeleteSubscriptions
      parameters:
      - name: ContextId
        in: path
        description: Unique streaming context ID part of the streaming session.
        required: true
        schema:
          type: string
        example: '29931122'
      - name: Tag
        in: query
        description: Tag that subscriptions are marked with.
        schema:
          type: string
        example: PAGE1
      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
  /port/v1/balances/subscriptions:
    post:
      tags:
      - Balances
      summary: Create a subscription on a balance
      description: Sets up a subscription and returns an initial snapshot of a balance.
      operationId: BalancesV1AddActiveSubscription
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BalanceSubscriptionRequest'
            example:
              Arguments:
                AccountGroupKey: null
                AccountKey: null
                ClientKey: 7m4I|vtYLUnEGg77o9uQhw==
              ContextId: '20221030064906306'
              ReferenceId: B49083
              RefreshRate: 500
              Tag: MyBalancesRelatedSubscriptions
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceSubscriptionResponse'
              example:
                ContextId: '20221030064906306'
                Format: application/json
                InactivityTimeout: 1500
                ReferenceId: B49083
                RefreshRate: 500
                Snapshot:
                  CalculationReliability: Ok
                  CashAvailableForTrading: 100573853.73
                  CashBalance: 100573853.73
                  CashBlocked: 0
                  ChangesScheduled: false
                  ClosedPositionsCount: 0
                  CollateralAvailable: 99839075.64
                  CorporateActionUnrealizedAmounts: 0
                  CostToClosePositions: -1677.57
                  Currency: EUR
                  CurrencyDecimals: 0
                  InitialMargin:
                    CollateralAvailable: 12254541.55
                    MarginAvailable: 12254541.55
                    MarginCollateralNotAvailable: 0
                    MarginUsedByCurrentPositions: -1225544.66
                    MarginUtilizationPct: 15.11
                    NetEquityForMargin: 1222521.77
                    OtherCollateralDeduction: 0
                  IntradayMarginDiscount: 0
                  IsPortfolioMarginModelSimple: true
                  MarginAndCollateralUtilizationPct: 0.38
                  MarginAvailableForTrading: 99839075.64
                  MarginCollateralNotAvailable: -468419.84
                  MarginExposureCoveragePct: 344.35
                  MarginNetExposure: 29088391.02
                  MarginUsedByCurrentPositions: -326828.87
                  MarginUtilizationPct: 0.33
                  NetEquityForMargin: 85539075.64
                  NetPositionsCount: 0
                  NonMarginPositionsValue: 509207.41
                  OpenIpoOrdersCount: 0
                  OpenPositionsCount: 0
                  OptionPremiumsMarketValue: 0
                  OrdersCount: 0
                  OtherCollateral: 103798.26
                  SettlementValue: 0
                  ShareSpendingPower: 50
                  SpendingPower: 50
                  SpendingPowerDetail:
                    Current: 50
                    Maximum: 50
                  SrdSpendingPower: 50
                  TotalValue: 100634324.36
                  TransactionsNotBooked: -118.71
                  TriggerOrdersCount: 0
                  UnrealizedMarginClosedProfitLoss: 0
                  UnrealizedMarginOpenProfitLoss: 0
                  UnrealizedMarginProfitLoss: -550738.76
                  UnrealizedPositionsValue: -43208.92
                State: Active
                Tag: MyBalancesRelatedSubscriptions
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidClientId
                    - InvalidInput
                    - InvalidModelState
                    - NoValidInput
                    - UnsupportedSubscriptionFormat
                    type: string
                    example: None
                    x-enum-descriptions:
                      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.
                      InvalidClientId: Indicates that the requested client id was invalid.
                      InvalidInput: An error was encountered when processing given input parameters.
                      NoValidInput: No valid input values passed.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - SubscriptionLimitExceeded
                    type: string
                    example: None
                    x-enum-descriptions:
                      SubscriptionLimitExceeded: Error code returned when more than the maximum allowed number of subscriptions for a specified type, is exceeded.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Subscribe
        community: Subscribe
      x-streaming-type:
        $ref: '#/components/schemas/BalanceResponse'
  /port/v1/balances/marginoverview:
    get:
      tags:
      - Balances
      summary: Get margin overview
      description: Get margin overview for a client, account group or an account
      operationId: BalancesV1GetMarginOverview
      parameters:
      - name: AccountGroupKey
        in: query
        description: The key of the account group for which the margin overview is returned
        schema:
          title: The key of the account group for which the margin overview is returned
          minLength: 1
          type: string
          x-type-name: AccountGroupKey
        example: stringValue
      - name: AccountKey
        in: query
        description: The key of the account for which the margin overview is returned
        schema:
          title: The key of the account for which the margin overview is returned
          minLength: 1
          type: string
          x-type-name: AccountKey
        example: 01b64edf-da03-4145-bf33-ae21527d4c86
      - name: ClientKey
        in: query
        description: The key of the client for which the margin overview is returned
        required: true
        schema:
          title: The key of the client for which the margin overview is returned
          minLength: 1
          type: string
          x-type-name: ClientKey
        example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarginOverviewByGroup'
              example:
                Groups:
                - Contributors:
                  - AssetTypes:
                    - FxSpot
                    InstrumentDescription: EURUSD description
                    InstrumentSpecifier: EURUSD
                    Margin: 1235
                    Uic: 21
                  - AssetTypes:
                    - FxSpot
                    InstrumentDescription: GBPUSD description
                    InstrumentSpecifier: GBPUSD
                    Margin: 789
                    Uic: 22
                  GroupType: FX
                  TotalMargin: 100000
                - Contributors:
                  - AssetTypes:
                    - CfdOnIndex
                    InstrumentDescription: SP500 description
                    InstrumentSpecifier: SP500.I
                    Margin: 4321
                    Uic: 4910
                  - AssetTypes:
                    - CfdOnIndex
                    InstrumentDescription: CSE20 description
                    InstrumentSpecifier: CSE20.I
                    Margin: 975
                    Uic: 5768
                  - AssetTypes:
                    - CfdOnIndex
                    InstrumentDescription: DAX description
                    InstrumentSpecifier: DAX.I
                    Margin: 864
                    Uic: 27098
                  GroupType: CFDs
                  TotalMargin: 200000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidClientId
                    - NoValidInput
                    type: string
                    example: None
                    x-enum-descriptions:
                      NoValidInput: No valid input values passed.
                      InvalidClientId: Indicates that the requested client id was invalid.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Read
        community: Read
  /port/v1/balances:
    get:
      tags:
      - Balances
      summary: Get balance
      description: Get balance data for a client, account group or an account
      operationId: GET_BalancesV1GetBalance
      parameters:
      - name: AccountGroupKey
        in: query
        description: The key of the account group for which the balance data is returned
        schema:
          title: The key of the account group for which the balance data is returned
          minLength: 1
          type: string
          x-type-name: AccountGroupKey
        example: stringValue
      - name: AccountKey
        in: query
        description: The key of the account for which the balance data is returned
        schema:
          title: The key of the account for which the balance data is returned
          minLength: 1
          type: string
          x-type-name: AccountKey
        example: 01b64edf-da03-4145-bf33-ae21527d4c86
      - name: ClientKey
        in: query
        description: The key of the client for which the balance data is returned
        required: true
        schema:
          title: The key of the client for which the balance data is returned
          minLength: 1
          type: string
          x-type-name: ClientKey
        example: 493b43a5-fe85-4d1f-9071-dd4a9d4e42a4
      - name: FieldGroups
        in: query
        description: Specifies which data to return.
        schema:
          title: Specifies which data to return.
          type: array
          items:
            $ref: '#/components/schemas/BalanceFieldGroup'
        example:
        - MarginOverview
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
              example:
                CalculationReliability: Ok
                CashAvailableForTrading: 100573853.73
                CashBalance: 100573853.73
                CashBlocked: 0
                ChangesScheduled: false
                ClosedPositionsCount: 0
                CollateralAvailable: 99839075.64
                CorporateActionUnrealizedAmounts: 0
                CostToClosePositions: -1677.57
                Currency: EUR
                CurrencyDecimals: 0
                InitialMargin:
                  CollateralAvailable: 12254541.55
                  MarginAvailable: 12254541.55
                  MarginCollateralNotAvailable: 0
                  MarginUsedByCurrentPositions: -1225544.66
                  MarginUtilizationPct: 15.11
                  NetEquityForMargin: 1222521.77
                  OtherCollateralDeduction: 0
                IntradayMarginDiscount: 0
                IsPortfolioMarginModelSimple: true
                MarginAndCollateralUtilizationPct: 0.38
                MarginAvailableForTrading: 99839075.64
                MarginCollateralNotAvailable: -468419.84
                MarginExposureCoveragePct: 344.35
                MarginNetExposure: 29088391.02
                MarginUsedByCurrentPositions: -326828.87
                MarginUtilizationPct: 0.33
                NetEquityForMargin: 85539075.64
                NetPositionsCount: 0
                NonMarginPositionsValue: 509207.41
                OpenIpoOrdersCount: 0
                OpenPositionsCount: 0
                OptionPremiumsMarketValue: 0
                OrdersCount: 0
                OtherCollateral: 103798.26
                SettlementValue: 0
                SpendingPowerDetail:
                  Current: 50
                  Maximum: 50
                TotalValue: 100634324.36
                TransactionsNotBooked: -118.71
                TriggerOrdersCount: 0
                UnrealizedMarginClosedProfitLoss: 0
                UnrealizedMarginOpenProfitLoss: 0
                UnrealizedMarginProfitLoss: -550738.76
                UnrealizedPositionsValue: -43208.92
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                required:
                - ErrorCode
                - Message
                type: object
                properties:
                  ErrorCode:
                    enum:
                    - InvalidClientId
                    - NoValidInput
                    type: string
                    example: None
                    x-enum-descriptions:
                      NoValidInput: No valid input values passed.
                      InvalidClientId: Indicates that the requested client id was invalid.
                  Message:
                    type: string
                  ModelState:
                    $ref: '#/components/schemas/ModelStateDictionary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
      - OpenApiOAuthSecurityScheme: []
      - OpenApiJWTSecurityScheme: []
      x-required-permissions:
        personal: Read
        community: Read
  /port/v1/balances/me:
    get:
      tags:
      - Balances
      summary: Get balance data for logged-in client
      description: Get balance data for logged-in client.
      operationId: BalancesV1GetBalance
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
              example:
                CalculationReliability: Ok
                CashAvailableForTrading: 100573853.73
                CashBalance: 100573853.73
                CashBlocked: 0
                ChangesScheduled: false
                ClosedPositionsCount: 0
                CollateralAvailable: 99839075.64
                CorporateActionUnrealizedAmounts: 0
                CostToClosePositions: -1677.57
                Currency: EUR
                CurrencyDecimals: 0
                InitialMargin:
                  CollateralAvailable: 12254541.55
                  MarginAvailable: 12254541.55
                  MarginCollateralNotAvailable: 0
                  MarginUsedByCurrentPositions: -1225544.66
                  MarginUtilizationPct: 15.11
                  NetEquityForMargin: 1222521.77
                  OtherCollateralDeduction: 0
                IntradayMarginDiscount: 0
                IsPortfolioMarginModelSimple: true
                MarginAndCollateralUtilizationPct: 0.38
                MarginAvailableForTrading: 99839075.64
                MarginCollateralNotAvailable: -468419.84
                MarginExposureCoveragePct: 344.35
                MarginNetExposure: 29088391.02
                MarginUsedByCurrentPositions: -326828.87
                MarginUtilizationPct: 0.33
                NetEquityForMargin: 85539075.64
                NetPositionsCount: 0
                NonMarginPositionsValue: 509207.41
                OpenIpoOrdersCount: 0
                OpenPositionsCount: 0
                OptionPremiumsMarketValue: 0
                OrdersCount: 0
                OtherCollateral: 103798.26
                SettlementValue: 0
                SpendingPowerDetail:
                  Current: 50
                  Maximum: 50
                TotalValue: 100634324.36
                TransactionsNotBooked: -118.71
                TriggerOrdersCount: 0
                UnrealizedMarginClosedProfitLoss: 0
                UnrealizedMarginOpenProfitLoss: 0
                UnrealizedMarginProfitLoss: -550738.76
                UnrealizedPositionsValue: -43208.92
        '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: Read
        community: Read
components:
  responses:
    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'
    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.
    ServiceUnavailable:
      description: Service Unavailable.
  schemas:
    BalanceFieldGroup:
      title: Specification of fieldsets to include in results.
      enum:
      - CalculateCashForTrading
      - MarginOverview
      type: string
      example: CalculateCashForTrading
      x-enum-descriptions:
        MarginOverview: Include instrument margin utilization for positions on a client, account group or an account.
        CalculateCashForTrading: Calculates cash available for trading from all accounts.
      x-type-warning: FlaggableEnum
    InstrumentCollateralDetail:
      title: Instrument collateral detail
      type: object
      properties:
        AssetType:
          title: Instrument Asset type
          allOf:
          - $ref: '#/components/schemas/AssetType'
        Description:
          title: Instrument Description
          type: string
          example: stringValue
        InitialCollateral:
          title: Initial collateral available of the instrument
          type: number
          example: 10
        InitialCollateralNotAvailable:
          title: Initial collateral not available of the instrument
          type: number
          example: 10
        MaintenanceCollateral:
          title: Maintenance collateral available of the instrument
          type: number
          example: 10
        MaintenanceCollateralNotAvailable:
          title: Maintenance collateral not available of the instrument
          type: number
          example: 10
        MarketValue:
          title: Market value of the instrument
          type: number
          example: 10
        Symbol:
          title: Instrument Symbol
          type: string
          example: stringValue
        Uic:
          title: Uic of the instrument
          type: integer
          format: int32
          example: 99
      additionalProperties: false
      example:
        AssetType: PortfolioNote
        Description: stringValue
        InitialCollateral: 10
        InitialCollateralNotAvailable: 10
        MaintenanceCollateral: 10
        MaintenanceCollateralNotAvailable: 10
        MarketValue: 10
        Symbol: stringValue
        Uic: 99
    InitialMarginResponse:
      title: The calculation entity's initial margin (purchasing power) status.
      type: object
      properties:
        CollateralAvailable:
          title: Sum of collateral from positions, cash, collateral credit and other holdings available for opening new positions.
          type: number
          example: 10
        MarginAvailable:
          title: Margin available for opening new positions. Initial margin available.
          type: number
          example: 10
        MarginUsedByCurrentPositions:
          title: Sum of initial margin currently reserved.
          type: number
          example: 10
        MarginUtilizationPct:
          title: Level of margin already utilized in percent. I.e. the ratio between the margin collateral used and the total available margin collateral. Indicates distance to margin calls.
          type: number
          example: 10
        NetEquityForMargin:
          title: Value used as basis to calculate initial margin available.
          type: number
          example: 10
        OtherCollateralDeduction:
          title: Other Collateral Deduction derived from regulatory contributors margin value.
          type: number
          example: 10
      additionalProperties: false
      example:
        CollateralAvailable: 10
        MarginAvailable: 10
        MarginUsedByCurrentPositions: 10
        MarginUtilizationPct: 10
        NetEquityForMargin: 10
        OtherCollateralDeduction: 10
    MarginOverviewContributor:
      title: Total margin impact by net position.
      type: object
      properties:
        AssetTypes:
          title: AssetTypes for this contributor.
          type: array
          items:
            $ref: '#/components/schemas/AssetType'
          example:
          - FxVanillaOption
        DisplayHint:
          title: Hint to the client application about how it should display the instrument.
          allOf:
          - $ref: '#/components/schemas/DisplayHintType'
        InstrumentDescription:
          title: Description of instrument. Not available for futures.
          type: string
          example: stringValue
        InstrumentSpecifier:
          title: Instrument identifier. Base contract for futures and symbol for other instruments.
          type: string
          example: stringValue
        Margin:
          title: Margin impact of the contributor
          type: number
          example: 10
        Uic:
          title: Uic identifying the instrument, if any
          type: integer
          format: int32
          example: 99
      additionalProperties: false
      example:
        AssetTypes:
        - FxSpot
        InstrumentDescription: EURUSD description
        InstrumentSpecifier: EURUSD
        Margin: 1235
        Uic: 21
    LineStatus:
      title: Describes the current utilization and size of a Credit, Risk or Trading line.
      type: object
      properties:
        Exposure:
          title: The current utilization of the credit line.
          type: number
          example: 10
        Line:
          title: The maximum credit limit allowed.
          type: number
          example: 10
        UtilizationPct:
          title: The current utilization of the credit line in proportion to the line limit.
          type: number
          example: 10
      additionalProperties: false
      example:
        Exposure: 10
        Line: 10
        UtilizationPct: 10
    MarginCollateralNotAvailableDetail:
      title: Detail of Margin Collateral Not Available
      type: object
      properties:
        InitialFxHaircut:
          title: Initial Fx Haircut
          type: number
          example: 10
        InstrumentCollateralDetails:
          title: Instrument collateral collection
          type: array
          items:
            $ref: '#/components/schemas/InstrumentCollateralDetail'
          example:
          - AssetType: GuaranteeNote
            Description: stringValue
            InitialCollateral: 10
            InitialCollateralNotAvailable: 10
            MaintenanceCollateral: 10
            MaintenanceCollateralNotAvailable: 10
            MarketValue: 10
            Symbol: stringValue
            Uic: 99
        MaintenanceFxHaircut:
          title: Maintenance Fx Haircut
          type: number
          example: 10
      additionalProperties: false
      example:
        InitialFxHaircut: 10
        InstrumentCollateralDetails:
        - AssetType: CompanyWarrant
          Description: stringValue
          InitialCollateral: 10
          InitialCollateralNotAvailable: 10
          MaintenanceCollateral: 10
          MaintenanceCollateralNotAvailable: 10
          MarketValue: 10
          Symbol: stringValue
          Uic: 99
        MaintenanceFxHaircut: 10
    BalanceSubscriptionResponse:
      title: Public response contract returned after setting up a subscription on accounts.
      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/BalanceResponse'
        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: '20221030064906306'
        Format: application/json
        InactivityTimeout: 1500
        ReferenceId: B49083
        RefreshRate: 500
        Snapshot:
          CalculationReliability: Ok
          CashAvailableForTrading: 100573853.73
          CashBalance: 100573853.73
          CashBlocked: 0
          ChangesScheduled: false
          ClosedPositionsCount: 0
          CollateralAvailable: 99839075.64
          CorporateActionUnrealizedAmounts: 0
          CostToClosePositions: -1677.57
          Currency: EUR
          CurrencyDecimals: 0
          InitialMargin:
            CollateralAvailable: 12254541.55
            MarginAvailable: 12254541.55
            MarginCollateralNotAvailable: 0
            MarginUsedByCurrentPositions: -1225544.66
            Ma

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