Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
orders

Decrease Order (V2)

Endpoint for decreasing the remaining count of an existing event-market order using the V2 request/response shape. Exactly one of reduce_by or reduce_to must be provided.

post/portfolio/events/orders/{order_id}/decrease

Path parameters

order_idstring required

Order ID

Query parameters

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). Defaults to 0.

Request body

reduce_bystring

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

reduce_tostring

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

exchange_indexinteger

Identifier for an exchange shard. Defaults to 0 if unspecified.

market_tickerstring

Market ticker. Required when exchange_index is -1 (auto).

Example request

{
  "reduce_by": "2.00",
  "exchange_index": 0
}

Response

Order decreased successfully

order_idstring required
client_order_idstring
remaining_countstring required

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

ts_msinteger required

Matching engine timestamp at which the decrease was processed, as Unix epoch milliseconds.

Example response

{
  "order_id": "3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d",
  "client_order_id": "8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1",
  "remaining_count": "8.00",
  "ts_ms": 1715793680789
}