Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Route The account key to lookup the conditions for
    FieldGroups ScheduledTradingConditionsFieldGroup [] Query-String Specify which field groups to return
    OptionRootId Int Route The optionRootId for the option to lookup
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountCurrency String Currency of the selected account, used when listing currency conversion fees for the selected instrument back to the account currency.
    AssetType AssetType Asset Type
    CarryingCost CarryingCost For instruments where carrying costs are applied (futures, Exchange traded options) , the percentage markup on the intebank interest rate applied for holding the position.
    CommissionLimits CommissionLimit [] The commission structure for the selected instrument.
    CurrencyConversion CurrencyConversion The currency conversion.
    CurrencyCutSpreadRate Obsolete Decimal Use CurrencyConversion instead. This field will be removed from October 2022.
    CurrentSpread Decimal Current spread.
    ExchangeFeeRules ExchangeFeeRules [] Exchange fee rules if applied separately.
    ExerciseCutOffTime TimeSpan The last time the option can be traded.
    ExpirationTime TimeSpan The last time on the expiry date the option can be traded.
    ExposureLimits Exposure [] The maximum allowed exposure to the instrument.
    FinanceInterestMarkUp Decimal Finance interest markup.
    HoldingFee HoldingFee Holding fee if applied.
    InstrumentCurrency String Instrument Currency.
    IsTradable Bool Indicates whether the instrument is currently tradable.
    LoanInterestCharge Decimal Interest Charged when MarginLending is used
    MarginRequirement ContractOptionRootMarginRequirement The margin requirement for the contract option
    PortfolioBasedMargin PortfolioBasedMargin Portfolio based margin
    Rating Decimal Risk Rating.
    ScheduledContractOptionTradingConditions ScheduledContractOptionTradingCondition [] Scheduled Trading Conditions for Contract Options
    SettlementStyle SettlementStyle An option is either cash settled or settled with a position in the underlying asset. This value indicates what the behavior of the specific option is.
    SwapInterestMarkUp Decimal Swap interest markup
    Taxes Tax [] (Requires License) List of taxes applied.
    Uic Int Instrument unique identifier
  • Request Example

    Request URL
    GET cs/v1/tradingconditions/ContractOptionSpaces/7m4I|vtYLUnEGg77o9uQhw==/32/?FieldGroups=ScheduledTradingConditions
  • Response Example

    Response body
    {
      "AccountCurrency": "GBP",
      "AssetType": "FxSpot",
      "CarryingCost": {
        "FixedRate": 1.0,
        "InterbankRate": {
          "AskRate": 2.0,
          "BidRate": 1.0,
          "TradeDate": "2022-08-12"
        },
        "MarkUpRate": 1.5
      },
      "CommissionLimits": [
        {
          "Currency": "USD",
          "OrderAction": "ExecuteOrder",
          "PerUnitRate": 6.0
        }
      ],
      "CurrencyCutSpreadRate": 0.5,
      "ExerciseCutoffTime": "2022-08-17T18:16:17.816226Z",
      "ExerciseCutOffTime": "16:30:00",
      "ExpirationTime": "14:30:00",
      "ExpiryTime": "2022-08-18T18:16:17.816226Z",
      "ExposureLimits": [
        {
          "Identifier": "CL",
          "Level": "BaseContractNet",
          "RuleType": "Amount",
          "Value": 200.0
        }
      ],
      "FinanceInterestMarkUp": 9.99,
      "HoldingFee": {
        "FromPeriodInDays": 120,
        "Value": 1.6
      },
      "InstrumentCurrency": "USD",
      "IsTradable": true,
      "MarginRequirement": {
        "MinimumUnderlyingValue": 0.5,
        "Premium": 1.0,
        "TradingProfile": "Basic",
        "UnderlyingValueOvernightExposure": 1.0
      },
      "PortfolioBasedMargin": {
        "ExtremeStressFactor": 15.6,
        "Initial": 185.5,
        "IntraWeek": 8.7,
        "LiquidityThresholdAmount": 569987.0,
        "LiquidityThresholdCurrency": "USD",
        "VolatilityAddOn": 1000.68,
        "VolatilityStress": 100.0
      },
      "Rating": 5.0,
      "SettlementStyle": "PhysicalDelivery",
      "SwapInterestMarkUp": 1.11,
      "Taxes": [
        {
          "BuySell": "Buy",
          "CalculationTriggerType": "Normal",
          "CalculationType": "ValueFraction",
          "Description": "UK Stamp Duty",
          "Value": 0.5
        }
      ],
      "Uic": 0
    }