Search NFT stacks

curl --request GET \
  --url https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks

import requests

url = "https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "result": [
    {
      "stack": {
        "stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "chain": {
          "id": "eip155:13372",
          "name": "imtbl-zkevm-testnet"
        },
        "contract_address": "<string>",
        "created_at": "2022-08-16T17:43:26.991388Z",
        "updated_at": "2022-08-16T17:43:26.991388Z",
        "name": "Sword",
        "description": "2022-08-16T17:43:26.991388Z",
        "image": "https://some-url",
        "external_url": "https://some-url",
        "animation_url": "https://some-url",
        "youtube_url": "https://some-url",
        "attributes": [
          {
            "trait_type": "Aqua Power",
            "value": "Happy",
            "display_type": "number"
          }
        ]
      },
      "stack_count": 1,
      "market": {
        "floor_listing": {
          "listing_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        },
        "top_bid": {
          "bid_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        },
        "last_trade": {
          "trade_id": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "token_id": "1",
          "price_details": [
            {
              "token": {
                "type": "NATIVE",
                "symbol": "IMX"
              },
              "amount": "9750000000000000000",
              "fee_inclusive_amount": "9750000000000000000",
              "fees": [
                {
                  "type": "TAKER_ECOSYSTEM",
                  "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                  "amount": "1000000000000000000"
                }
              ],
              "converted_prices": {
                "ETH": "0.0058079775",
                "USD": "15.89"
              }
            }
          ],
          "amount": "1",
          "created_at": "2022-08-16T17:43:26.991388Z"
        }
      },
      "listings": [
        {
          "listing_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        }
      ],
      "bids": [
        {
          "bid_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        }
      ]
    }
  ],
  "page": {
    "previous_cursor": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=",
    "next_cursor": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0="
  }
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "VALIDATION_ERROR",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "UNAUTHORISED_REQUEST",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "AUTHENTICATION_ERROR",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "RESOURCE_NOT_FOUND",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "TOO_MANY_REQUESTS_ERROR",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "INTERNAL_SERVER_ERROR",
  "details": {}
}

GET

chains

{chain_name}

stacks

Search NFT stacks

curl --request GET \
  --url https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks

import requests

url = "https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.immutable.com/v1/chains/{chain_name}/search/stacks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "result": [
    {
      "stack": {
        "stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "chain": {
          "id": "eip155:13372",
          "name": "imtbl-zkevm-testnet"
        },
        "contract_address": "<string>",
        "created_at": "2022-08-16T17:43:26.991388Z",
        "updated_at": "2022-08-16T17:43:26.991388Z",
        "name": "Sword",
        "description": "2022-08-16T17:43:26.991388Z",
        "image": "https://some-url",
        "external_url": "https://some-url",
        "animation_url": "https://some-url",
        "youtube_url": "https://some-url",
        "attributes": [
          {
            "trait_type": "Aqua Power",
            "value": "Happy",
            "display_type": "number"
          }
        ]
      },
      "stack_count": 1,
      "market": {
        "floor_listing": {
          "listing_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        },
        "top_bid": {
          "bid_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        },
        "last_trade": {
          "trade_id": "4e28df8d-f65c-4c11-ba04-6a9dd47b179b",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "token_id": "1",
          "price_details": [
            {
              "token": {
                "type": "NATIVE",
                "symbol": "IMX"
              },
              "amount": "9750000000000000000",
              "fee_inclusive_amount": "9750000000000000000",
              "fees": [
                {
                  "type": "TAKER_ECOSYSTEM",
                  "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                  "amount": "1000000000000000000"
                }
              ],
              "converted_prices": {
                "ETH": "0.0058079775",
                "USD": "15.89"
              }
            }
          ],
          "amount": "1",
          "created_at": "2022-08-16T17:43:26.991388Z"
        }
      },
      "listings": [
        {
          "listing_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        }
      ],
      "bids": [
        {
          "bid_id": "018792C9-4AD7-8EC4-4038-9E05C598534A",
          "price_details": {
            "token": {
              "type": "NATIVE",
              "symbol": "IMX"
            },
            "amount": "9750000000000000000",
            "fee_inclusive_amount": "9750000000000000000",
            "fees": [
              {
                "type": "TAKER_ECOSYSTEM",
                "recipient_address": "0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92233",
                "amount": "1000000000000000000"
              }
            ],
            "converted_prices": {
              "ETH": "0.0058079775",
              "USD": "15.89"
            }
          },
          "token_id": "1",
          "contract_address": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "creator": "0xe9b00a87700f660e46b6f5deaa1232836bcc07d3",
          "amount": "1"
        }
      ]
    }
  ],
  "page": {
    "previous_cursor": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0=",
    "next_cursor": "ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0="
  }
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "VALIDATION_ERROR",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "UNAUTHORISED_REQUEST",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "AUTHENTICATION_ERROR",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "RESOURCE_NOT_FOUND",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "TOO_MANY_REQUESTS_ERROR",
  "details": {}
}

{
  "message": "all fields must be provided",
  "link": "https://docs.x.immutable.com/reference/#/",
  "trace_id": "e47634b79a5cd6894ddc9639ec4aad26",
  "code": "INTERNAL_SERVER_ERROR",
  "details": {}
}

Path Parameters

chain_name

string

required

The name of chain

Example:

"imtbl-zkevm-testnet"

Query Parameters

contract_address

string[]

required

List of contract addresses to filter by

Required array length: 1 - 20 elements

Pattern: ^0x[a-fA-F0-9]{40}$

account_address

string

Account address to filter by

Pattern: ^0x[a-fA-F0-9]{40}$

Example:

"0xe9b00a87700f660e46b6f5deaa1232836bcc07d3"

only_include_owner_listings

boolean

Whether to the listings should include only the owner created listings

Example:

true

only_if_has_active_listings

boolean

Filters results to include only stacks that have a current active listing. False and 'null' return all unfiltered stacks.

Example:

true

traits

string

JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({"rarity": {"values": ["common", "rare"], "condition": "eq"}}))

keyword

string

Keyword to search NFT name and description. Alphanumeric characters only.

Example:

"sword"

payment_token

string

Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or 'NATIVE'

Example:

"NATIVE"

sort_by

enum<string>

Sort results in a specific order

Available options:

cheapest_first

page_size

integer<int32>

default:100

Number of results to return per page Maximum number of items to return

Required range: 1 <= x <= 200

Example:

10

page_cursor

string

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

Example:

"ewogICJ0eXBlIjogInByZXYiLAogICJpdGVtIjogewogICAgImlkIjogNjI3NTEzMCwKICAgICJjcmVhdGVkX2F0IjogIjIwMjItMDktMTNUMTc6MDQ6MTIuMDI0MTI2WiIKICB9Cn0="

Response

200 response

Search stacks result

result

object[]

required

List of stack bundles

Show child attributes

page

object

required

Pagination properties

Show child attributes

Search NFTs

Get pricing data for a list of stack ids

⌘I

activities

collections

nfts

metadata

nft owners

tokens

chains

crafting

orders

passport

passport profile

metadata-search

pricing

Search NFT stacks

Path Parameters

Query Parameters

Response