Vývojářský portál
Motiv

Get Intent Order Status#

Query the current status of a single intent order by its order ID.

Request URL#

GET
https://web3.okx.com/api/v6/dex/aggregator/intent/order-status

Request Parameters#

ParameterTypeRequiredDescription
orderUidStringYesThe unique order identifier returned by the Create Intent Order endpoint.

Response Parameters#

ParameterTypeDescription
chainIndexStringUnique identifier for the chain.
fromTokenAddressStringContract address of the token sold.
fromTokenAmountStringAmount of the token sold, expressed as a decimal string. Empty if the order has not been matched yet.
toTokenAddressStringContract address of the token bought.
toTokenAmountStringAmount of the token received, expressed as a decimal string. Empty if the order has not been settled yet.
userWalletAddressStringWallet address of the order owner.
statusIntegerCurrent status of the intent order. Possible values:
-7: Expired — Order not filled before validTo and auto-invalidated.
-6: Invalidated — Wallet token balance or settlement-contract allowance became insufficient while pending; set to terminal state.
-2: Cancelled — User cancelled the order before it was filled.
-1: Failed — Order unfilled after multiple auction rounds; terminated at retry limit.
0: Pending Settlement — Auction won; settling on-chain, awaiting final confirmation.
1: Filled — Order filled and settled.
3: Active — Order placed, awaiting auction.
5: In Auction — In auction; system comparing prices to select the best executor.

Request Example#

shell
curl --location --request GET 'https://web3.okx.com/api/v6/dex/aggregator/intent/order-status?orderUid=0xa1b2c3d4e5f6789012345678901234567890123456789012345678901234567890ab' \
--header 'OK-ACCESS-KEY: 37c541a1-****-****-****-10fe7a038418' \
--header 'OK-ACCESS-SIGN: leaV********3uw=' \
--header 'OK-ACCESS-PASSPHRASE: 1****6' \
--header 'OK-ACCESS-TIMESTAMP: 2023-10-18T12:21:41.274Z'

Response Example#

json
{
    "code": "0",
    "data": {
        "chainIndex": "1",
        "fromTokenAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
        "fromTokenAmount": "",
        "status": -7,
        "toTokenAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
        "toTokenAmount": "",
        "userWalletAddress": ""
    },
    "msg": ""
}