For the complete documentation index, see llms.txt. This page is also available as Markdown.

Orders

Order management

Place a new order

post

Places a new order for the authenticated account.

Security

Requires both XApiKey (header) and Ed25519Sig (query) via the global security requirement. The signature is computed over the request query string (including timestamp and any other parameters you send).

Parameter Rules

  • LIMIT: requires quantity, or quoteOrderQty for BUY orders, plus price and timeInForce.

  • GTD: requires absolute expireTime in epoch milliseconds. Lambdaplex floors it to a whole epoch second and returns acceptedExpireTime.

  • GTC is a compatibility alias for GTD with the venue's previous default expiry. The ACK returns the canonical acceptedExpireTime.

  • POST_ONLY is the legacy GTC alias plus postOnly=true; new clients may instead send GTC or GTD with postOnly=true.

  • MARKET: requires quantity, or quoteOrderQty for BUY orders.

  • STOP_MARKET: requires quantity, or quoteOrderQty for BUY orders, plus stopPrice and stopComparison.

  • STOP_LIMIT: requires quantity, or quoteOrderQty for BUY orders, plus price, stopPrice, stopComparison, and either explicit GTD or a legacy GTC/POST_ONLY alias.

  • A successful postOnly=true ACK confirms durable order placement, not synchronous book admission. The serialized book command later either rests the full executable order without taking liquidity or declines it atomically; a decline is canceled asynchronously and appears on the user-data stream.

Examples (query-string style)

  • LIMIT BUY GTD: symbol=PLEX-HBAR&side=BUY&type=LIMIT&timeInForce=GTD&expireTime=1724952866123&quantity=1.5&price=0.01234567&newClientOrderId=myorder-001&timestamp=1724952745123

  • LIMIT BUY IOC: symbol=PLEX-HBAR&side=BUY&type=LIMIT&timeInForce=IOC&quantity=1.5&price=0.01234567&newClientOrderId=myorder-004&timestamp=1724952745123

  • LIMIT SELL FOK: symbol=PLEX-HBAR&side=SELL&type=LIMIT&timeInForce=FOK&quantity=250.0&price=0.01234567&newClientOrderId=myorder-005&timestamp=1724952745123

  • LIMIT BUY by quote budget FOK: symbol=PLEX-HBAR&side=BUY&type=LIMIT&timeInForce=FOK&quoteOrderQty=100.00&price=0.01234567&newClientOrderId=myorder-006&timestamp=1724952745123

  • LIMIT SELL POST_ONLY GTD: symbol=PLEX-HBAR&side=SELL&type=LIMIT&timeInForce=GTD&expireTime=1724952866123&postOnly=true&quantity=250.0&price=0.01234567&newClientOrderId=myorder-007&timestamp=1724952745123

  • MARKET SELL: symbol=PLEX-HBAR&side=SELL&type=MARKET&quantity=250.0&newClientOrderId=myorder-002&timestamp=1724952745123

  • STOP_LIMIT BUY: symbol=PLEX-HBAR&side=BUY&type=STOP_LIMIT&timeInForce=GTD&expireTime=1724952866123&quantity=100.0&price=0.01200000&stopPrice=0.01150000&newClientOrderId=myorder-003&timestamp=1724952745123&stopComparison=LE

Weight: 1

This endpoint also counts against your Order Count limit (API key based).

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired

API key identifier. For Ed25519 V2 operations, its exact header value is the second line of the canonical signing payload.

Query parameters
symbolstring · min: 3 · max: 33Required

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
sidestring · enumRequired

Order side

Possible values:
typestring · enumRequired

Supported order types. LIMIT supports GTC/GTD/IOC/FOK/POST_ONLY. STOP_LIMIT supports explicit GTD and the legacy GTC/POST_ONLY aliases. MARKET and STOP_MARKET require quantity and reject timeInForce. STOP_LIMIT additionally requires price, stopPrice, and stopComparison. STOP_MARKET additionally requires stopPrice and stopComparison.

Possible values:
timeInForcestring · enumOptional

Applied to LIMIT and STOP_LIMIT orders. Explicit GTD requires expireTime. GTC aliases to GTD with the venue default expiry; POST_ONLY is that alias plus postOnly=true. IOC and FOK are immediate LIMIT policies.

Possible values:
expireTimeinteger · int64Optional

Absolute match deadline in epoch milliseconds. Required for GTD; venue floors it to a whole epoch second.

Example: 1724952866123
postOnlybooleanOptional

Orthogonal instruction that prevents a GTD limit order, including the GTC compatibility alias, from taking liquidity

Default: false
quantitystringOptional

Base order quantity. Required unless quoteOrderQty is set for a BUY order

