Skip to content

Modify Multileg Order

POST
/orders/modify-multileg

Modify multileg order.

Parameters

Header Parameters

X-API-KEY*
Type
string
Required

Request Body

application/json
JSON
{
  
"account_number": "MOCK_OMNI",
  
"execution_instruction": "held",
  
"orig_order_id": "clordid1",
  
"replacement_order_id": "clordid2",
  
"order_type": "limit",
  
"price": "10",
  
"quantity": "1",
  
"time_in_force": "day",
  
"legs": [
  
  
{
  
  
  
"symbol": "AAPL",
  
  
  
"side": "buy",
  
  
  
"position_effect": "open",
  
  
  
"ratio": "1",
  
  
  
"ref_id": "1",
  
  
  
"expiration_date": "20251219",
  
  
  
"strike_price": "150",
  
  
  
"cfi_code": "OC"
  
  
},
  
  
{
  
  
  
"symbol": "AAPL",
  
  
  
"side": "buy",
  
  
  
"position_effect": "open",
  
  
  
"ratio": "1",
  
  
  
"ref_id": "2",
  
  
  
"expiration_date": "20251219",
  
  
  
"strike_price": "150",
  
  
  
"cfi_code": "OP"
  
  
}
  
]
}

Responses

Returns the new replacement order, similar to new order response.

application/json
JSON
{
  
"av_replacement_order_id": "7c2e9605-c53f-4e3a-8bf0-9f82cab05734",
  
"replacement_order_id": "mod_clordid1"
}

Playground

Headers
Body

Samples

Powered by VitePress OpenAPI