Skip to main content
POST
Replace order

Authorizations

X-Api-Key
string
header
default:sb_test_your_key
required

API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers.

Headers

Idempotency-Key
string
required

Unique key for this exact write intent. Store it before sending the request and reuse it for retries after timeouts or transient errors.

Path Parameters

order_id
string<uuid>
required

Public order ID returned by create or list order endpoints.

Body

application/json

Replacement values for the existing order. Use a new idempotency key for each distinct replacement intent.

Replacement values for an existing limit order.

client_order_id
string | null

New client order ID for the replacement

idempotency_key
string | null

Idempotency key for replace command

price
string | null

New price per unit

Example:

"1655.00"

quantity
string | null

New quantity (if None, use remaining unfilled quantity)

Example:

"150.00"

Response

Order replacement submitted

data
object
required

Result returned after a replace request is accepted for processing.

status
enum<string>
required
Available options:
success