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

Order Status & History

Record self-submitted order tx

POST /api/v1/orders/tx
Field
Type
Required
Description

txHash

string

Yes

On-chain transaction hash.

Indexer backfills orderId from chain events.

Same txHash from the same API key returns the existing mapping. A txHash already owned by another key returns an error.

Query orders

List mappings

GET /api/v1/orders?page=1&limit=10

By tx hash

GET /api/v1/orders/tx/{txHash}

By order ID

GET /api/v1/orders/{orderId}

orderId must belong to a mapping recorded by the current API key.

Order detail fields

openOrder:

Field
Type
Description

orderId

string

On-chain order ID.

userAddress

string

User address.

side

string

Buy or Sell.

type

string

Market or Limit.

tif

string

Time in force.

symbol

string

Symbol.

placeNotional

string

Order notional (0 for limit orders, which use placeQuantity).

placeQuantity

string

Order quantity.

pay

string

Payment amount.

placePrice

string

Order (limit) price.

status

string

placing or canceling.

historyOrder adds:

Field
Type
Description

settleTxHash

string / null

Settlement tx.

settlePrice

string

Execution price.

settlePay

string / null

Actual payment.

settleReceive

string / null

Actual received.

mintFee

string

Mint fee.

protocolFee

string

Protocol fee.

See reference/enums.md for status values.

Last updated