Replace order

Replace an existing order. The user is resolved by the provided API key.

Note

Venue order id of the order will be updated as well.

Request

Order replacement details.

Path parameters
Path parameters

Unique identifier (UUID) of the venue order to replace.

Header parameters
Header parameters

Example: 1746007718237

Current timestamp in Unix epoch milliseconds. Used to prevent replay attacks and construct the signature. Provided with other authentication headers.

Example: "2h/t5o8w+l5s+fjyfA0n/e7j4u5b7h4e+g4k4c8h7a2p6k0g7j1f+w0i2j3k9r0l3s8m5t6r+q1s+o3v/t4x8v5y+w1r+m2t/k3w/j4y+"

The Ed25519 signature of the request. Provided with other authentication headers.

Tip

See Authentication headers: Signing a request for details on how to generate this.

Request body
Body object

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

Client-generated unique identifier for the replacement request, used to guarantee idempotency. Retries with the same value will not create duplicate replacements.

Example: "0.1"

New amount of base currency for the replacement order. If only the price is provided, without the quantity or amount, this parameter will stay the same for SELL orders and be recalculated for BUY orders.

Example: "0.1"

New amount of quote currency for the replacement order. If only the price is provided, without the quantity or amount, this parameter will stay the same for BUY orders and be recalculated for SELL orders.

Example: "50000.50"

New limit price for the replacement order. If omitted, the original order's price is preserved.

Possible values: [allow_taker, post_only]
Example:

[
"allow_taker"
]

Execution instructions applied to the replacement order, overriding those of the original. Pass an empty array [] to explicitly clear all instructions. If the field is omitted entirely, the original order's instructions are preserved.

Response

OK

The successfully replaced order details.

Response body
Body object

Wrapper object containing the order details.

ID of the order generated by the system.

Client order ID provided by the client.

Possible values: [pending_new, new, partially_filled, filled, cancelled, rejected, replaced]

Order state after submitting it.

Was this page helpful?