Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Body Unique key identifying the account to place the order on.
    ExternalReference String Body Optional reference from the client app, to correlate orders with Saxo Bank issues order IDs. Maximum length: 50 characters. The order will be rejected if the reference is too long. This reference doesn’t have to be unique.
    FieldGroups PreCheckOrderSpec [] Body Specification of fields to return in results
    Legs OrderLeg [] Body List of orders in the batch that are to be filled symmetrically.
    ManualOrder Boolean Body Optional indicator for whether order is placed automatically or manually.
    OrderDuration OrderDuration Body The Order Duration.
    OrderPrice Number Body Order Price. Optional for market orders.
    OrderType PlaceableOrderType Body Order type.
    TraderId String Body Trader Id, Used only if the application is configured for supporting it with length of 2-16 chars.

  • Response Parameters

    View Response Codes
    Name Type Description
    Cost CostData Expected cost of executing the order.
    CostInAccountCurrency CostData Expected cost of executing the order in account currency.
    ErrorInfo StringErrorResponse Contains error info when order pre-check has failed.
    EstimatedCashRequired Number Estimated cash required.
    EstimatedCashRequiredCurrency String Estimated cash required currency.
    EstimatedTotalCost Number Expected total cost of executing the order in instrument currency.
    EstimatedTotalCostInAccountCurrency Number Estimated total cost currency.
    ExternalReference String Optional reference supplied when placing the order. Max. 50 characters.
    InstrumentToAccountConversionRate Number Rate used to convert from instrument currency to the account currency.
    MarginImpactBuySell MarginImpactBuySell Expected Margin Impact, including initial, maintenance and currency.
    Orders IPreCheckOrderResponse [] List of resulting orders.
    PreCheckResult String Overall operation result.
    PreTradeDisclaimers PreTradeDisclaimers Represent pre trades disclaimers not accepted by user.

  • Request Example

    Request URL
    POST /trade/v2/orders/multileg/precheck
    Request Body
    {
  "FieldGroups": [
    "Costs"
  ],
  "AccountKey": "01b64edf-da03-4145-bf33-ae21527d4c86",
  "OrderPrice": 10,
  "OrderType": "StopLimit",
  "OrderDuration": {
    "DurationType": "GoodTillDate",
    "ExpirationDateTime": "2024-05-04T14:00:00Z",
    "ExpirationDateContainsTime": true
  },
  "ManualOrder": true,
  "TraderId": "stringValue",
  "Legs": [
    {
      "Uic": 99,
      "Amount": 10,
      "BuySell": "Sell",
      "AssetType": "CfdOnStock",
      "ToOpenClose": "Undefined"
    }
  ],
  "ExternalReference": "stringValue"
}

  • Response Example

    Response body
    {
  "PreCheckResult": "Ok",
  "EstimatedCashRequired": 1500000,
  "EstimatedCashRequiredCurrency": "EUR",
  "MarginImpactBuySell": {
    "InitialMarginBuy": 12,
    "InitialMarginAvailableCurrent": 10470,
    "InitialMarginAvailableBuy": 10447,
    "MaintenanceMarginBuy": 11,
    "Currency": "USD"
  },
  "Cost": {
    "Commission": 1000,
    "ExchangeFee": 0,
    "StampDuty": 0,
    "GuaranteedStopFee": 0
  },
  "EstimatedTotalCost": 1500000,
  "EstimatedTotalCostInAccountCurrency": 1500000,
  "InstrumentToAccountConversionRate": 1
}