Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountKey AccountKey Body Unique key identifying the account.
    MultiLegAmount Number Body New number of strategies to trade. Will adjust all order leg amounts maintaining thier original ratio. Changing the original leg ratio would change the basis for OrderPrice, so that cannot be changed.
    MultiLegOrderId String Body Id of multi-leg combination/strategy order to change.
    OrderDuration OrderDuration Body The Order Duration.
    OrderPrice Number Body Order price. The sum price of a single strategy of order legs in a given ratio.
    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
    ErrorInfo StringErrorResponse Contains error info when request failed.
    ExternalReference String Optional reference supplied when placing the order. Max. 50 characters.
    OrderId String Id of order. No value provided if request failed.
    Orders RelatedOrOcoOrder [] List of resulting orders.
  • Request Example

    Request URL
    PATCH /trade/v2/orders/multileg
    Request Body
    {
      "AccountKey": "01b64edf-da03-4145-bf33-ae21527d4c86",
      "MultiLegOrderId": "stringValue",
      "MultiLegAmount": 10,
      "OrderPrice": 10,
      "TraderId": "stringValue",
      "OrderDuration": {
        "DurationType": "GoodTillDate",
        "ExpirationDateTime": "2024-08-02T14:00:00Z",
        "ExpirationDateContainsTime": true
      }
    }
    
  • Response Example

    Response body
    {
      "OrderId": "67762872",
      "Orders": [
        {
          "OrderId": "67762872"
        }
      ]
    }