Example: 1.5
quoteOrderQtystringOptional

Quote-asset budget for BUY LIMIT, BUY MARKET, BUY STOP_LIMIT, and BUY STOP_MARKET orders.

Example: 100
pricestringOptional

Price for LIMIT and STOP_LIMIT orders.

Example: 1800
newClientOrderIdstring · min: 1 · max: 36Required

Required client-assigned ID used for idempotent retries (must be unique per user, max 36 chars)

Example: myorder-001Pattern: ^[A-Za-z0-9._-]{1,36}$
acceptedMaxTakerBpsstring · max: 9999Optional

Explicit maximum taker fee in basis points accepted for this order

stopPricestringOptional

Trigger price for STOP_MARKET and STOP_LIMIT orders. Compared against the order's active trigger source.

Example: 64000
stopComparisonstring · enumOptional

Comparison operator for stop trigger (GE = trigger when source price >= stopPrice; LE = trigger when source price <= stopPrice). Offchain bot/agent stops use last trade; contract-settlement stops use oracle index price.

Possible values:
Responses
200

Order accepted

application/json

Acknowledgement returned when an order is accepted

symbolstringOptional

Trading pair symbol

Example: PLEX-HBAR
orderIdstringOptional

Exchange-assigned order ID

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
clientOrderIdstring · max: 36Optional

Client-supplied order ID used for idempotent placement retries (max 36 chars)

Example: myOrder-001
transactTimeinteger · int64Optional

Acceptance time (ms since epoch)

Example: 1724952746123
acceptedExpireTimeinteger · int64Optional

Venue-normalized whole-second match deadline for GTD orders (ms since epoch)

Example: 1724952866000
post/api/v1/order

Cancel an existing order

delete

Deletes an existing order for the authenticated account.

Security

Requires both XApiKey (header) and Ed25519Sig (query) via the global security requirement. The signature is computed over the request query string (including timestamp and any other parameters you send).

Weight: 1

This endpoint also counts against your Order Count limit (API key based).

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired

API key identifier. For Ed25519 V2 operations, its exact header value is the second line of the canonical signing payload.

Query parameters
symbolstring · min: 3 · max: 33Required

Trading pair symbol

Example: PLEX-HBARPattern: ^[A-Z0-9_]+-[A-Z0-9_]+$
orderIdstring · uuidOptional

Server-assigned order ID (if combined with origClientOrderId, must refer to same order)

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
origClientOrderIdstring · min: 1 · max: 36Optional

Original client-assigned order ID (optional if orderId is set, max 36 chars)

Example: myorder-001Pattern: ^[A-Za-z0-9._-]{1,36}$
Responses
200

Order canceled

application/json

Acknowledgement returned when an order is canceled

symbolstringOptional

Trading pair symbol

Example: PLEX-HBAR
origClientOrderIdstring · max: 36Optional

Original client-supplied order ID (if any, max 36 chars)

Example: myOrder-001
orderIdstringOptional

Exchange-assigned order ID

Example: 26a911ff-f546-eaaf-4b22-e57657b57571
transactTimeinteger · int64Optional

Cancel time (ms since epoch)

Example: 1724952746123
pricenumberOptional

Price for LIMIT/*_LIMIT orders; null for MARKET/STOP orders

Example: 0.01234567
origQtynumberOptional

Original order quantity (base asset)

Example: 100
executedQtynumberOptional

Executed quantity (base asset)

Example: 25
cumulativeQuoteQtynumberOptional

Cumulative quote quantity (quote asset)

Example: 0.30864175
statusstring · enumOptional

Canceled order status

Example: CANCELEDPossible values:
timeInForcestring · enumOptional

Time in force for LIMIT/*_LIMIT orders; null otherwise

Example: GTCPossible values:
typestring · enumOptional

Order type

Example: LIMITPossible values:
sidestring · enumOptional

Order side

Example: BUYPossible values:
delete/api/v1/order

Preview the fee regime for a market order

get

Returns an advisory fee preview. Placement independently prices the order under the user's accepted maximum taker BPS.

Weight: 1

Authorizations
signaturestringRequired

Ed25519 signature of payload

X-API-KEYstringRequired

API key identifier. For Ed25519 V2 operations, its exact header value is the second line of the canonical signing payload.

Query parameters
symbolstringRequired
sidestring · enumRequired

Order side

Possible values:
quantitynumberOptional
quoteOrderQtynumberOptional
acceptedMaxTakerBpsinteger · int32Optional
Responses
200

OK

application/json
symbolstringOptional
fillednumberOptional
exchangednumberOptional
vwapnumberOptional
slippagenumberOptional
get/api/v1/order/fee-quote

Last updated