List your outstanding orders
/dex/ordersapi_keyEvery order owned by this wallet that has not yet filled or been cancelled, including orders whose placement is unconfirmed. An order leaves the list once the transaction filling or cancelling it confirms. Unconfirmed placements first, then newest first.
Responses
200Outstanding orders owned by this walletLDOrderList▶
▶
ordersLDOrder[]requiredboxIdstringrequiredOrder box id. Pass it to
POST /dex/orders/{boxId}/cancel.typestringrequiredone ofSWAPDEPOSITREDEEMstatusstringrequiredPENDING: the placement is unconfirmed. OPEN: placed and waiting for a fill. FILLING: an unconfirmed transaction fills it. CANCELLING: an unconfirmed transaction cancels it. Only PENDING and OPEN orders can be cancelled.
one ofPENDINGOPENFILLINGCANCELLINGplacementTxIdstringrequiredTransaction that created the order box
placedHeightinteger · int32Height the placement confirmed at. Absent while it is unconfirmed.
spendingTxIdstringThe unconfirmed transaction filling or cancelling the order. Present when FILLING or CANCELLING.
ownerstringrequiredAddress that receives the fill, and the only key that can cancel
valuestringrequirednanoERG held by the order box. Decimal string.
executorFeestringrequirednanoERG the order pays whoever fills it. Decimal string.
maxMinerFeestringrequiredMost nanoERG a fill may pay as a miner fee, out of
executorFee. Decimal string.ergInbooleanSWAP only. True when selling ERG for the token.
amountInstringSWAP only. nanoERG or raw token units sold into the pool. Decimal string.
minOutputstringSWAP only. Least the owner receives: tokens when selling ERG, or nanoERG after
executorFeewhen selling the token. Decimal string.amountXstringDEPOSIT only. Most nanoERG offered to the reserves. Decimal string.
amountYstringDEPOSIT only. Raw token units offered. Decimal string.
minSharesstringDEPOSIT only. Fewest shares the order accepts. Decimal string.
ownerNFTstringREDEEM only. Ownership NFT of the provision the order closes.
provisionBoxIdstringREDEEM only. Current box of that provision. Absent when it cannot be found.
fillableNowbooleanrequiredWhether the order would fill against the current pool. False when the pool cannot meet the order's minimum or refuses it; the order waits until that changes or it is cancelled. Always true while
FILLINGand false whileCANCELLING.
403Missing or wrong api_keyApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
503Node or mempool unavailable. Never returns a partial list.ApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description
defaultErrorApiError▶
errorintegerrequiredError code
reasonstringrequiredError message explaining the reason of the error
detailstringrequirednullableDetailed error description