Search NFT collections

Note: when filtering data using only the block_number condition, the range between block_number_start and block_number_end cannot exceed 10000.

API Endpoint

https://open-platform.nodereal.io/{apiKey}/nftscan

method_path:/api/v2/collections/filters/{chain_name}

method_type:POST

Request:

Parameters	Descriptions	Query Type	Required	Data Type	schema
chain_name	Name of the chain you’re querying. List of supported values: "eth" for Ethereum; "bnb" for BNB Smart Chain; "polygon" for Polygon; "moonbeam" for Moonbeam; "arbitrum" for Arbitrum One; "optimism" for Optimism; "platon" for PlatON; "avalanche" for Avalanche; "cronos" for Cronos; "fantom" for Fantom; "gnosis" for Gnosis;	path	true	string
Collection Request filters	Collection Request filters	body	true	Collection Request filters	Collection Request filters
block_number_end	Filter of end block number		false	integer(int32)
block_number_start	Filter of start block number		false	integer(int32)
contract_address_list	List of contract address. Maximum size is 10.		false	array	string
limit	Page size. Defaults to 20, capped at 100		false	integer(int32)
name	Filter of name		false	string
name_fuzzy_search	Whether name supports fuzzy search		false	boolean
offset	The offset for pagination		false	integer(int32)
show_collection	Whether to obtain collections with the same nameoption{false,true}		false	boolean
sort_direction	option{asc,desc}		false	string
sort_field	option{create_block_number,floor_price}		false	string
symbol	Filter of symbol		false	string
twitter	Filter of twitter		false	string

Request Example:

{
  "block_number_end": 15000000,
  "block_number_start": 14000000,
  "contract_address_list": [],
  "limit": 20,
  "name": "BoredApeYachtClub",
  "name_fuzzy_search": false,
  "offset": 100,
  "show_collection": false,
  "sort_direction": "",
  "sort_field": "",
  "symbol": "BAYC",
  "twitter": "BoredApeYC"
}

Response:

Parameters	Descriptions	Data Type	schema
code	Response status code (200 means the request was successful, 4XX or 5XX means the request failed)	integer(int32)	integer(int32)
data	Response data	array	CollectionModel
amounts_total	How many amount for the collection	number(biginteger)
attributes	The attributes distribution of the collection	array	Attributes Model
attributes_name	The name of the attribute	string
attributes_values	The values for the attribute	array	AttributesValueVO
attributes_value	The value for the attribute name	string
total	How many items have this attribute value	integer
total	How many kind of value for the attribute name	integer
banner_url	The banner URL	string
collections_with_same_name	The contract address of collections with the same name	array	string
contract_address	The contract address	string
deploy_block_number	The block number when the contract was deployed	integer(int32)
description	The description	string
discord	The discord	string
email	The email	string
erc_type	The erc type of the collection	string
featured_url	The featured URL	string
floor_price	The floor price of the collection	number(double)
github	The github	string
instagram	The instagram	string
items_total	How many items for the collection	integer(int64)
large_image_url	The large image URL	string
logo_url	The logo URL	string
medium	The medium	string
name	The name	string
opensea_floor_price	The floor price of the collection on opensea	number(double)
opensea_verified	Whether the collection is verified on OpenSea	boolean
owner	The user address who owns the contract	string
owners_total	How many owners for the collection	integer(int64)
price_symbol	The floor price symbol of the collection	string
royalty	The royalty for the owner in basis point	integer(int32)
symbol	The symbol	string
telegram	The telegram	string
twitter	The twitter	string
verified	Whether the collection is verified on NFTScan	boolean
website	The website	string
msg	Error message when request fails	string

Example:

{
	"code": 200,
	"data": [
		{
			"amounts_total": 15000,
			"attributes": [
				{
					"attributes_name": "Mouth",
					"attributes_values": [
						{
							"attributes_value": "Grin",
							"total": 700
						}
					],
					"total": 5
				}
			],
			"banner_url": "https://logo.nftscan.com/banner/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d.png",
			"collections_with_same_name": [],
			"contract_address": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
			"deploy_block_number": 12292922,
			"description": "The Bored Ape Yacht Club is a collection of 10,000 unique Bored Ape NFTs— unique digital collectibles living on the Ethereum blockchain. Your Bored Ape doubles as your Yacht Club membership card, and grants access to members-only benefits, the first of which is access to THE BATHROOM, a collaborative graffiti board. Future areas and perks can be unlocked by the community through roadmap activation. Visit www.BoredApeYachtClub.com for more details.",
			"discord": "https://discord.gg/3P5K3dzgdB",
			"email": "",
			"erc_type": "erc721",
			"featured_url": "https://lh3.googleusercontent.com/RBX3jwgykdaQO3rjTcKNf5OVwdukKO46oOAV3zZeiaMb8VER6cKxPDTdGZQdfWcDou75A8KtVZWM_fEnHG4d4q6Um8MeZIlw79BpWPA=s300",
			"floor_price": 1.113,
			"github": "",
			"instagram": "",
			"items_total": 10000,
			"large_image_url": "https://lh3.googleusercontent.com/RBX3jwgykdaQO3rjTcKNf5OVwdukKO46oOAV3zZeiaMb8VER6cKxPDTdGZQdfWcDou75A8KtVZWM_fEnHG4d4q6Um8MeZIlw79BpWPA=s300",
			"logo_url": "https://logo.nftscan.com/logo/0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d.png",
			"medium": "",
			"name": "BoredApeYachtClub",
			"opensea_floor_price": 91,
			"opensea_verified": true,
			"owner": "0xaba7161a7fb69c88e16ed9f455ce62b791ee4d03",
			"owners_total": 6271,
			"price_symbol": "ETH",
			"royalty": 250,
			"symbol": "BAYC",
			"telegram": "BoredApeYC",
			"twitter": "BoredApeYC",
			"verified": false,
			"website": "http://www.boredapeyachtclub.com/"
		}
	],
	"msg": ""
}