Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Query-String Unique key identifying the account used in retrieving the price. Only required when calling context represents an authenticated user.
    OptionRootId Int Query-String Id of the contract option root.
    OptionsStrategyType OptionsStrategyType Query-String The OptionsStrategyType to get.
  • Response Parameters

    View Response Codes
    Name Type Description
    Legs MultiLegOrderLeg [] List of suggested order legs for this option root and strategy.
    StrategyType OptionsStrategyType String identification
  • Request Example

    Request URL
    GET trade/v2/orders/multileg/defaults/?AccountKey={AccountKey}&OptionRootId={OptionRootId}&OptionsStrategyType={OptionsStrategyType}
    Request Body
    {
      "AccountKey": null,
      "OptionRootId": 311,
      "OptionsStrategyType": "Straddle"
    }
    
  • Response Example

    Response body
    {
      "Legs": [
        {
          "Amount": 10.0,
          "AssetType": "StockOption",
          "BuySell": "Buy",
          "OptionData": {
            "ExpiryDate": "2024-09-29T00:00:00",
            "PutCall": "Call",
            "StrikePrice": 53.5
          },
          "Uic": 13908745
        },
        {
          "Amount": 10.0,
          "AssetType": "StockOption",
          "BuySell": "Buy",
          "OptionData": {
            "ExpiryDate": "2024-09-29T00:00:00",
            "PutCall": "Put",
            "StrikePrice": 53.5
          },
          "Uic": 13908773
        }
      ],
      "StrategyType": "Straddle"
    }