Skip to main content
GET
/
v1
/
chains
/
{chain_name}
/
orders
/
listings
List all listings
curl --request GET \
  --url https://api.sandbox.immutable.com/v1/chains/{chain_name}/orders/listings
{
  "page": {
    "previous_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA",
    "next_cursor": "MjAyMy0wMS0yM1QwMTo1NToyNy4zNTM2MzA"
  },
  "result": [
    {
      "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
      "buy": [
        {
          "type": "ERC20",
          "amount": "9750000000000000000",
          "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F"
        }
      ],
      "fees": [],
      "chain": {
        "id": "eip155:11155111",
        "name": "sepolia"
      },
      "created_at": "2022-03-07T07:20:50.52Z",
      "end_at": "2022-03-10T05:00:50.52Z",
      "id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
      "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
      "protocol_data": {
        "order_type": "FULL_RESTRICTED",
        "counter": "1",
        "zone_address": "0x12",
        "seaport_address": "0x12",
        "seaport_version": "1.5"
      },
      "salt": "12686911856931635052326433555881236148",
      "sell": [
        {
          "type": "ERC721",
          "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
          "token_id": "1"
        }
      ],
      "signature": "0x",
      "start_at": "2022-03-09T05:00:50.52Z",
      "status": {
        "name": "EXPIRED"
      },
      "updated_at": "2022-03-07T07:20:50.52Z"
    },
    {
      "account_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
      "buy": [
        {
          "type": "ERC20",
          "amount": "9750000000000000000",
          "contract_address": "0x0165878A594ca255338adfa4d48449f69242Eb8F"
        }
      ],
      "fees": [],
      "chain": {
        "id": "eip155:11155111",
        "name": "sepolia"
      },
      "created_at": "2022-03-07T07:20:50.52Z",
      "end_at": "2022-03-10T05:00:50.52Z",
      "id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
      "order_hash": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266",
      "protocol_data": {
        "order_type": "FULL_RESTRICTED",
        "counter": "1",
        "zone_address": "0x12",
        "seaport_address": "0x12",
        "seaport_version": "1.5"
      },
      "salt": "12686911856931635052326433555881236148",
      "sell": [
        {
          "type": "ERC721",
          "contract_address": "0x692edAd005237c7E737bB2c0F3D8ccCc10D3479E",
          "token_id": "1"
        }
      ],
      "signature": "0x",
      "start_at": "2022-03-09T05:00:50.52Z",
      "status": {
        "name": "EXPIRED"
      },
      "updated_at": "2022-03-07T07:20:50.52Z"
    }
  ]
}

Path Parameters

​
chain_name
string
required

The name of chain

Example:

"imtbl-zkevm-testnet"

Query Parameters

​
status
enum<string>

Order status to filter by The Order status

Available options:
PENDING,
ACTIVE,
INACTIVE,
FILLED,
EXPIRED,
CANCELLED
​
sell_item_contract_address
string

Sell item contract address to filter by

Example:

"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"

​
buy_item_type
enum<string>

Buy item type to filter by

Available options:
NATIVE,
ERC20
Example:

"NATIVE"

​
buy_item_contract_address
string

Buy item contract address to filter by

Example:

"0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"

​
account_address
string

The account address of the user who created the listing

Example:

"0xc49Fd6e51aad88F6F4ce6aB8827279cffFb92266"

​
sell_item_metadata_id
string<uuid>

The metadata_id of the sell item

Example:

"020792C9-4AD7-8EC4-4038-9E05C598535B"

​
sell_item_token_id
string

Sell item token identifier to filter by

Example:

"1"

​
from_updated_at
string<date-time>

From updated at including given date

Example:

"2022-03-09T05:00:50.52Z"

​
page_size
integer<int32>
default:100

Maximum number of orders to return per page Maximum number of items to return

Required range: 1 <= x <= 200
Example:

10

​
sort_by
enum<string>

Order field to sort by

Available options:
created_at,
updated_at,
buy_item_amount
Example:

"created_at"

​
sort_direction
enum<string>

Ascending or descending direction for sort

Available options:
asc,
desc
Example:

"asc"

​
page_cursor
string

Page cursor to retrieve previous or next page. Use the value returned in the response. Encoded page cursor to retrieve previous or next page. Use the value returned in the response.

Example:

"ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0="

Response

OK response.

​
page
object
required

Pagination properties

​
result
object[]
required
Maximum array length: 200