Sign in

v1

latestOpenAPI 3.0.12026-07-142791104.2 KB
Orders

Retrieve orders list

This endpoint can be used to fetch orders from the system

get/openapi/v1/orders/list

Query parameters

chain'eth' | 'bsc' | 'polygon' | 'avalanche' | 'arbitrum' | 'zksync' | 'linea' | 'starknet' | 'opbnb' | 'base' | 'scroll' | 'manta_pacific' | 'optimism' | 'mantle' | 'zkfair' | 'blast' | 'merlin' | 'mode' | 'cyber' | 'bob' | 'lightlink' | 'zeta' | 'nibiru' | 'abstract' | 'bitlayer' | 'mantra' | 'monad' | 'ink' required

Chain Name, eth is default.

asset_contract_addressstring

Filter by smart contract address for the asset category.When this field is empty, only the parameters chain, side, direction, listed_after, limit, offset will affect the query result, other parameters will be ignored.

token_idsstring

Filter by a list of token IDs for the order's asset, comma separated. Needs to be defined together with asset_contract_address.

sale_kindstring

Filter by the kind of sell order, 0 for standard order, 3 for bulk listings, 7 for collection offer, default for all orders.

sidestring

Filter by the side of the order. 0 for buy orders and 1 for sell orders.

makerstring

Filter by the order maker's wallet address

takerstring

Filter by the order taker's wallet address. Orders open for any taker have the null address as their taker.

payment_tokenstring

Filter by the address of the smart contract of the payment token that is accepted or offered by the order, Native token is 0x0000000000000000000000000000000000000000 for sell order. Leave blank to query all paymentToken orders.

order_by'created_date' | 'base_price'

How to sort the orders. Can be created_date for when they were made, or base_price to see the lowest-priced orders first, when using created_date, the results are sorted by listingTime. use with direction, created_date is default.

direction'desc' | 'asc'

Can be asc or desc for ascending or descending sort. use with order_by, desc is default.

listed_beforestring

Only show orders listed before this timestamp(order createdTime). Seconds since the Unix epoch.

listed_afterstring

Only show orders listed after this timestamp(order createdTime). Seconds since the Unix epoch.

limitinteger

Number of orders to return (capped at 50, default is 20).

offsetinteger

Number of orders to offset by (for pagination), When asset_contract_address is not provided, max offset is 10000.

Response

OK

codeinteger

Error Code

msgstring

Error Message

messagestring

Example response

{
  "data": {
    "orders": [
      {
        "chain": "eth",
        "chainId": "0x1",
        "orderHash": "0x99a2d68bda1a946dc71f1b45b59f173d592382c2fc5b4cc87c350e9e0d19a001",
        "orderId": "974967556489302561",
        "expirationTime": 1668136793,
        "listingTime": 1667531933,
        "createTime": 1667531999,
        "maker": "0xea199722372dea9df458dbb56be7721af117a9bc",
        "taker": "0x0000000000000000000000000000000000000000",
        "side": 1,
        "paymentToken": "0x0000000000000000000000000000000000000000",
        "quantity": "1",
        "priceBase": 0.2,
        "priceUSD": 309.7634,
        "price": 0.2,
        "standard": "element-ex-v3",
        "contractAddress": "0x5fecbbbaf9f3126043a48a35eb2eb8667d469d53",
        "tokenId": "177004",
        "schema": "ERC721",
        "extra": "0",
        "exchangeData": "0"
      }
    ]
  }
}