{ "openrpc": "1.2.6", "info": { "title": "Ethereum NFT API", "description": "Quicknode Ethereum NFT API reference", "version": "1.0.0" }, "methods": [ { "name": "qn_fetchNFTCollectionDetails", "summary": "Returns collection details for specified contracts.", "description": "Returns collection details for specified contracts.", "params": [ { "name": "object", "description": "A custom object with the following fields:", "required": true, "schema": { "type": "object", "properties": { "contracts": { "type": "array", "items": {}, "description": "An array with the list of NFT contract addresses you'd like to get collection details data from. You may include up to 10 contract addresses per request" } } } } ], "result": { "name": "object", "description": "The custom response object, or null if no NFT Collections are found:", "schema": { "type": "object", "properties": { "name": { "description": "The name of this collection" }, "address": { "description": "The checked contract address" }, "description": { "description": "The description of this NFT collection" }, "erc721": { "description": "Boolean (true,false)" }, "erc1155": { "description": "Boolean (true,false)" }, "genesisBlock": { "description": "The block in which this contract was deployed" }, "genesisTransaction": { "description": "The hash of the transaction in which this contract was deployed" }, "totalSupply": { "description": "The total supply of the collection" }, "circulatingSupply": { "description": "The circulating supply of the collection" } } } }, "tags": [ { "name": "qn" } ], "externalDocs": { "description": "Quicknode docs", "url": "https://www.quicknode.com/docs/ethereum/qn_fetchNFTCollectionDetails_v2" }, "examples": [ { "name": "qn_fetchNFTCollectionDetails example", "params": [], "result": { "name": "qn_fetchNFTCollectionDetails result", "value": [ { "name": "Meebits", "address": "0x7bd29408f11d2bfc23c34f18275bbf23bb716bc7", "description": "Meebits", "erc1155": false, "erc721": true, "totalSupply": 20000, "circulatingSupply": 19948, "genesisBlock": 12358080, "genesisTransaction": "0xf2040b9b67193fe8c861a18cff864b9f35c1f69cc8734c724c388c449a1116c4" }, { "name": "MutantApeYachtClub", "address": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "description": "MutantApeYachtClub", "erc1155": false, "erc721": true, "totalSupply": 19486, "circulatingSupply": 19384, "genesisBlock": 13117018, "genesisTransaction": "0x025f185262da3c52bf9b87f09a1fea815a27fd8c32a363da72cac0c9cae27436" } ] } } ] }, { "name": "qn_fetchNFTsByCollection", "summary": "Returns aggregated data on NFTs within a given collection.", "description": "Returns aggregated data on NFTs within a given collection.", "params": [ { "name": "object", "description": "A custom object with the following fields:", "required": true, "schema": { "type": "object", "properties": { "collection": { "type": "string", "description": "The contract address of the NFT Collection" }, "tokens": { "type": "array", "items": {}, "description": "An array of strings that optionally limit the results to specific tokens within a collection. You may submit up to 20 token IDs in this parameter. If you do not want to limit results to specific tokens, please omit this parameter from your request" }, "page": { "type": "integer", "description": "The page number you would like returned. Page numbers start at 1 and end at totalPages. If omitted, defaults to the first page (page 1). If the page number requested is higher than totalPages, an empty assets array will be returned. If the page number requested is less than 1, an invalid params response will be returned" }, "perPage": { "type": "integer", "description": "The maximum amount of NFT tokens to return on each page. You can request up to 100 items per page. If omitted, defaults to 40 items per page" }, "omitFields": { "type": "array", "items": {}, "description": "Optionally omit specific properties of objects from the assets array of the response. Any property of the asset object can be omitted. If omitFields is not included in the request, response will return all available fields by default" } } } } ], "result": { "name": "object", "description": "The custom response object, or null if no NFTs are found:", "schema": { "type": "object", "properties": { "collection": { "description": "The contract address we checked for NFTs" }, "tokens": { "type": "object", "properties": { "collectionName": { "description": "The name of this NFT's collection" }, "collectionAddress": { "description": "The contract address that this NFT lives in" }, "chain": { "description": "It states on which chain this aggregation happened on" }, "network": { "description": "It states on which network this aggregation happened on" }, "collectionTokenId": { "description": "The token id of this NFT in its collection" }, "name": { "description": "The name of this specific NFT" }, "description": { "description": "The description of this specific NFT" }, "traits": { "type": "object", "properties": { "value": { "description": "The specific value associated with each trait of the NFT which can be present in the form of text, numbers, or even images, depending on the type of NFT" }, "trait_type": { "description": "The type of trait associated with each NFT. It includes attributes like the color, rarity, or any other defining characteristic that sets the NFT apart from others in its collection" } }, "description": "The traits refer to the different attributes of NFTs" }, "imageUrl": { "description": "The URL where the image for this NFT can be seen" } }, "description": "An array of objects representing NFTs with the following shape:" }, "totalPages": { "description": "The total number of results pages available" }, "pageNumber": { "description": "The page number of results that were returned with this response" }, "totalItems": { "description": "The total number of results" } } } }, "tags": [ { "name": "qn" } ], "externalDocs": { "description": "Quicknode docs", "url": "https://www.quicknode.com/docs/ethereum/qn_fetchNFTsByCollection_v2" }, "examples": [ { "name": "qn_fetchNFTsByCollection example", "params": [], "result": { "name": "qn_fetchNFTsByCollection result", "value": { "collection": "0x60E4d786628Fea6478F785A6d7e704777c86a7c6", "tokens": [ { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "0", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "1", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "2", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "3", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "4", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "5", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "6", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "7", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "8", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "MutantApeYachtClub", "collectionAddress": "0x60e4d786628fea6478f785a6d7e704777c86a7c6", "collectionTokenId": "9", "description": "", "name": "", "chain": "ETH", "network": "MAINNET" } ], "totalPages": 1956, "pageNumber": 1, "totalItems": 19551 } } } ] }, { "name": "qn_fetchNFTs", "summary": "Returns aggregated data on NFTs for a given wallet.", "description": "Returns aggregated data on NFTs for a given wallet.", "params": [ { "name": "object", "description": "A custom object with the following fields:", "required": true, "schema": { "type": "object", "properties": { "wallet": { "type": "string", "description": "The wallet address or ENS name to check for NFTs" }, "contracts": { "type": "array", "items": {}, "description": "An array of strings with the list of NFT contract addresses you'd like to get ownership data from. The contract addresses may be optionally suffixed with :tokenId to specify a specific NFT id to filter on. For example, 0x2106c...7aeaa:1234will filter Loopy Donuts on the NFT token with id1234 only. You may include up to 20 contract addresses per request" }, "page": { "type": "integer", "description": "The page number you would like to get returned. The page numbers start at 1 and end at totalPages. If omitted, defaults to the first page (page 1). If the page number requested is less than 1 or higher than totalPages, an empty assets array will be returned" }, "perPage": { "type": "integer", "description": "The maximum amount of NFT assets to return on each page. You can request up to 40 items per page. If omitted, this will default to 20 items per page" }, "omitFields": { "type": "array", "items": {}, "description": "Optionally omit specific properties of objects from the assets array of the response. Any property of the asset object can be omitted. If omitFields is not included in the request, response will return all available fields by default" } } } } ], "result": { "name": "object", "description": "The custom response object, or null if no NFTs are found:", "schema": { "type": "object", "properties": { "owner": { "type": "string", "description": "The wallet address we checked for NFTs" }, "ensName": { "type": "string", "description": "The ENS name associated with the address we checked" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of this specific NFT" }, "collectionTokenId": { "type": "string", "description": "The token id of this NFT in its collection" }, "collectionName": { "type": "string", "description": "The name of this NFT's collection" }, "traits": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "description": "The specific value associated with each trait of the NFT which can be present in the form of text, numbers, or even images, depending on the type of NFT" }, "trait_type": { "type": "string", "description": "The type of trait associated with each NFT. It includes attributes like the color, rarity, or any other defining characteristic that sets the NFT apart from others in its collection" } } }, "description": "The traits refer to the different attributes of NFTs" }, "imageUrl": { "type": "string", "description": "The URL where the image for this NFT can be seen" }, "collectionAddress": { "type": "string", "description": "The contract address that this NFT lives in" }, "chain": { "type": "string", "description": "It states on which chain this aggregation happened on" }, "network": { "type": "string", "description": "It states on which network this aggregation happened on" }, "description": { "type": "string", "description": "The description of the asset" } } }, "description": "An array of objects representing NFTs with the following shape:" }, "totalItems": { "type": "integer", "description": "The total number of results" }, "totalPages": { "type": "integer", "description": "The total number of results pages available" }, "pageNumber": { "type": "integer", "description": "The page number of results that were returned with this response" } } } }, "tags": [ { "name": "qn" } ], "externalDocs": { "description": "Quicknode docs", "url": "https://www.quicknode.com/docs/ethereum/qn_fetchNFTs_v2" }, "examples": [ { "name": "qn_fetchNFTs example", "params": [], "result": { "name": "qn_fetchNFTs result", "value": { "owner": "0x91b51c173a4bdaa1a60e234fc3f705a16d228740", "ensName": null, "assets": [ { "collectionName": "Loopy Donuts", "collectionTokenId": "1747", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #1747", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/1747.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "1971", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #1971", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/1971.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "2979", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #2979", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/2979.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "3432", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #3432", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/3432.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "3643", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #3643", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/3643.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "3854", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #3854", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/3854.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "4592", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #4592", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/4592.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "4878", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #4878", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/4878.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "5585", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #5585", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/5585.png", "chain": "ETH", "network": "MAINNET" }, { "collectionName": "Loopy Donuts", "collectionTokenId": "6652", "collectionAddress": "0x2106c00ac7da0a3430ae667879139e832307aeaa", "name": "Loopy Donut #6652", "description": "", "imageUrl": "https://quicknode-content.quicknode-ipfs.com/ipfs/QmSNmVFTJv6cG9M8ZRU8T9F4Kz9HHxmV85ssGP5W8ZsTPa/6652.png", "chain": "ETH", "network": "MAINNET" } ], "totalPages": 2, "totalItems": 18, "pageNumber": 1 } } } ] }, { "name": "qn_getTransfersByNFT", "summary": "Returns transfers by given NFT.", "description": "Returns transfers by given NFT.", "params": [ { "name": "object", "description": "The custom object with the following fields:", "required": true, "schema": { "type": "object", "properties": { "collection": { "type": "string", "description": "The contract address of the NFT collection" }, "collectionTokenId": { "type": "string", "description": "The Token ID of this NFT under this collection" }, "page": { "type": "integer", "description": "The page number you would like returned. The page numbers start at 1 and end at totalPages. If omitted, defaults to the first page (page 1). If the page number requested is higher than totalPages, an empty transfers array will be returned. If the page number requested is less than 1, an invalid params response will be returned" }, "perPage": { "type": "integer", "description": "The maximum amount of NFT tokens to return on each page. You can request up to 100 items per page. If omitted, defaults to 40 items per page" } } } } ], "result": { "name": "object", "description": "The custom response object, or null if no NFTs are found:", "schema": { "type": "object", "properties": { "collection": { "description": "The contract address we checked for NFTs" }, "transfers": { "type": "object", "properties": { "date": { "description": "The date when this transaction was mined" }, "from": { "description": "The address for the sender of this transaction" }, "to": { "description": "The address for the receiver of this transaction" }, "blockNumber": { "description": "The block number this transaction was included in" }, "txHash": { "description": "The token transfer transaction hash" } }, "description": "An array of transfers representing NFTs with the following shape:" }, "totalPages": { "description": "The total number of results pages available" }, "pageNumber": { "description": "The page number of results that was returned with this response" }, "totalItems": { "description": "The total number of results" } } } }, "tags": [ { "name": "qn" } ], "externalDocs": { "description": "Quicknode docs", "url": "https://www.quicknode.com/docs/ethereum/qn_getTransfersByNFT_v2" }, "examples": [ { "name": "qn_getTransfersByNFT example", "params": [], "result": { "name": "qn_getTransfersByNFT result", "value": { "collection": "0x60E4d786628Fea6478F785A6d7e704777c86a7c6", "transfers": [ { "blockNumber": 13117220, "date": "2021-08-29T00:42:17.000Z", "from": "0x0000000000000000000000000000000000000000", "to": "0x791bf322bc5e20360d27a2d27e4cc5a0790d329f", "txHash": "0x33ca60f747363e7f85a2d35c3ca8ab0bf05185de16b5fee12b62996f51066fe4" }, { "blockNumber": 13149960, "date": "2021-09-03T02:03:48.000Z", "from": "0x791bf322bc5e20360d27a2d27e4cc5a0790d329f", "to": "0x194cc2541ea8696957acdcf1dc3dd5a687bb5ca5", "txHash": "0x46250b9b4c55d88ba057f26262c206ebb3f21feb17f2811a15d16bfd9017cfd7" }, { "blockNumber": 13248857, "date": "2021-09-18T09:31:05.000Z", "from": "0x194cc2541ea8696957acdcf1dc3dd5a687bb5ca5", "to": "0xfdbfcee097fb7fe8ffb2fcad88bd3cb0498b1da5", "txHash": "0xf24b2a526b22295a82f2a34b38a036eccb940e6b4908a035a5cc93439e7e80ac" }, { "blockNumber": 13786941, "date": "2021-12-11T23:49:56.000Z", "from": "0xfdbfcee097fb7fe8ffb2fcad88bd3cb0498b1da5", "to": "0x465092bbe4ca9675c1cf9c7bf2620b2eefc77e25", "txHash": "0x468de64812001b53423d15d21366305de94089bac7681e1044a7296e7fd126af" }, { "blockNumber": 14926083, "date": "2022-06-08T09:59:28.000Z", "from": "0x465092bbe4ca9675c1cf9c7bf2620b2eefc77e25", "to": "0x194cc2541ea8696957acdcf1dc3dd5a687bb5ca5", "txHash": "0xaab28d27b845c4eb7f9e0a95e18521e47e96b3823edb47b24c9b04c0edf803b0" }, { "blockNumber": 14941505, "date": "2022-06-11T01:03:40.000Z", "from": "0x194cc2541ea8696957acdcf1dc3dd5a687bb5ca5", "to": "0x465092bbe4ca9675c1cf9c7bf2620b2eefc77e25", "txHash": "0xe0bea9da688c56127423cddc1c49b706c3c392a7dd246ccbad2ca012a5f6a6d1" }, { "blockNumber": 15967660, "date": "2022-11-14T10:25:11.000Z", "from": "0x465092bbe4ca9675c1cf9c7bf2620b2eefc77e25", "to": "0xaa87190076675da8d3496da24b0c3bbfa1e56396", "txHash": "0xfe7a0a805233b0d6a873caf1c4de215cb7d97cab3725269095229c1ad6763720" } ], "totalPages": 1, "pageNumber": 1, "totalItems": 7 } } } ] }, { "name": "qn_verifyNFTsOwner", "summary": "Confirms ownership of specified NFTs for a given wallet.", "description": "Confirms ownership of specified NFTs for a given wallet.", "params": [ { "name": "object", "description": "A custom object with the following fields:", "required": true, "schema": { "type": "object", "properties": { "wallet": { "type": "string", "description": "The wallet address to check for NFTs" }, "contracts": { "type": "array", "items": {}, "description": "The list of ERC-721 and/or ERC-1155 NFT contract addresses, suffixed with :tokenIdto specify a specific ID. For example, providing the value 0x2106c...7aeaa:1234will verify ownership of Loopy Donuts' NFT token with ID 1234. You may include up to 20 contract addresses per request" } } } } ], "result": { "name": "object", "description": "The custom response object:", "schema": { "type": "object", "properties": { "owner": { "description": "The wallet address we checked for NFTs" }, "assets": { "description": "An array of owned NFTs for the the provided wallet, in the same format as the inputted array. If an inputted array isn't returned, then it does not belong to the wallet" } } } }, "tags": [ { "name": "qn" } ], "externalDocs": { "description": "Quicknode docs", "url": "https://www.quicknode.com/docs/ethereum/qn_verifyNFTsOwner_v2" }, "examples": [ { "name": "qn_verifyNFTsOwner example", "params": [], "result": { "name": "qn_verifyNFTsOwner result", "value": { "owner": "0x91b51c173a4bdaa1a60e234fc3f705a16d228740", "assets": [ "0x2106c00ac7da0a3430ae667879139e832307aeaa:3643", "0xd07dc4262bcdbf85190c01c996b4c06a461d2430:133803" ] } } } ] } ], "servers": [ { "name": "NFT API", "url": "https://docs-demo.quiknode.pro" } ] }