Skip to content

Modify Order

POST
/orders/modify

Modifies an existing order. Currently only modifying whole quantity orders is supported. Fractional and notional orders must be canceled and replaced with a new order in 2 transactions.

Parameters

Header Parameters

X-API-KEY*
Type
string
Required

Request Body

application/json
JSON
{
  
"account_number": "MOCK_OMNI",
  
"replacement_order_id": "mod_clordid1",
  
"orig_order_id": "clordid1",
  
"execution_instruction": "held",
  
"order_type": "limit",
  
"price": "11",
  
"quantity": "5"
}

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