This endpoint is designed to reduce the size of an existing order via the CVEX API. Unlike replacing an order with a new one, reducing an order allows it to maintain its position in the order book at the same price level. Only a decrease in order size is permitted with this method.

Required Request Headers:

  • X-Signature: The required digital signature of the request.

Body Parameters:

  • id: Numeric id or customer id of the order.
  • quantity_steps: The size of the order expressed in the smallest tradable increments, always an integer. Only one quantity parameter should be provided.
  • quantity_contracts: The size of the order in terms of contracts. Only one quantity parameter should be provided.
  • quantity_assets: The size of the order in units of the underlying asset. Only one quantity parameter should be provided.
  • timestamp : Time of request creation, required for all trading requests. In milliseconds.
  • recv_window: The number of milliseconds after timestamp the request is valid for.

Responses:

  • 200 OK: Successfully reduced order.
  • 404 Not Found: An order with provided id not found.

🚧

Undocumented

All possible API behavior is not documented yet.

Each request to this endpoint costs 1 API credits.

Language
Credentials
Header
Click Try It! to start a request and see the response here!