{ "x-generated-warning": "⚠️ This file is auto-generated. Do not edit manually", "openapi": "3.1.0", "info": { "title": "🎨 NFT API", "version": "1.0" }, "servers": [ { "url": "https://{network}.g.alchemy.com/nft", "variables": { "network": { "default": "eth-mainnet", "enum": [ "eth-mainnet", "eth-sepolia", "abstract-mainnet", "abstract-testnet", "anime-mainnet", "anime-sepolia", "apechain-mainnet", "apechain-curtis", "arb-mainnet", "arb-sepolia", "arc-mainnet", "arc-testnet", "avax-mainnet", "avax-fuji", "base-mainnet", "base-sepolia", "berachain-mainnet", "bnb-mainnet", "celo-mainnet", "celo-sepolia", "gnosis-mainnet", "gnosis-chiado", "lens-mainnet", "lens-sepolia", "linea-mainnet", "linea-sepolia", "polygon-mainnet", "polygon-amoy", "monad-mainnet", "monad-testnet", "mythos-mainnet", "opt-mainnet", "opt-sepolia", "robinhood-mainnet", "robinhood-testnet", "ronin-mainnet", "ronin-saigon", "rootstock-mainnet", "rootstock-testnet", "scroll-mainnet", "settlus-mainnet", "settlus-septestnet", "shape-mainnet", "shape-sepolia", "soneium-mainnet", "soneium-minato", "story-mainnet", "story-aeneid", "unichain-mainnet", "unichain-sepolia", "worldchain-mainnet", "worldchain-sepolia", "zetachain-mainnet", "zetachain-testnet", "zksync-mainnet", "zksync-sepolia", "zora-mainnet", "zora-sepolia" ] } } } ], "paths": { "/v3/{apiKey}/getNFTsForOwner": { "get": { "summary": "NFTs By Owner", "description": "getNFTsForOwner - Retrieves all NFTs currently owned by a specified address. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Ownership Endpoints" ], "parameters": [ { "name": "owner", "description": "String - Address for NFT owner (can be in ENS format for Eth Mainnet).", "schema": { "type": "string", "default": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "in": "query", "required": true }, { "name": "contractAddresses[]", "description": "Array of contract addresses to filter the responses with. Max limit 45 contracts.", "schema": { "type": "array", "items": { "type": "string" } }, "in": "query" }, { "name": "withMetadata", "description": "Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`.", "schema": { "type": "boolean", "default": true }, "in": "query" }, { "name": "orderBy", "description": "Enum - ordering scheme to use for ordering NFTs in the response. If unspecified, NFTs will be ordered by contract address and token ID.\n - transferTime: NFTs will be ordered by the time they were transferred into the wallet, with newest NFTs first. Note: This ordering is supported on Ethereum Mainnet, Optimism Mainnet, Polygon Mainnet, Base Mainnet, Arbitrum One, Polygon Amoy, Base Sepolia, Arbitrum Sepolia, Ethereum Sepolia, and Optimism Sepolia.", "in": "query", "schema": { "type": "string", "enum": [ "transferTime" ] }, "required": false }, { "name": "excludeFilters[]", "description": "Array of filters (as ENUMS) that will be applied to the query. NFTs that match one or more of these filters will be excluded from the response. May not be used in conjunction with includeFilters[]. Filter Options:\n - SPAM: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. Please note that this filter is currently supported on Mainnet for Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast, and is **available exclusively on paid tiers**.\n - AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.\n - To learn more about spam, you can refer to this: [Spam NFTs and how to fix them](https://www.alchemy.com/overviews/spam-nfts)", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SPAM", "AIRDROPS" ], "default": "SPAM" } }, "in": "query" }, { "name": "includeFilters[]", "description": "Array of filters (as ENUMS) that will be applied to the query. Only NFTs that match one or more of these filters will be included in the response. May not be used in conjunction with excludeFilters[]. Filter Options:\n - SPAM: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. Please note that this filter is currently supported on Mainnet for Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast, and is **available exclusively on paid tiers**.\n - AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.\n - To learn more about spam, you can refer to this: [Spam NFTs and how to fix them](https://www.alchemy.com/overviews/spam-nfts)", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SPAM", "AIRDROPS" ], "default": "SPAM" } }, "in": "query" }, { "name": "spamConfidenceLevel", "description": "Enum - the confidence level at which to filter spam at.\n\nConfidence Levels:\n - VERY_HIGH\n - HIGH\n - MEDIUM\n - LOW\n\nThe confidence level set means that any spam that is at that confidence level or higher will be filtered out. For example, if the confidence level is HIGH, contracts that we have HIGH or VERY_HIGH confidence in being spam will be filtered out from the response. \nDefaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet.\n\n**Please note that this filter is only available on paid tiers. Upgrade your account [here](https://dashboard.alchemy.com/settings/billing/).**", "schema": { "type": "string", "enum": [ "VERY_HIGH", "HIGH", "MEDIUM", "LOW" ] }, "in": "query", "required": false }, { "name": "tokenUriTimeoutInMs", "description": "No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0.", "in": "query", "schema": { "type": "integer" } }, { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "pageKey", "description": "String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results.", "schema": { "type": "string" }, "in": "query" }, { "name": "pageSize", "description": "Number of NFTs to be returned per page. Defaults to 100. Max is 100.", "schema": { "type": "integer", "default": 100 }, "in": "query" } ], "responses": { "200": { "description": "Returns the list of all NFTs owned by the given address and satisfying the given input parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ownedNfts": { "type": "array", "description": "Array of the NFT objects corresponding to the NFTs owned by the owner", "items": { "type": "object", "description": "The object that represents an NFT and has all data corresponding to that NFT", "properties": { "contract": { "type": "object", "description": "The contract object that has details of a contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } }, "tokenId": { "type": "string", "default": "44" }, "tokenType": { "type": "string" }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Brief human-readable description" }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } }, "raw": { "type": "object", "description": "Raw details of the NFT like its tokenUri and metadata info obtained directly from the smart contract", "properties": { "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." } } }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." } } }, "collection": { "type": "object", "description": "The collection object that has details of a collection", "properties": { "name": { "type": "string", "description": "String - Collection name" }, "slug": { "type": "string", "description": "String - OpenSea collection slug" }, "externalUrl": { "type": "string", "description": "String - URL for the external site of the collection" }, "bannerImageUrl": { "type": "string", "description": "String - Banner image URL for the collection" } } }, "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "acquiredAt": { "type": "object", "description": "Only present if the request specified `orderBy=transferTime`.", "properties": { "blockTimestamp": { "type": "string", "description": "Block timestamp of the block where the NFT was most recently acquired." }, "blockNumber": { "type": "string", "description": "Block number of the block where the NFT was most recently acquired." } } }, "animation": { "type": "object", "properties": { "cachedUrl": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer" }, "orginalUrl": { "type": "string" } } }, "mint": { "type": "object", "properties": { "mintAddress": { "type": "string", "description": "Address that minted the NFT" }, "blockNumber": { "type": "integer", "description": "Block number when the NFT was minted" }, "timestamp": { "type": "string", "description": "Timestamp when the NFT was minted" }, "transactionHash": { "type": "string", "description": "Transaction hash of the mint transaction" } } }, "owners": { "type": "array", "description": "List of all addresses that own the given NFT.", "items": { "type": "string" } } } } }, "totalCount": { "type": "integer", "description": "Integer - Total number of NFTs (distinct `tokenIds`) owned by the given address." }, "pageKey": { "type": "string" }, "validAt": { "type": "object", "description": "Block Information of the block as of which the corresponding data is valid", "properties": { "blockNumber": { "type": "integer", "description": "The block number above information is valid as of" }, "blockHash": { "type": "string", "description": "The block hash above information is valid as of" }, "blockTimestamp": { "type": "string", "description": "The block timestamp above information is valid as of" } } } } }, "examples": { "byDefault": { "summary": "Response (By Default)", "value": { "ownedNfts": [ { "contract": { "address": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "name": "DuskBreakers", "symbol": "DUSK", "totalSupply": "10000", "tokenType": "ERC721", "contractDeployer": "0x9c78DDec1F16685ee6E58637a640514A1eD87BC4", "deployedBlockNumber": 13736379, "openSeaMetadata": { "floorPrice": 0.0582, "collectionName": "DuskBreakers", "safelistRequestStatus": "verified", "imageUrl": "https://i.seadn.io/gae/LGbFRVdClz6-HDd-7WZKONJ5Ody0sBXTvFOQL71BYo3j2iU2wWCX_zlk-Zs0KEhq1qgXViF-6aG_0WS2MdIVNJx2GRSIIYTiciuf-A?w=500&auto=format", "description": "Being a DuskBreaker means joining a select squad of 10,000 recruits who spend their days exploring a mysterious alien spaceship filled with friends, foes, and otherworldly technology. You will be part of a community that directly influences the development of upcoming interactive media and gaming experiences within the DuskBreakers universe. Each of you will play an important role in building out this world. You break it, you take it! \r\n\r\nVisit [DuskBreakers](https://duskbreakers.gg) to learn more.", "externalUrl": "http://duskbreakers.gg", "twitterUsername": "duskbreakers", "discordUrl": "https://discord.gg/duskbreakers", "lastIngestedAt": "2023-04-19T17:25:59.000Z" }, "isSpam": null, "spamClassifications": [] }, "tokenId": "28", "tokenType": "ERC721", "name": "DuskBreaker #28", "description": "Breakers have the honor of serving humanity through their work on The Dusk. They are part of a select squad of 10,000 recruits who spend their days exploring a mysterious alien spaceship filled with friends, foes, and otherworldly technology.", "image": { "cachedUrl": "https://nft-cdn.alchemy.com/eth-mainnet/1f9e8be3feb42b5b66452537a4032668", "thumbnailUrl": "https://res.cloudinary.com/alchemyapi/image/upload/thumbnailv2/eth-mainnet/1f9e8be3feb42b5b66452537a4032668", "pngUrl": "https://res.cloudinary.com/alchemyapi/image/upload/convert-png/eth-mainnet/1f9e8be3feb42b5b66452537a4032668", "contentType": "image/png", "size": 1474037, "originalUrl": "https://duskbreakers.gg/breaker_images/28.png" }, "raw": { "tokenUri": "https://api.duskbreakers.gg/metadata/duskbreakers/28", "metadata": { "name": "DuskBreaker #28", "description": "Breakers have the honor of serving humanity through their work on The Dusk. They are part of a select squad of 10,000 recruits who spend their days exploring a mysterious alien spaceship filled with friends, foes, and otherworldly technology.", "image": "https://duskbreakers.gg/breaker_images/28.png", "external_url": "https://duskbreakers.gg/", "attributes": [ { "value": "Locust Rider Armor (Red)", "trait_type": "Clothes" }, { "value": "Base Drone (Blue)", "trait_type": "Drone" }, { "value": "Thin", "trait_type": "Eyebrows" }, { "value": "Button", "trait_type": "Nose" }, { "value": "Mohawk (Black)", "trait_type": "Hair" }, { "value": "Almond 2 (Red)", "trait_type": "Eyes" }, { "value": "Big Smile (Purple)", "trait_type": "Mouth" }, { "value": "Light Brown", "trait_type": "Skin Tone" }, { "value": "Yellow", "trait_type": "Background" }, { "value": "Facepaint (Stripe)", "trait_type": "Face Augments" } ] }, "error": null }, "tokenUri": "https://api.duskbreakers.gg/metadata/duskbreakers/28", "timeLastUpdated": "2023-04-19T21:25:39.563Z", "balance": "1" }, { "contract": { "address": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "name": "DuskBreakers", "symbol": "DUSK", "totalSupply": "10000", "tokenType": "ERC721", "contractDeployer": "0x9c78DDec1F16685ee6E58637a640514A1eD87BC4", "deployedBlockNumber": 13736379, "openSeaMetadata": { "floorPrice": 0.0582, "collectionName": "DuskBreakers", "safelistRequestStatus": "verified", "imageUrl": "https://i.seadn.io/gae/LGbFRVdClz6-HDd-7WZKONJ5Ody0sBXTvFOQL71BYo3j2iU2wWCX_zlk-Zs0KEhq1qgXViF-6aG_0WS2MdIVNJx2GRSIIYTiciuf-A?w=500&auto=format", "description": "Being a DuskBreaker means joining a select squad of 10,000 recruits who spend their days exploring a mysterious alien spaceship filled with friends, foes, and otherworldly technology. You will be part of a community that directly influences the development of upcoming interactive media and gaming experiences within the DuskBreakers universe. Each of you will play an important role in building out this world. You break it, you take it! \r\n\r\nVisit [DuskBreakers](https://duskbreakers.gg) to learn more.", "externalUrl": "http://duskbreakers.gg", "twitterUsername": "duskbreakers", "discordUrl": "https://discord.gg/duskbreakers", "lastIngestedAt": "2023-04-19T17:25:59.000Z" }, "isSpam": null, "spamClassifications": [] }, "tokenId": "29", "tokenType": "ERC721", "name": "DuskBreaker #29", "description": "Breakers have the honor of serving humanity through their work on The Dusk. They are part of a select squad of 10,000 recruits who spend their days exploring a mysterious alien spaceship filled with friends, foes, and otherworldly technology.", "image": { "cachedUrl": "https://nft-cdn.alchemy.com/eth-mainnet/4eb0b7f434746250ff3c8200d10a2226", "thumbnailUrl": "https://res.cloudinary.com/alchemyapi/image/upload/thumbnailv2/eth-mainnet/4eb0b7f434746250ff3c8200d10a2226", "pngUrl": "https://res.cloudinary.com/alchemyapi/image/upload/convert-png/eth-mainnet/4eb0b7f434746250ff3c8200d10a2226", "contentType": "image/png", "size": 1480183, "originalUrl": "https://duskbreakers.gg/breaker_images/29.png" }, "raw": { "tokenUri": "https://api.duskbreakers.gg/metadata/duskbreakers/29", "metadata": { "name": "DuskBreaker #29", "description": "Breakers have the honor of serving humanity through their work on The Dusk. They are part of a select squad of 10,000 recruits who spend their days exploring a mysterious alien spaceship filled with friends, foes, and otherworldly technology.", "image": "https://duskbreakers.gg/breaker_images/29.png", "external_url": "https://duskbreakers.gg/", "attributes": [ { "value": "Standard Issue Armor 1 (Orange)", "trait_type": "Clothes" }, { "value": "Dark Metal", "trait_type": "SmartSkin" }, { "value": "Base Drone (Purple)", "trait_type": "Drone" }, { "value": "Thin", "trait_type": "Eyebrows" }, { "value": "Broad", "trait_type": "Nose" }, { "value": "Slick Back (Red)", "trait_type": "Hair" }, { "value": "Sharp (Blue)", "trait_type": "Eyes" }, { "value": "Smirk (Neutral)", "trait_type": "Mouth" }, { "value": "Tan", "trait_type": "Skin Tone" }, { "value": "Purple", "trait_type": "Background" } ] }, "error": null }, "tokenUri": "https://api.duskbreakers.gg/metadata/duskbreakers/29", "timeLastUpdated": "2023-04-19T21:25:39.704Z", "balance": "1" }, { "contract": { "address": "0x209cE666978779756Ae1E747608cD93e4dFf45fD", "name": "Knight of Chains Genesis", "symbol": "Knight of Chains Genesis", "totalSupply": null, "tokenType": "ERC1155", "contractDeployer": "0xA92520aFF50c5A1a4d25FCF90c972AA49EbE5299", "deployedBlockNumber": 14847327, "openSeaMetadata": { "floorPrice": null, "collectionName": "Knight of Chains Genesis.", "safelistRequestStatus": "not_requested", "imageUrl": "https://i.seadn.io/gae/eRhkkVikIOW_-lDc1moMrZlTcd5DPygPRmTJ69Anb-CfG_RMAxIsichM5kDvfdnXc6gfnKuGZOFCbP_58pUvz57TyUeNbFMKGydHoac?w=500&auto=format", "description": "[The KnightsOfChain] (https://knightsofchain.link) is an exclusive community that can only be entered by owning a Knight.\n\nVisit [Website](https://knightsofchain.link) and get your benefits.\n\n(Genesis Knights #1-#31 were pre-minted by the team, and are held by high ranking community members. OG Knights #32-#231 have special benefits.)", "externalUrl": "https://knightsofchain.link", "twitterUsername": null, "discordUrl": null, "lastIngestedAt": "2023-03-20T03:52:07.000Z" }, "isSpam": null, "spamClassifications": [] }, "tokenId": "97", "tokenType": "ERC1155", "name": null, "description": null, "image": { "cachedUrl": null, "thumbnailUrl": null, "pngUrl": null, "contentType": null, "size": null, "originalUrl": null }, "raw": { "tokenUri": "https://knightsofchain.link/ipfs/97", "metadata": {}, "error": null }, "tokenUri": "https://knightsofchain.link/ipfs/97", "timeLastUpdated": "2023-04-20T15:44:29.965Z", "balance": "1" } ], "totalCount": 3, "validAt": { "blockNumber": 17091500, "blockHash": "0x2a34a65c4e0cd7fdf187d6a497214ad2bee255d2d3501868a6b8c09b4d1261bd", "blockTimestamp": "2023-04-21T01:25:59Z" }, "pageKey": null } }, "withoutMetadata": { "summary": "Response (withMetadata = false)", "value": { "ownedNfts": [ { "contractAddress": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "tokenId": "28", "balance": "1" }, { "contractAddress": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "tokenId": "29", "balance": "1" } ], "totalCount": 2, "validAt": { "blockNumber": 17091500, "blockHash": "0x2a34a65c4e0cd7fdf187d6a497214ad2bee255d2d3501868a6b8c09b4d1261bd", "blockTimestamp": "2023-04-21T01:25:59Z" }, "pageKey": null } }, "withContractFiltering": { "summary": "Response (with contract filtering)", "value": { "ownedNfts": [ { "contractAddress": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "tokenId": "28", "balance": "1" }, { "contractAddress": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "tokenId": "29", "balance": "1" } ], "totalCount": 2, "validAt": { "blockNumber": 17091500, "blockHash": "0x2a34a65c4e0cd7fdf187d6a497214ad2bee255d2d3501868a6b8c09b4d1261bd", "blockTimestamp": "2023-04-21T01:25:59Z" }, "pageKey": null } }, "withPagination": { "summary": "Response (with pagination)", "value": { "ownedNfts": [ { "contractAddress": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "tokenId": "28", "balance": "1" }, { "contractAddress": "0x0bEed7099AF7514cCEDF642CfEA435731176Fb02", "tokenId": "29", "balance": "1" } ], "totalCount": 2, "validAt": { "blockNumber": 17091500, "blockHash": "0x2a34a65c4e0cd7fdf187d6a497214ad2bee255d2d3501868a6b8c09b4d1261bd", "blockTimestamp": "2023-04-21T01:25:59Z" }, "pageKey": "88434286-7eaa-472d-8739-32a0497c2a18" } } } } } } }, "operationId": "getNFTsForOwner-v3" } }, "/v3/{apiKey}/getNFTsForContract": { "get": { "summary": "NFTs By Contract", "description": "getNFTsForContract - Retrieves all NFTs associated with a specific NFT contract. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": true }, { "name": "withMetadata", "description": "Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`.", "schema": { "type": "boolean", "default": true }, "in": "query" }, { "name": "startToken", "description": "String - A tokenID offset used for pagination. Can be a hex string, or a decimal. Users can specify the offset themselves to start from a custom offset, or to fetch multiple token ranges in parallel.", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "description": "Integer - Sets the total number of NFTs returned in the response. Defaults to 100.", "in": "query", "schema": { "type": "integer" } }, { "name": "tokenUriTimeoutInMs", "description": "No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0.", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Returns a list of NFTs associated with the specified contract address.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfts": { "description": "List of objects that represent NFTs stored under the queried contract address.", "type": "array", "items": { "type": "object", "description": "The object that represents an NFT and has all data corresponding to that NFT", "properties": { "contract": { "type": "object", "description": "The contract object that has details of a contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } }, "tokenId": { "type": "string", "default": "44" }, "tokenType": { "type": "string" }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Brief human-readable description" }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } }, "raw": { "type": "object", "description": "Raw details of the NFT like its tokenUri and metadata info obtained directly from the smart contract", "properties": { "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." } } }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." } } }, "collection": { "type": "object", "description": "The collection object that has details of a collection", "properties": { "name": { "type": "string", "description": "String - Collection name" }, "slug": { "type": "string", "description": "String - OpenSea collection slug" }, "externalUrl": { "type": "string", "description": "String - URL for the external site of the collection" }, "bannerImageUrl": { "type": "string", "description": "String - Banner image URL for the collection" } } }, "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "acquiredAt": { "type": "object", "description": "Only present if the request specified `orderBy=transferTime`.", "properties": { "blockTimestamp": { "type": "string", "description": "Block timestamp of the block where the NFT was most recently acquired." }, "blockNumber": { "type": "string", "description": "Block number of the block where the NFT was most recently acquired." } } }, "animation": { "type": "object", "properties": { "cachedUrl": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer" }, "orginalUrl": { "type": "string" } } }, "mint": { "type": "object", "properties": { "mintAddress": { "type": "string", "description": "Address that minted the NFT" }, "blockNumber": { "type": "integer", "description": "Block number when the NFT was minted" }, "timestamp": { "type": "string", "description": "Timestamp when the NFT was minted" }, "transactionHash": { "type": "string", "description": "Transaction hash of the mint transaction" } } }, "owners": { "type": "array", "description": "List of all addresses that own the given NFT.", "items": { "type": "string" } } } } }, "pageKey": { "type": "string", "description": "String - An offset used for pagination. Can be passed back as the \"startToken\" of a subsequent request to get the next page of results. Absent if there are no more results." } } } } } } }, "operationId": "getNFTsForContract-v3" } }, "/v3/{apiKey}/getNFTsForCollection": { "get": { "summary": "NFTs By Collection", "description": "getNFTsForCollection - Retrieves all NFTs associated with a specific NFT collection. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string" }, "required": false }, { "name": "collectionSlug", "description": "String - OpenSea slug for the NFT collection.", "in": "query", "schema": { "type": "string", "default": "boredapeyachtclub" }, "required": false }, { "name": "withMetadata", "description": "Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`.", "schema": { "type": "boolean", "default": true }, "in": "query" }, { "name": "startToken", "description": "String - A tokenID offset used for pagination. Can be a hex string, or a decimal. Users can specify the offset themselves to start from a custom offset, or to fetch multiple token ranges in parallel.", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "description": "Integer - Sets the total number of NFTs returned in the response. Defaults to 100.", "in": "query", "schema": { "type": "integer" } }, { "name": "tokenUriTimeoutInMs", "description": "No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0.", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Returns a list of NFTs associated with the specified collection.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nfts": { "description": "List of objects that represent NFTs stored under the queried contract address or collection slug.", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "object", "properties": { "tokenId": { "type": "string", "default": "44" }, "tokenMetadata": { "type": "object", "properties": { "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." } } } } }, "tokenUri": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." } } }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "external_url": { "type": "string", "description": "String - The image URL that appears alongside the asset image on NFT platforms." }, "background_color": { "type": "string", "description": "String - Background color of the NFT item. Usually must be defined as a six-character hexadecimal." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." }, "media": { "type": "array", "items": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." }, "thumbnail": { "type": "string", "description": "URL for a resized thumbnail of the NFT media asset." }, "format": { "type": "string", "description": "The media format (jpg, gif, png, etc.) of the gateway and thumbnail assets." }, "bytes": { "type": "integer", "description": "The size of the media asset in bytes." } } } } } }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "contractMetadata": { "type": "object", "properties": { "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "opensea": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } } } } }, "nextToken": { "type": "string", "description": "String - An offset used for pagination. Can be passed back as the \"startToken\" of a subsequent request to get the next page of results. Absent if there are no more results." } } } } } } }, "operationId": "getNFTsForCollection-v3" } }, "/v3/{apiKey}/getNFTMetadata": { "get": { "summary": "NFT Metadata By Token ID", "description": "getNFTMetadata - Retrieves the metadata associated with a specific NFT. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": true }, { "name": "tokenId", "description": "String - The ID of the token. Can be in hex or decimal format.", "in": "query", "schema": { "type": "string", "default": "44" }, "required": true }, { "name": "tokenType", "description": "String - 'ERC721' or 'ERC1155'; specifies type of token to query for. API requests will perform faster if this is specified.", "in": "query", "schema": { "type": "string" } }, { "name": "tokenUriTimeoutInMs", "description": "No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0.", "in": "query", "schema": { "type": "integer" } }, { "name": "refreshCache", "description": "Defaults to false for faster response times. If true will refresh metadata for given token. If false will check the cache and use it or refresh if cache doesn't exist.", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Returns the metadata of the specified NFT.", "content": { "application/json": { "schema": { "type": "object", "description": "The object that represents an NFT and has all data corresponding to that NFT", "properties": { "contract": { "type": "object", "description": "The contract object that has details of a contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } }, "tokenId": { "type": "string", "default": "44" }, "tokenType": { "type": "string" }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Brief human-readable description" }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } }, "raw": { "type": "object", "description": "Raw details of the NFT like its tokenUri and metadata info obtained directly from the smart contract", "properties": { "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." } } }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." } } }, "collection": { "type": "object", "description": "The collection object that has details of a collection", "properties": { "name": { "type": "string", "description": "String - Collection name" }, "slug": { "type": "string", "description": "String - OpenSea collection slug" }, "externalUrl": { "type": "string", "description": "String - URL for the external site of the collection" }, "bannerImageUrl": { "type": "string", "description": "String - Banner image URL for the collection" } } }, "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "acquiredAt": { "type": "object", "description": "Only present if the request specified `orderBy=transferTime`.", "properties": { "blockTimestamp": { "type": "string", "description": "Block timestamp of the block where the NFT was most recently acquired." }, "blockNumber": { "type": "string", "description": "Block number of the block where the NFT was most recently acquired." } } }, "animation": { "type": "object", "properties": { "cachedUrl": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer" }, "orginalUrl": { "type": "string" } } }, "mint": { "type": "object", "properties": { "mintAddress": { "type": "string", "description": "Address that minted the NFT" }, "blockNumber": { "type": "integer", "description": "Block number when the NFT was minted" }, "timestamp": { "type": "string", "description": "Timestamp when the NFT was minted" }, "transactionHash": { "type": "string", "description": "Transaction hash of the mint transaction" } } }, "owners": { "type": "array", "description": "List of all addresses that own the given NFT.", "items": { "type": "string" } } } } } } } }, "operationId": "getNFTMetadata-v3" } }, "/v3/{apiKey}/getNFTMetadataBatch": { "post": { "summary": "NFT Metadata By Token ID [Batch]", "description": "getNFTMetadataBatch - Retrieves metadata for up to 100 specified NFT contracts in a single request. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "tokens" ], "properties": { "tokens": { "type": "array", "description": "List of token objects to batch request NFT metadata for. Maximum 100.", "items": { "type": "object", "required": [ "contractAddress", "tokenId" ], "properties": { "contractAddress": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "tokenId": { "type": "string", "default": "44" }, "tokenType": { "type": "string" } } } }, "tokenUriTimeoutInMs": { "type": "integer" }, "refreshCache": { "type": "boolean", "default": false } } } } } }, "responses": { "200": { "description": "Returns an array of NFT metadata corresponding to the batch query.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of NFT objects corresponding to the query", "items": { "type": "object", "description": "The object that represents an NFT and has all data corresponding to that NFT", "properties": { "contract": { "type": "object", "description": "The contract object that has details of a contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } }, "tokenId": { "type": "string", "default": "44" }, "tokenType": { "type": "string" }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Brief human-readable description" }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } }, "raw": { "type": "object", "description": "Raw details of the NFT like its tokenUri and metadata info obtained directly from the smart contract", "properties": { "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." } } }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." } } }, "collection": { "type": "object", "description": "The collection object that has details of a collection", "properties": { "name": { "type": "string", "description": "String - Collection name" }, "slug": { "type": "string", "description": "String - OpenSea collection slug" }, "externalUrl": { "type": "string", "description": "String - URL for the external site of the collection" }, "bannerImageUrl": { "type": "string", "description": "String - Banner image URL for the collection" } } }, "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "acquiredAt": { "type": "object", "description": "Only present if the request specified `orderBy=transferTime`.", "properties": { "blockTimestamp": { "type": "string", "description": "Block timestamp of the block where the NFT was most recently acquired." }, "blockNumber": { "type": "string", "description": "Block number of the block where the NFT was most recently acquired." } } }, "animation": { "type": "object", "properties": { "cachedUrl": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer" }, "orginalUrl": { "type": "string" } } }, "mint": { "type": "object", "properties": { "mintAddress": { "type": "string", "description": "Address that minted the NFT" }, "blockNumber": { "type": "integer", "description": "Block number when the NFT was minted" }, "timestamp": { "type": "string", "description": "Timestamp when the NFT was minted" }, "transactionHash": { "type": "string", "description": "Transaction hash of the mint transaction" } } }, "owners": { "type": "array", "description": "List of all addresses that own the given NFT.", "items": { "type": "string" } } } } } } } } }, "operationId": "getNFTMetadataBatch-v3" } }, "/v3/{apiKey}/getContractMetadata": { "get": { "summary": "Contract Metadata By Address", "description": "getContractMetadata - Retrieves high-level collection or contract-level information for an NFT. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": true } ], "responses": { "200": { "description": "Returns the contract metadata for the specified address.", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "description": "String - Contract address for the queried NFT collection" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } } } } } }, "operationId": "getContractMetadata-v3" } }, "/v3/{apiKey}/getContractMetadataBatch": { "post": { "summary": "Contract Metadata By Address [Batch]", "description": "getContractMetadataBatch - Retrieves metadata for a list of specified contract addresses in a single request.", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "contractAddresses": { "type": "array", "description": "List of contract addresses to batch metadata requests for.", "default": [ "0xe785E82358879F061BC3dcAC6f0444462D4b5330", "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d" ], "items": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" } } } } } } }, "responses": { "200": { "description": "Returns an array of contract metadata corresponding to the batch query.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of contract metadata objects corresponding to the query.", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "String - Contract address for the queried NFT collection" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } } } } } } }, "operationId": "getContractMetadataBatch-v3" } }, "/v3/{apiKey}/getOwnersForNFT": { "get": { "summary": "Owners By NFT", "description": "getOwnersForNFT - Retrieves the owner(s) for a specific token. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Ownership Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": true }, { "name": "tokenId", "description": "String - The ID of the token. Can be in hex or decimal format.", "in": "query", "schema": { "type": "string", "default": "44" }, "required": true } ], "responses": { "200": { "description": "Returns the owner(s) of the specified NFT.", "content": { "application/json": { "schema": { "type": "object", "properties": { "owners": { "type": "array", "description": "List of all addresses that own the given NFT.", "items": { "type": "string" } }, "pageKey": { "type": "string" } } }, "examples": { "getOwnersForNFT_response": { "value": { "owners": [ "0x9f4F78A6c4a5E6F8AFA81631b9120ae3C831b494" ], "pageKey": null } } } } } } }, "operationId": "getOwnersForNFT-v3" } }, "/v3/{apiKey}/getOwnersForContract": { "get": { "summary": "Owners By Contract", "description": "getOwnersForContract - Retrieves all owners associated with a specific NFT contract. This endpoint is supported on Ethereum and many L2s, including Polygon, Arbitrum, Optimism, Base, World Chain and more. See the full list of supported networks [here](https://dashboard.alchemy.com/chains).", "tags": [ "NFT Ownership Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0x495f947276749ce646f68ac8c248420045cb7b5e" }, "required": true }, { "name": "withTokenBalances", "description": "Boolean - If set to `true` the query will include the token balances per token id for each owner. `false` by default.", "in": "query", "schema": { "type": "boolean", "default": false } }, { "description": "String - used for contracts with >50,000 owners. `pageKey` field can be passed back as request parameter to get the next page of results.", "name": "pageKey", "schema": { "type": "string" }, "in": "query" } ], "responses": { "200": { "description": "Returns a list of all owners for the specified contract.", "content": { "application/json": { "schema": { "type": "object", "properties": { "owners": { "description": "List of all addresses that own one of the NFTs from the queried contract address. The format is applicable when `withTokenBalances=true`.", "type": "array", "items": { "type": "object", "properties": { "ownerAddress": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "tokenBalances": { "type": "array", "description": "a list of the token ids and balances for the owner of the collection", "items": { "type": "object", "properties": { "tokenId": { "type": "string", "description": "tokenId of the NFT in the collection that an owner has" }, "balance": { "type": "integer", "description": "the number of the specified token in the collection that the user owns" } } } } } } } } } } } } }, "operationId": "getOwnersForContract-v3" } }, "/v3/{apiKey}/isSpamContract": { "get": { "summary": "Is Spam Contract", "description": "Determines whether a specific contract is marked as spam by Alchemy.\n\nPlease note that this API endpoint is only available to paid tier customers. Upgrade your account [here](https://dashboard.alchemy.com/account).\n\nSpam NFT functionality is available on Mainnet for the following chains: Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast. More to come soon!\n", "tags": [ "NFT Spam Endpoints" ], "servers": [ { "url": "https://{network}.g.alchemy.com/nft", "variables": { "network": { "enum": [ "eth-mainnet", "polygon-mainnet" ], "default": "eth-mainnet" } } } ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0x495f947276749ce646f68ac8c248420045cb7b5e" }, "required": true } ], "responses": { "200": { "description": "Returns whether the specified contract is marked as spam.", "content": { "application/json": { "schema": { "type": "object", "description": "This object contains a boolean value indicating the spam status of the contract.", "properties": { "isSpamContract": { "type": "boolean", "description": "True - if the queried contract is marked as spam.\nFalse - if the queried contract is considered valid.\n" } } } } } } }, "operationId": "isSpamContract-v3" } }, "/v3/{apiKey}/getFloorPrice": { "get": { "summary": "Floor Prices By Slug", "description": "Retrieves the floor prices of an NFT collection across different marketplaces.\n\nPlease note that this endpoint is available on Ethereum mainnet, Arbitrum mainnet, and Base mainnet for Opensea, and on Ethereum mainnet for Looksrare.\n", "tags": [ "NFT Sales Endpoints" ], "servers": [ { "url": "https://{network}.g.alchemy.com/nft", "variables": { "network": { "enum": [ "eth-mainnet", "arb-mainnet", "base-mainnet" ], "default": "eth-mainnet" } } } ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0x1f02bf9dde7c79137a08b2dd4fc964bfd2499734" }, "required": true }, { "name": "collectionSlug", "description": "String - OpenSea slug for the NFT collection.", "in": "query", "schema": { "type": "string", "default": "boredapeyachtclub" }, "required": false } ], "responses": { "200": { "description": "Returns the floor prices of the specified NFT collection across different marketplaces.", "content": { "application/json": { "schema": { "type": "object", "properties": { "nftMarketplaceName": { "type": "object", "description": "Name of the NFT marketplace where the collection is listed (in camel case). Current marketplaces supported - `openSea`, `looksRare`. So instead of the word `nftMarketplaceName` you will see marketplace names like `openSea` here.", "properties": { "floorPrice": { "type": "number", "description": "Number - The floor price of the collection on the given marketplace." }, "priceCurrency": { "type": "string", "description": "String - The currency in which the floor price is denominated. Typically, denominated in ETH", "enum": [ "ETH" ] }, "collectionUrl": { "type": "string", "description": "String - Link to the collection on the given marketplace." }, "retrievedAt": { "type": "string", "description": "String - UTC timestamp of when the floor price was retrieved from the marketplace." }, "error": { "type": "string", "description": "String - Returns the error `unable to fetch floor price` if there was an error fetching floor prices from the given marketplace." } } } } } } } } }, "operationId": "getFloorPrice-v3" } }, "/v3/{apiKey}/getContractsForOwner": { "get": { "summary": "Contracts By Owner", "description": "getContractsForOwner - Retrieves all NFT contracts held by a specified owner address.", "tags": [ "NFT Ownership Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "owner", "description": "String - Address for NFT owner (can be in ENS format for Eth Mainnet).", "schema": { "type": "string", "default": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "in": "query", "required": true }, { "name": "pageKey", "description": "String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results.", "schema": { "type": "string" }, "in": "query" }, { "name": "pageSize", "description": "Number of NFTs to be returned per page. Defaults to 100. Max is 100.", "schema": { "type": "integer", "default": 100 }, "in": "query" }, { "name": "withMetadata", "description": "Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`.", "schema": { "type": "boolean", "default": true }, "in": "query" }, { "name": "includeFilters[]", "description": "Array of filters (as ENUMS) that will be applied to the query. Only NFTs that match one or more of these filters will be included in the response. May not be used in conjunction with excludeFilters[]. Filter Options:\n - SPAM: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. Please note that this filter is currently supported on Mainnet for Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast, and is **available exclusively on paid tiers**.\n - AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.\n - To learn more about spam, you can refer to this: [Spam NFTs and how to fix them](https://www.alchemy.com/overviews/spam-nfts)", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SPAM", "AIRDROPS" ], "default": "SPAM" } }, "in": "query" }, { "name": "excludeFilters[]", "description": "Array of filters (as ENUMS) that will be applied to the query. NFTs that match one or more of these filters will be excluded from the response. May not be used in conjunction with includeFilters[]. Filter Options:\n - SPAM: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. Please note that this filter is currently supported on Mainnet for Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast, and is **available exclusively on paid tiers**.\n - AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.\n - To learn more about spam, you can refer to this: [Spam NFTs and how to fix them](https://www.alchemy.com/overviews/spam-nfts)", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SPAM", "AIRDROPS" ], "default": "SPAM" } }, "in": "query" }, { "name": "orderBy", "description": "Enum - ordering scheme to use for ordering NFTs in the response. If unspecified, NFTs will be ordered by contract address and token ID.\n - transferTime: NFTs will be ordered by the time they were transferred into the wallet, with newest NFTs first. Note: This ordering is supported on Ethereum Mainnet, Optimism Mainnet, Polygon Mainnet, Base Mainnet, Arbitrum One, Polygon Amoy, Base Sepolia, Arbitrum Sepolia, Ethereum Sepolia, and Optimism Sepolia.", "in": "query", "schema": { "type": "string", "enum": [ "transferTime" ] }, "required": false }, { "name": "spamConfidenceLevel", "description": "Enum - the confidence level at which to filter spam at.\n\nConfidence Levels:\n - VERY_HIGH\n - HIGH\n - MEDIUM\n - LOW\n\nThe confidence level set means that any spam that is at that confidence level or higher will be filtered out. For example, if the confidence level is HIGH, contracts that we have HIGH or VERY_HIGH confidence in being spam will be filtered out from the response. \nDefaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet.\n\n**Please note that this filter is only available on paid tiers. Upgrade your account [here](https://dashboard.alchemy.com/settings/billing/).**", "schema": { "type": "string", "enum": [ "VERY_HIGH", "HIGH", "MEDIUM", "LOW" ] }, "in": "query", "required": false } ], "responses": { "200": { "description": "Returns a list of NFT contracts held by the specified owner address.", "content": { "application/json": { "schema": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "type": "object", "description": "The object that represents a smart contract and has all data corresponding to that contract", "properties": { "address": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "name": { "description": "The name of the contract, i.e. \"Bored Ape Yacht Club\".", "type": "string" }, "symbol": { "description": "The symbol of the contract, i.e. BAYC.", "type": "string" }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string" }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "totalBalance": { "type": "number", "description": "Sum of NFT balances across all token IDs held by the owner. For non-fungible tokens this will be equal to the `numDistinctTokensOwned`, but it may be higher if the user holds some fungible ERC1155 tokens." }, "numDistinctTokensOwned": { "type": "number", "description": "Number of distinct token IDs held by the owner. For non-fungible tokens this will be equal to the `totalBalance`, but it may be lower if the user holds some fungible ERC1155 tokens." }, "isSpam": { "type": "boolean", "description": "`True` if the contract is detected as spam contract. `False` if it is not spam or has not been evaluated by our system yet" }, "displayNft": { "type": "object", "description": "Details of the display NFT for this contract. This NFT and its image can be used to represent the contract when displaying info about it.", "properties": { "tokenId": { "description": "One of the tokens from this contract held by the owner.", "type": "string" }, "name": { "description": "The title of the token held by the owner i.e. \"Something #22\".", "type": "string" } } }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } } } } }, "pageKey": { "type": "string" }, "totalCount": { "type": "string", "description": "String - Total number of NFT contracts held by the given address returned in this page." } } }, "examples": { "withoutMetadata": { "summary": "Response (withMetadata = false)", "value": { "contracts": [ { "address": "0x000386e3f7559d9b6a2f5c46b4ad1a9587d59dc3", "totalBalance": 912, "numDistinctTokensOwned": 80, "isSpam": true, "tokenId": "0x0000000000000000000000000000000000000000000000000000000000000001" }, { "address": "0x0015f391949f25c3211063104ad4afc99210f85c", "totalBalance": 17, "numDistinctTokensOwned": 6, "isSpam": true, "tokenId": "0x0000000000000000000000000000000000000000000000000000000000000002" }, { "address": "0x005b92d71a934dbe48e985b6469881cf4b0308fc", "totalBalance": 1, "numDistinctTokensOwned": 1, "isSpam": true, "tokenId": "0x0000000000000000000000000000000000000000000000000000000000000003" } ], "totalCount": 2120, "pageKey": "20ef9df5-0d81-42e5-b741-140f595a407b" } }, "withMetadata": { "summary": "Response (withMetadata = true)", "value": { "contracts": [ { "address": "0x1C310c2fbB0D9755A6b918F990bC8D3504f2c684", "name": "The Wonderful Husl Founder Cards", "symbol": "The Wonderful Husl Founder Cards", "totalSupply": null, "tokenType": "ERC1155", "contractDeployer": "0x0bdD0AEC835F92a465290cdd57b27FBd00376F53", "deployedBlockNumber": 15664554, "openSeaMetadata": { "floorPrice": null, "collectionName": "The Wonderful Husl Founder Cards", "safelistRequestStatus": "not_requested", "imageUrl": "https://i.seadn.io/gcs/files/754e38769c80c9d6188444dddb10ec80.png?w=500&auto=format", "description": "[Husl](https://www.huslnft.xyz) is building the bridge between business and NFTs. Husl Founders are the driven, the passionate and the focused members of the community ready to change their future. Owning a Founders Card gets you exclusive perks, early access to business management, and discounts on managed services for your business as NFT. [Learn More](https://www.huslnft.xyz)", "externalUrl": "https://www.huslnft.xyz", "twitterUsername": null, "discordUrl": null, "lastIngestedAt": "2023-03-20T01:36:19.000Z" }, "totalBalance": "1", "numDistinctTokensOwned": "1", "isSpam": true, "displayNft": { "tokenId": "233", "name": null }, "image": { "cachedUrl": "https://nft-cdn.alchemy.com/eth-mainnet/d08d0d0fac8edf36ea09eae34b332814", "thumbnailUrl": "https://res.cloudinary.com/alchemyapi/image/upload/thumbnailv2/eth-mainnet/d08d0d0fac8edf36ea09eae34b332814", "pngUrl": "https://res.cloudinary.com/alchemyapi/image/upload/convert-png/eth-mainnet/d08d0d0fac8edf36ea09eae34b332814", "contentType": "video/mp4", "size": 36190302, "originalUrl": "https://ipfs.io/ipfs/QmX2mM8r33W7KUBQSWXFAKNC2t654EXmWiX9vkrfrEaEnS" } } ], "totalCount": 2120, "pageKey": "03949322-9b2c-4fdd-aab6-1369e29fa5b2" } } } } } } }, "operationId": "getContractsForOwner-v3" } }, "/v3/{apiKey}/reportSpam": { "get": { "summary": "Report Spam Address", "description": "Reports a specific address to the API if it is suspected to be spam.\n\nSpam NFT functionality is available on Mainnet for the following chains: Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast. More to come soon!\n", "tags": [ "NFT Spam Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, { "name": "address", "description": "String - The address to check for spam status.", "in": "query", "schema": { "type": "string", "default": "0x495f947276749ce646f68ac8c248420045cb7b5e" }, "required": true }, { "name": "isSpam", "in": "query", "required": true, "schema": { "type": "boolean", "description": "Whether the address is spam.", "default": true } } ], "responses": { "200": { "description": "Returns a confirmation message if the address was successfully reported as spam.", "content": { "application/json": { "schema": { "type": "string", "description": "String - \"Address was successfully reported as spam\" if calling the API was successful." } } } } }, "operationId": "reportSpam-v3" } }, "/v3/{apiKey}/refreshNftMetadata": { "post": { "summary": "Refresh NFT Metadata", "description": "This endpoint is available to Enterprise customers only. [Contact sales](https://www.alchemy.com/contact-sales) to request access before using it.\n\nSubmits a request for Alchemy to refresh the cached metadata of a specific NFT token.\n\nPlease note that this endpoint is only supported on Ethereum (Mainnet & Sepolia), Polygon (Mainnet & Amoy), Arbitrum One (mainnet), Optimism (mainnet) & Base (mainnet). For other chains, you could use the `getNFTMetadata` endpoint with the `refreshCache` parameter set to `true` to refresh the metadata!\n", "tags": [ "NFT Metadata Endpoints" ], "parameters": [ { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "contractAddress", "tokenId" ], "properties": { "contractAddress": { "type": "string", "description": "Contract address of the token you want to refresh.", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "tokenId": { "type": "string", "description": "Token ID of the token you want to refresh. Must belong to the contract address.", "default": "44" } } } } } }, "responses": { "200": { "description": "Returns the status of the refresh request along with the estimated time to complete.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "If the token is successfully queued for ingestion the value will be \"Queued\"." }, "estimatedMsToRefresh": { "type": "string", "description": "Estimated time until the metadata refresh is complete for this token." } } }, "examples": { "byDefault": { "summary": "Successful Response", "value": { "status": "Queued", "estimatedMsToRefresh": 10000 } } } } } } }, "operationId": "refreshNftMetadata-v3" } } }, "components": { "parameters": { "apiKey": { "name": "apiKey", "in": "path", "schema": { "type": "string", "default": "docs-demo", "description": "For higher throughput, [create your own API key](https://dashboard.alchemy.com/signup)" }, "required": true }, "owner": { "name": "owner", "description": "String - Address for NFT owner (can be in ENS format for Eth Mainnet).", "schema": { "type": "string", "default": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "in": "query", "required": true }, "wallet": { "name": "wallet", "description": "String - Wallet address to check for contract ownership.", "schema": { "type": "string", "default": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" }, "in": "query", "required": true }, "pageKey": { "name": "pageKey", "description": "String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results.", "schema": { "type": "string" }, "in": "query" }, "pageSize": { "name": "pageSize", "description": "Number of NFTs to be returned per page. Defaults to 100. Max is 100.", "schema": { "type": "integer", "default": 100 }, "in": "query" }, "getOwnersForTokenPageSize": { "name": "pageSize", "description": "Number of owners to be returned per page.", "schema": { "type": "integer" }, "in": "query" }, "contractAddresses": { "name": "contractAddresses[]", "description": "Array of contract addresses to filter the responses with. Max limit 45 contracts.", "schema": { "type": "array", "items": { "type": "string" } }, "in": "query" }, "withMetadata": { "name": "withMetadata", "description": "Boolean - if set to `true`, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to `true`.", "schema": { "type": "boolean", "default": true }, "in": "query" }, "excludeFilters": { "name": "excludeFilters[]", "description": "Array of filters (as ENUMS) that will be applied to the query. NFTs that match one or more of these filters will be excluded from the response. May not be used in conjunction with includeFilters[]. Filter Options:\n - SPAM: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. Please note that this filter is currently supported on Mainnet for Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast, and is **available exclusively on paid tiers**.\n - AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.\n - To learn more about spam, you can refer to this: [Spam NFTs and how to fix them](https://www.alchemy.com/overviews/spam-nfts)", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SPAM", "AIRDROPS" ], "default": "SPAM" } }, "in": "query" }, "address": { "name": "address", "description": "String - any valid blockchain address for NFT collections, contracts, mints, etc.", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": false }, "addressRequired": { "name": "address", "description": "String - any valid blockchain address for NFT collections, contracts, mints, etc.", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": true }, "includeFilters": { "name": "includeFilters[]", "description": "Array of filters (as ENUMS) that will be applied to the query. Only NFTs that match one or more of these filters will be included in the response. May not be used in conjunction with excludeFilters[]. Filter Options:\n - SPAM: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. Please note that this filter is currently supported on Mainnet for Base, Arbitrum, Optimism, Ethereum, Polygon, Worldchain, Avax, BNB, Gnosis, Zksync, Unichain, and Blast, and is **available exclusively on paid tiers**.\n - AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.\n - To learn more about spam, you can refer to this: [Spam NFTs and how to fix them](https://www.alchemy.com/overviews/spam-nfts)", "schema": { "type": "array", "items": { "type": "string", "enum": [ "SPAM", "AIRDROPS" ], "default": "SPAM" } }, "in": "query" }, "spamConfidenceLevel": { "name": "spamConfidenceLevel", "description": "Enum - the confidence level at which to filter spam at.\n\nConfidence Levels:\n - VERY_HIGH\n - HIGH\n - MEDIUM\n - LOW\n\nThe confidence level set means that any spam that is at that confidence level or higher will be filtered out. For example, if the confidence level is HIGH, contracts that we have HIGH or VERY_HIGH confidence in being spam will be filtered out from the response. \nDefaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet.\n\n**Please note that this filter is only available on paid tiers. Upgrade your account [here](https://dashboard.alchemy.com/settings/billing/).**", "schema": { "type": "string", "enum": [ "VERY_HIGH", "HIGH", "MEDIUM", "LOW" ] }, "in": "query", "required": false }, "collectionSlug": { "name": "collectionSlug", "description": "String - OpenSea slug for the NFT collection.", "in": "query", "schema": { "type": "string", "default": "boredapeyachtclub" }, "required": false }, "contractAddressRequired": { "name": "contractAddress", "description": "String - Contract address for the NFT contract (ERC721 and ERC1155 supported).", "in": "query", "schema": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "required": true }, "tokenId": { "name": "tokenId", "description": "String - The ID of the token. Can be in hex or decimal format.", "in": "query", "schema": { "type": "string", "default": "44" }, "required": true }, "tokenIdV3": { "name": "tokenId", "description": "String - The ID of the token in decimal format.", "in": "query", "schema": { "type": "string", "default": "44" }, "required": true }, "tokenIdForNFTSales": { "name": "tokenId", "description": "String - The ID of the token. Can be in hex or decimal format.", "in": "query", "schema": { "type": "string", "default": "44" }, "required": false }, "tokenType": { "name": "tokenType", "description": "String - 'ERC721' or 'ERC1155'; specifies type of token to query for. API requests will perform faster if this is specified.", "in": "query", "schema": { "type": "string" } }, "startToken": { "name": "startToken", "description": "String - A tokenID offset used for pagination. Can be a hex string, or a decimal. Users can specify the offset themselves to start from a custom offset, or to fetch multiple token ranges in parallel.", "in": "query", "schema": { "type": "string" } }, "limit": { "name": "limit", "description": "Integer - Sets the total number of NFTs returned in the response. Defaults to 100.", "in": "query", "schema": { "type": "integer" } }, "tokenUriTimeoutInMs": { "name": "tokenUriTimeoutInMs", "description": "No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to _only_ access the cache and not live fetch any metadata for cache misses then set this value to 0.", "in": "query", "schema": { "type": "integer" } }, "withTokenBalances": { "name": "withTokenBalances", "description": "Boolean - If set to `true` the query will include the token balances per token id for each owner. `false` by default.", "in": "query", "schema": { "type": "boolean", "default": false } }, "refreshCache": { "name": "refreshCache", "description": "Defaults to false for faster response times. If true will refresh metadata for given token. If false will check the cache and use it or refresh if cache doesn't exist.", "in": "query", "schema": { "type": "boolean", "default": false } }, "block": { "name": "block", "description": "String - The point in time or block number (in hex or decimal) to fetch collection ownership information for.", "in": "query", "schema": { "type": "string" } }, "fromBlock": { "name": "fromBlock", "description": "String - The block number to start fetching NFT sales data from. Allowed values are decimal and hex integers, and \"latest\". Defaults to \"0\".", "in": "query", "schema": { "type": "string", "default": "0" } }, "order": { "name": "order", "description": "Enum - Whether to return the results ascending from startBlock or descending from startBlock. Defaults to descending (false).", "in": "query", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, "orderBy": { "name": "orderBy", "description": "Enum - ordering scheme to use for ordering NFTs in the response. If unspecified, NFTs will be ordered by contract address and token ID.\n - transferTime: NFTs will be ordered by the time they were transferred into the wallet, with newest NFTs first. Note: This ordering is supported on Ethereum Mainnet, Optimism Mainnet, Polygon Mainnet, Base Mainnet, Arbitrum One, Polygon Amoy, Base Sepolia, Arbitrum Sepolia, Ethereum Sepolia, and Optimism Sepolia.", "in": "query", "schema": { "type": "string", "enum": [ "transferTime" ] }, "required": false }, "marketplace": { "name": "marketplace", "description": "Enum - The name of the NFT marketplace to filter sales by. The endpoint currently supports \"seaport\", \"wyvern\", \"looksrare\", \"x2y2\", \"blur\", and \"cryptopunks\". Defaults to returning sales from all supported marketplaces.", "in": "query", "schema": { "type": "string", "enum": [ "seaport", "looksrare", "x2y2", "wyvern", "blur", "cryptopunks" ] }, "required": false }, "buyerAddress": { "name": "buyerAddress", "description": "String - The address of the NFT buyer to filter sales by. Defaults to returning sales involving any buyer.", "in": "query", "schema": { "type": "string" } }, "sellerAddress": { "name": "sellerAddress", "description": "String - The address of the NFT seller to filter sales by. Defaults to returning sales involving any seller.", "in": "query", "schema": { "type": "string" } }, "taker": { "name": "taker", "description": "Enum - Filter by whether the buyer or seller was the taker in the NFT trade. Allowed filter values are \"BUYER\" and \"SELLER\". Defaults to returning both buyer and seller taker trades.", "in": "query", "schema": { "type": "string", "enum": [ "BUYER", "SELLER" ] }, "required": false }, "query": { "name": "query", "description": "String - The search string that you want to search for in contract metadata", "in": "query", "schema": { "type": "string", "default": "bored" }, "required": true } }, "schemas": { "rawv3": { "type": "object", "description": "Raw details of the NFT like its tokenUri and metadata info obtained directly from the smart contract", "properties": { "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." } } }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." } } }, "id": { "type": "object", "properties": { "tokenId": { "type": "string", "default": "44" }, "tokenMetadata": { "type": "object", "properties": { "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." } } } } }, "idV3": { "type": "object", "properties": { "tokenId": { "type": "string", "default": "44" }, "tokenMetadata": { "type": "object", "properties": { "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." } } } } }, "tokenUri": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." } } }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "external_url": { "type": "string", "description": "String - The image URL that appears alongside the asset image on NFT platforms." }, "background_color": { "type": "string", "description": "String - Background color of the NFT item. Usually must be defined as a six-character hexadecimal." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." }, "media": { "type": "array", "items": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." }, "thumbnail": { "type": "string", "description": "URL for a resized thumbnail of the NFT media asset." }, "format": { "type": "string", "description": "The media format (jpg, gif, png, etc.) of the gateway and thumbnail assets." }, "bytes": { "type": "integer", "description": "The size of the media asset in bytes." } } } } } }, "ownedContract": { "type": "object", "description": "The object that represents a smart contract and has all data corresponding to that contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "totalBalance": { "type": "number", "description": "Sum of NFT balances across all token IDs held by the owner. For non-fungible tokens this will be equal to the `numDistinctTokensOwned`, but it may be higher if the user holds some fungible ERC1155 tokens." }, "numDistinctTokensOwned": { "type": "number", "description": "Number of distinct token IDs held by the owner. For non-fungible tokens this will be equal to the `totalBalance`, but it may be lower if the user holds some fungible ERC1155 tokens." }, "isSpam": { "type": "boolean" }, "tokenId": { "description": "One of the tokens from this contract held by the owner.", "type": "string" }, "name": { "description": "The name of the contract, i.e. \"Bored Ape Yacht Club\".", "type": "string" }, "title": { "description": "The title of the token held by the owner i.e. \"Something #22\".", "type": "string" }, "symbol": { "description": "The symbol of the contract, i.e. BAYC.", "type": "string" }, "tokenType": { "description": "The NFT standard used by the contract, i.e. ERC721 or ERC1155.", "type": "string" }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "media": { "type": "array", "items": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." }, "thumbnail": { "type": "string", "description": "URL for a resized thumbnail of the NFT media asset." }, "format": { "type": "string", "description": "The media format (jpg, gif, png, etc.) of the gateway and thumbnail assets." }, "bytes": { "type": "integer", "description": "The size of the media asset in bytes." } } } }, "opensea": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } }, "ownedContractv3": { "type": "object", "description": "The object that represents a smart contract and has all data corresponding to that contract", "properties": { "address": { "type": "string", "default": "0xe785E82358879F061BC3dcAC6f0444462D4b5330" }, "name": { "description": "The name of the contract, i.e. \"Bored Ape Yacht Club\".", "type": "string" }, "symbol": { "description": "The symbol of the contract, i.e. BAYC.", "type": "string" }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string" }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "totalBalance": { "type": "number", "description": "Sum of NFT balances across all token IDs held by the owner. For non-fungible tokens this will be equal to the `numDistinctTokensOwned`, but it may be higher if the user holds some fungible ERC1155 tokens." }, "numDistinctTokensOwned": { "type": "number", "description": "Number of distinct token IDs held by the owner. For non-fungible tokens this will be equal to the `totalBalance`, but it may be lower if the user holds some fungible ERC1155 tokens." }, "isSpam": { "type": "boolean", "description": "`True` if the contract is detected as spam contract. `False` if it is not spam or has not been evaluated by our system yet" }, "displayNft": { "type": "object", "description": "Details of the display NFT for this contract. This NFT and its image can be used to represent the contract when displaying info about it.", "properties": { "tokenId": { "description": "One of the tokens from this contract held by the owner.", "type": "string" }, "name": { "description": "The title of the token held by the owner i.e. \"Something #22\".", "type": "string" } } }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } } } }, "ownedCollectionv3": { "type": "object", "description": "Metadata for an NFT collection held by an owner address. Includes general metadata about the collection, as well as information specific to the owner such as the total balance and the token ID of a random NFT for display purposes.", "properties": { "name": { "description": "The name of the collection, i.e. \"Bored Ape Yacht Club\".", "type": "string" }, "slug": { "description": "The human-readable string used to identify the collection on OpenSea.", "type": "string" }, "floorPrice": { "type": "object", "description": "Floor price data for the collection", "properties": { "marketplace": { "description": "The marketplace the floor price is on", "type": "string" }, "floorPrice": { "description": "Floor price of the collection on the marketplace", "type": "number" }, "priceCurrency": { "description": "The currency of the floor price", "type": "string" } } }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "contract": { "type": "object", "description": "Contract-level data for a collection, such as contract type, name, and symbol.", "properties": { "address": { "description": "Address of the contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" } } }, "totalBalance": { "type": "number", "description": "Sum of NFT balances across all token IDs held by the owner. For non-fungible tokens this will be equal to the `numDistinctTokensOwned`, but it may be higher if the user holds some fungible ERC1155 tokens." }, "numDistinctTokensOwned": { "type": "number", "description": "Number of distinct token IDs held by the owner. For non-fungible tokens this will be equal to the `totalBalance`, but it may be lower if the user holds some fungible ERC1155 tokens." }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "displayNft": { "type": "object", "description": "Details of the display NFT for this contract. This NFT and its image can be used to represent the contract when displaying info about it.", "properties": { "tokenId": { "description": "One of the tokens from this contract held by the owner.", "type": "string" }, "name": { "description": "The title of the token held by the owner i.e. \"Something #22\".", "type": "string" } } }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } } } }, "ownedCollectionContract": { "type": "object", "description": "Contract-level data for a collection, such as contract type, name, and symbol.", "properties": { "address": { "description": "Address of the contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" } } }, "media": { "type": "array", "items": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." }, "thumbnail": { "type": "string", "description": "URL for a resized thumbnail of the NFT media asset." }, "format": { "type": "string", "description": "The media format (jpg, gif, png, etc.) of the gateway and thumbnail assets." }, "bytes": { "type": "integer", "description": "The size of the media asset in bytes." } } } }, "ownedNFT": { "type": "object", "description": "The object that represents an NFT and has all data corresponding to that NFT", "properties": { "contract": { "description": "Object - Contract for returned NFT", "type": "object", "properties": { "address": { "type": "string", "description": "String - Address of NFT contract." } } }, "id": { "type": "object", "properties": { "tokenId": { "type": "string", "default": "44" }, "tokenMetadata": { "type": "object", "properties": { "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." } } } } }, "balance": { "type": "string", "description": "String - Token balance" }, "title": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Brief human-readable description" }, "tokenUri": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." } } }, "media": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." }, "thumbnail": { "type": "string", "description": "URL for a resized thumbnail of the NFT media asset." }, "format": { "type": "string", "description": "The media format (jpg, gif, png, etc.) of the gateway and thumbnail assets." }, "bytes": { "type": "integer", "description": "The size of the media asset in bytes." } } }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "external_url": { "type": "string", "description": "String - The image URL that appears alongside the asset image on NFT platforms." }, "background_color": { "type": "string", "description": "String - Background color of the NFT item. Usually must be defined as a six-character hexadecimal." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." }, "media": { "type": "array", "items": { "type": "object", "properties": { "raw": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "gateway": { "type": "string", "description": "String - Public gateway uri for the raw uri above." }, "thumbnail": { "type": "string", "description": "URL for a resized thumbnail of the NFT media asset." }, "format": { "type": "string", "description": "The media format (jpg, gif, png, etc.) of the gateway and thumbnail assets." }, "bytes": { "type": "integer", "description": "The size of the media asset in bytes." } } } } } }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." }, "contractMetadata": { "type": "object", "properties": { "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "opensea": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } }, "spamInfo": { "type": "object", "description": "Information about whether and why a contract was marked as spam.", "properties": { "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } }, "acquiredAt": { "type": "object", "description": "Only present if the request specified `orderBy=transferTime`.", "properties": { "blockTimestamp": { "type": "string", "description": "Block timestamp of the block where the NFT was most recently acquired." }, "blockNumber": { "type": "string", "description": "Block number of the block where the NFT was most recently acquired." } } } } }, "ownedNFTv3": { "type": "object", "description": "The object that represents an NFT and has all data corresponding to that NFT", "properties": { "contract": { "type": "object", "description": "The contract object that has details of a contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } }, "tokenId": { "type": "string", "default": "44" }, "tokenType": { "type": "string" }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Brief human-readable description" }, "image": { "type": "object", "description": "Details of the image corresponding to this contract", "properties": { "cachedUrl": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "thumbnailUrl": { "type": "string", "description": "The Url that has the thumbnail version of the NFT" }, "pngUrl": { "type": "string", "description": "The Url that has the NFT image in png" }, "contentType": { "type": "string", "description": "The Url of the image stored in Alchemy cache" }, "size": { "type": "integer", "description": "The size of the media asset in bytes." }, "originalUrl": { "type": "string", "description": "The original Url of the image coming straight from the smart contract" } } }, "raw": { "type": "object", "description": "Raw details of the NFT like its tokenUri and metadata info obtained directly from the smart contract", "properties": { "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "metadata": { "type": "object", "description": "Relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri to parse manually.", "properties": { "image": { "type": "string", "description": "String - URL to the NFT asset image. Can be standard URLs pointing to images on conventional servers, IPFS, or Arweave. Most types of images (SVGs, PNGs, JPEGs, etc.) are supported by NFT marketplaces." }, "name": { "type": "string", "description": "String - Name of the NFT asset." }, "description": { "type": "string", "description": "String - Human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)" }, "attributes": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "trait_type": { "type": "string" } } }, "description": "Object - Traits/attributes/characteristics for each NFT asset." } } }, "error": { "type": "string", "description": "String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT." } } }, "collection": { "type": "object", "description": "The collection object that has details of a collection", "properties": { "name": { "type": "string", "description": "String - Collection name" }, "slug": { "type": "string", "description": "String - OpenSea collection slug" }, "externalUrl": { "type": "string", "description": "String - URL for the external site of the collection" }, "bannerImageUrl": { "type": "string", "description": "String - Banner image URL for the collection" } } }, "tokenUri": { "type": "string", "description": "String - Uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata field is not automatically populated." }, "timeLastUpdated": { "type": "string", "description": "String - ISO timestamp of the last cache refresh for the information returned in the metadata field." }, "acquiredAt": { "type": "object", "description": "Only present if the request specified `orderBy=transferTime`.", "properties": { "blockTimestamp": { "type": "string", "description": "Block timestamp of the block where the NFT was most recently acquired." }, "blockNumber": { "type": "string", "description": "Block number of the block where the NFT was most recently acquired." } } }, "animation": { "type": "object", "properties": { "cachedUrl": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer" }, "orginalUrl": { "type": "string" } } }, "mint": { "type": "object", "properties": { "mintAddress": { "type": "string", "description": "Address that minted the NFT" }, "blockNumber": { "type": "integer", "description": "Block number when the NFT was minted" }, "timestamp": { "type": "string", "description": "Timestamp when the NFT was minted" }, "transactionHash": { "type": "string", "description": "Transaction hash of the mint transaction" } } }, "owners": { "type": "array", "description": "List of all addresses that own the given NFT.", "items": { "type": "string" } } } }, "contractMetadata": { "type": "object", "properties": { "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "opensea": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } }, "contractMetadatav3": { "type": "object", "properties": { "address": { "type": "string", "description": "String - Contract address for the queried NFT collection" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } } } }, "contractv3": { "type": "object", "description": "The contract object that has details of a contract", "properties": { "address": { "description": "Address of the held contract", "type": "string" }, "name": { "type": "string", "description": "String - NFT contract name." }, "symbol": { "type": "string", "description": "String - NFT contract symbol abbreviation." }, "totalSupply": { "type": "string", "description": "String - Total number of NFTs in a given NFT collection." }, "tokenType": { "type": "string", "enum": [ "ERC721", "ERC1155", "NO_SUPPORTED_NFT_STANDARD", "NOT_A_CONTRACT" ], "description": "String - For valid NFTs, 'ERC721' or 'ERC1155.' For invalid NFTs, a descriptive reason such as 'NO_SUPPORTED_NFT_STANDARD' if the input contract address doesn't support a known NFT standard, or 'NOT_A_CONTRACT' if there is no contract deployed at the input address." }, "contractDeployer": { "type": "string", "description": "String - Address that deployed the smart contract" }, "deployedBlockNumber": { "type": "number", "description": "Number - The Block Number when the deployment transaction is successfully mined" }, "openseaMetadata": { "type": "object", "description": "Note that the OpenSea metadata object is currently only available on ETH and Polygon Mainnet. Please reach out to us at support@alchemy.com if you would like to access this data on other networks.", "properties": { "floorPrice": { "type": "number", "description": "NFT floor price" }, "collectionName": { "type": "string", "description": "OpenSea collection name" }, "safelistRequestStatus": { "type": "string", "description": "Collection approval status within OpenSea. For more info, see the Opensea docs at docs.opensea.io/reference/collection-model" }, "imageUrl": { "type": "string", "description": "OpenSea CDN image URL" }, "description": { "type": "string", "description": "OpenSea collection description. Note: this value is truncated to 255 characters." }, "externalUrl": { "type": "string", "description": "Collection homepage" }, "twitterUsername": { "type": "string", "description": "The twitter username of the collection" }, "discordUrl": { "type": "string", "description": "The discord URL of the collection" }, "bannerImageUrl": { "type": "string", "description": "The banner image URL of the collection" }, "lastIngestedAt": { "type": "string", "description": "The timestamp when the collection was last ingested by us" } } }, "isSpam": { "type": "string", "description": "\"true\" if contract is spam, else \"false\". **Only available on paid tiers.**" }, "spamClassifications": { "description": "List of reasons why a contract was classified as spam. **Only available on paid tiers.**", "type": "array", "items": { "type": "string" } } } } } } }