# getSpamContracts GET https://eth-mainnet.g.alchemy.com/nft/v2/{apiKey}/getSpamContracts Returns a list of all spam contracts marked by Alchemy. Reference: https://www.alchemy.com/docs/reference/nft-api-endpoints/nft-api-endpoints/nft-api-v-2-methods-older-version/get-spam-contracts ## Code Examples ### cURL ```bash curl --request GET \ --url https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getSpamContracts ``` ### JavaScript ```javascript const options = {method: 'GET'}; fetch('https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getSpamContracts', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err)); ``` ### Python ```python import requests url = "https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getSpamContracts" response = requests.get(url) print(response.text) ``` ### Go ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getSpamContracts" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` ### Java ```java HttpResponse response = Unirest.get("https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getSpamContracts") .asString(); ``` ### C# ```csharp using RestSharp; var options = new RestClientOptions("https://eth-mainnet.g.alchemy.com/nft/v2/docs-demo/getSpamContracts"); var client = new RestClient(options); var request = new RestRequest(""); var response = await client.GetAsync(request); Console.WriteLine("{0}", response.Content); ``` ## OpenAPI Specification ```yaml 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 - arbnova-mainnet - avax-mainnet - avax-fuji - base-mainnet - base-sepolia - berachain-mainnet - blast-mainnet - blast-sepolia - bnb-mainnet - celo-mainnet - celo-sepolia - gnosis-mainnet - gnosis-chiado - lens-mainnet - lens-sepolia - linea-mainnet - linea-sepolia - polygon-mainnet - polygon-amoy - monad-testnet - mythos-mainnet - opt-mainnet - opt-sepolia - robinhood-testnet - ronin-mainnet - ronin-saigon - rootstock-mainnet - rootstock-testnet - scroll-mainnet - scroll-sepolia - settlus-mainnet - settlus-septestnet - shape-mainnet - shape-sepolia - soneium-mainnet - soneium-minato - starknet-mainnet - starknet-sepolia - 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. - 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: - 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**. - 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. - 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: - 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**. - 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. - 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. Confidence Levels: - VERY_HIGH - HIGH - MEDIUM - LOW The 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. Defaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet. **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. Visit [Website](https://knightsofchain.link) and get your benefits. (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}/getCollectionMetadata: get: summary: Collection Metadata By Slug description: getCollectionMetadata - Retrieves high-level collection or contract-level information for an 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: collectionSlug description: String - OpenSea slug for the NFT collection. in: query schema: type: string default: boredapeyachtclub required: true responses: '200': description: Returns the collection metadata for the specified slug. content: application/json: schema: type: object properties: name: type: string description: String - Name of the queried NFT Collection 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 operationId: getCollectionMetadata-v3 /v3/{apiKey}/invalidateContract: get: summary: Invalidate Contract Cache description: | Marks all cached tokens for the specified contract as stale, ensuring the next query fetches live data instead of cached data. Please note that this endpoint is only available on **Ethereum**, **Polygon**, **Arbitrum**, **Optimism** & **Base** networks. 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 confirmation of cache invalidation along with the number of tokens invalidated. content: application/json: schema: type: object description: | True - if the queried contract is marked as spam. False - if the queried contract is considered valid. properties: success: type: string description: | True if the contract was invalidated. False - if it wasn't. numTokensInvalidated: type: number description: The number of tokens that were invalidated as a result of running this query. operationId: invalidateContract-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}/getSpamContracts: get: summary: Spam Contracts description: | Returns a list of all spam contracts marked by Alchemy. Please note that this API endpoint is only available to paid tier customers. Upgrade your account [here](https://dashboard.alchemy.com/account). Spam 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! 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 responses: '200': description: Returns a list of all spam contracts marked by Alchemy. content: application/json: schema: type: object description: Object that contains a list of contract addresses. properties: contractAddresses: type: array items: type: string description: A list of contract addresses earmarked as spam by Alchemy. operationId: getSpamContracts-v3 /v3/{apiKey}/isSpamContract: get: summary: Is Spam Contract description: | Determines whether a specific contract is marked as spam by Alchemy. Please note that this API endpoint is only available to paid tier customers. Upgrade your account [here](https://dashboard.alchemy.com/account). Spam 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! 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. False - if the queried contract is considered valid. operationId: isSpamContract-v3 /v3/{apiKey}/isAirdropNFT: get: summary: Is Airdrop NFT description: | Determines whether a specific token is marked as an airdrop. Airdrops are defined as NFTs minted to a user address in a transaction sent by a different address. Please note that this endpoint is only available on Ethereum (mainnet only) & Polygon (mainnet, amoy & mumbai). 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: 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 whether the specified token is marked as an airdrop. content: application/json: schema: type: object description: This object contains a boolean value indicating whether the token is an airdrop. properties: isAirdrop: type: boolean description: | True - if the queried token is marked as an airdrop. False - if the queried token is not marked as an airdrop. operationId: isAirdropNFT-v3 /v3/{apiKey}/summarizeNFTAttributes: get: summary: Attributes Summary By Contract description: | Generates a summary of attribute prevalence for a specific NFT collection. Please note that this endpoint is only available on Ethereum (mainnet) & Polygon (mainnet & mumbai). tags: - NFT Metadata 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: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' required: true responses: '200': description: Returns a summary of attribute prevalence for the specified NFT collection. content: application/json: schema: type: object description: Prevalence counts for each attribute within a collection. properties: totalSupply: type: string description: String - Total number of NFTs in a given NFT collection. summary: type: object description: Object mapping trait types to the prevalence of each trait within that type. contractAddress: type: string default: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' examples: summarizeNFTAttributes_response: value: summary: Earrings: WoW Coins: 437 Pizza Lovers: 188 Lucky Charms: 415 White Ovals: 210 Artist Palettes: 21 Queen's Emeralds: 206 Silver Drops: 822 Flower Power: 366 Pearls: 833 Spikes: 776 Yam's Fave: 381 Classic Hoops: 780 Ocean Hoops: 770 Triple Rings: 823 60s Fantasy: 399 Lightning Bolts: 226 Empresses Of Darkness: 103 Necklace: WoW Coin: 481 Malka: 494 Amazonite Energy: 490 Satin Choker: 721 Back To The 90s: 706 Empress of Darkness: 58 Spike Choker: 449 Golden Bib: 251 Golden Flakes: 710 Art Lover: 29 Rainbow: 474 Gold Ruler: 477 Wolf Pendant: 229 Tutti Frutti Beads: 691 Sun Keeper: 730 Eyes: Purple To The Left: 158 Heterochromia To The Left: 57 Brown To The Right: 455 Black Eye Roll: 881 Yellow To The Left: 141 Purple Eye Roll: 145 Green Straight: 433 Blue To The Left: 407 Green To The Right: 410 Black Straight: 794 Purple To The Right: 145 Black To The Right: 870 Green Eye Roll: 413 Yellow Straight: 128 Brown To The Left: 465 Brown Eye Roll: 416 Heterochromia To The Right: 76 Blue Straight: 415 Black To The Left: 877 Heterochromia Eye Roll: 85 Purple Straight: 158 Brown Straight: 434 Yellow Eye Roll: 141 Heterochromia Straight: 77 Yellow To The Right: 139 Blue To The Right: 416 Green To The Left: 424 Blue Eye Roll: 440 Background: Green Purple: 905 Purple Pink: 905 Dark Emerald: 924 Yellow Pink: 896 Pink Pastel: 849 Blue Green: 924 Soft Purple: 983 Green Orange: 907 Dark Purple: 876 Red Turquoise: 914 Orange Yellow: 917 Mouth: Cigarette: 502 Whistle: 868 Slight Smile: 1666 Stern: 1733 Countryside: 927 Huh: 506 Slightly Open: 1661 Bubble Gum: 404 Surprised: 1733 Clothes: 80s Silk Shirt: 400 70s Shirt: 421 Fantasy Shirt: 542 Adventurer: 583 Striped Tee: 567 Naiade: 98 Tunic: 193 Checkmate: 396 Painter's Overall: 550 Witch Dress: 198 Little Red Dress: 437 Cabaret Corset: 535 Polka Dot Top: 573 Freedom Is Power Tee: 368 Warrior Armor: 177 Emerald Elven Cape: 117 Faux Fur Coat: 404 Red Leather Jacket: 374 White Tee: 533 Tuxedo: 100 Steampunk Octopus Top: 186 Queen's Dress: 391 Cherry Tee: 590 NFT Goddesses Top: 189 Gala Dress: 192 Psychedelic Dress: 492 Futuristic Dress: 394 Facial Features: Nose Piercing: 598 Red Eyeliner: 608 Leader: 224 Neck Tattoo: 227 Pearl Eyes: 207 Red Blue Bolt: 97 Rose Tattoo: 286 Feline Eyes: 590 Elven Warrior: 99 Marilyn: 633 Freckles: 581 Flashy Blue: 304 Sunset: 297 Heart Tattoo: 591 Rainbow: 578 Eyebrow Tattoo MMXXI: 303 Eye Scar: 308 Treble Bass Clef Tattoo: 210 Crystal Queen: 221 Antoinette: 582 Cyber Warrior: 120 Eyebrow Piercing: 619 Claw Scar: 236 Hairstyle: Badass Bob: 178 Curly Ponytail: 390 Finger Waves: 398 Colorful: 186 Fuchsia: 562 Retro: 408 Royal: 227 Boy Cut: 566 Bob: 653 Bun: 607 Long Dark: 416 Curly Pearl Updo: 122 Lucky Green: 417 Lioness: 600 Natural Red: 608 Double Buns: 182 Cotton Candy: 228 Rose Hair: 388 Purple Rainbow: 187 Lollipop: 612 Silver: 205 Braided Ponytail: 561 Platinum Pixie: 570 Black And White: 110 Feeling Turquoise: 412 Lips Color: Space: 195 Gold: 622 Purple: 1967 Burgundy: 1995 Party Pink: 1114 Passion Red: 3008 Flashy Blue: 1099 Skin Tone: Rainbow Bright: 197 Light Warm Yellow: 1021 Burning Red: 497 Cyber Green: 511 Night Goddess: 85 Deep Warm Gold: 1026 Light Medium Warm Gold: 997 Deep Bronze: 1047 Medium Olive: 976 Deep Neutral: 996 Medium Gold: 937 Light Warm Olive: 1031 Cool Blue: 486 Golden: 193 Face Accessories: Oversized Statement Sunglasses: 396 Psychedelic Sunglasses: 390 Resting Butterfly: 83 Red Round Sunglasses: 695 Classic Aviator WoW: 414 Black Mask: 398 Cateye Sunglasses: 221 On Fire: 116 70s Feels: 718 3D Glasses: 216 Round Glasses: 704 Black Round Retro: 403 Hypnotic Glasses: 209 totalSupply: '10000' contractAddress: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' operationId: summarizeNFTAttributes-v3 /v3/{apiKey}/getFloorPrice: get: summary: Floor Prices By Slug description: | Retrieves the floor prices of an NFT collection across different marketplaces. Please note that this endpoint is only available on Ethereum mainnet for Opensea & Looksrare marketplaces. tags: - NFT Sales Endpoints servers: - url: https://{network}.g.alchemy.com/nft variables: network: enum: - eth-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}/searchContractMetadata: get: summary: Search Contract Metadata description: | Searches for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts. This endpoint is currently in BETA. If you have any questions or feedback, please contact us at support@alchemy.com or open a ticket in the dashboard. Please note that this endpoint is only available on **Ethereum**, **Polygon**, **Arbitrum**, **Optimism** & **Base** networks. 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: query description: String - The search string that you want to search for in contract metadata in: query schema: type: string default: bored required: true responses: '200': description: Returns the list of NFT contracts where the metadata has one or more keywords from the search string. content: application/json: schema: type: array description: List of contracts where the metadata contains one or more keywords from the search string. 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: searchContractMetadata-v3 /v3/{apiKey}/isHolderOfContract: get: summary: Is Holder Of Contract description: isHolderOfContract - Determines whether a specific wallet holds any NFT from a given 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: wallet description: String - Wallet address to check for contract ownership. schema: type: string default: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' in: query 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 whether the specified wallet holds any NFT from the given contract. content: application/json: schema: type: object description: Data related to a wallet's ownership of any token in an NFT contract. properties: isHolderOfContract: type: boolean description: Whether the given wallet owns any token in the given NFT contract. operationId: isHolderOfContract-v3 /v3/{apiKey}/computeRarity: get: summary: Attribute Rarity By NFT description: | Calculates the rarity of each attribute within an NFT. Please note that this endpoint is only available on Ethereum (mainnet) & Polygon (mainnet & mumbai). tags: - NFT Metadata 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: '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 rarity information for each attribute of the specified NFT. content: application/json: schema: type: object description: Object containing the rarity info of the collection. properties: rarities: type: array description: NFT attributes and their associated prevalence. items: type: object properties: trait_type: type: string description: Name of the trait category, i.e., Hat, Color, Face, etc. value: type: string description: Value for the trait, i.e., White Cap, Blue, Angry, etc. prevalence: type: number description: Floating point value from 0 to 1 representing the prevalence of this value for this trait type. operationId: computeRarity-v3 /v3/{apiKey}/getNFTSales: get: summary: NFT Sales description: | Retrieves NFT sales that have occurred through on-chain marketplaces. Please note that this endpoint is only available on Ethereum (Seaport, Wyvern, X2Y2, Blur, LooksRare, Cryptopunks), Polygon (Seaport) & Optimism (Seaport) mainnets. tags: - NFT Sales Endpoints servers: - url: https://{network}.g.alchemy.com/nft variables: network: enum: - eth-mainnet - polygon-mainnet - opt-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: 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' - name: toBlock description: String - The block number to start fetching NFT sales data from. Allowed values are decimal and hex integers, and "latest". Defaults to "latest". in: query schema: type: string default: latest - 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 - 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 - description: String - The contract address of an NFT collection to filter sales by. Defaults to returning all NFT contracts. name: contractAddress in: query schema: type: string required: false - description: String - The token ID of an NFT within the collection specified by contractAddress to filter sales by. Defaults to returning all token IDs. name: tokenId in: query schema: type: string default: '44' required: false - 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 - 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 - 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 - description: Integer - The maximum number of NFT sales to return. Maximum and default values are 1000. name: limit in: query schema: type: integer - 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 responses: '200': description: Returns a list of NFT sales that match the query parameters. content: application/json: schema: type: object properties: nftSales: description: List of NFT sales that match the query. type: array items: type: object properties: marketplace: type: string description: String - The marketplace the sale took place on. marketplaceAddress: type: string description: String - The address of the marketplace contract. contractAddress: type: string description: String - The contract address of the collection the NFT belongs to. tokenId: type: string description: String - The decimal token ID of the NFT being sold. quantity: type: string description: Integer - The number of tokens sold in the sale as a decimal integer string. buyerAddress: type: string description: String - The address of the buyer in the NFT sale. sellerAddress: type: string description: String - The address of the seller in the NFT sale. taker: type: string description: String - Whether the price taker in the trade was the buyer or the seller. enum: - BUYER - SELLER sellerFee: type: object description: The payment from buyer to the seller. properties: amount: type: string description: String - The amount of the payment from the buyer to seller as a decimal integer string. tokenAddress: type: string description: String - The smart contract address of the token used for the payment. symbol: type: string description: String - The symbol of the token used for the payment. decimals: type: integer description: Integer - The number of decimals of the token used for the payment. protocolFee: type: object description: The payment from buyer to the NFT marketplace protocol. properties: amount: type: string description: String - The amount of the payment to the marketplace as a decimal integer string. tokenAddress: type: string description: String - The smart contract address of the token used for the payment. symbol: type: string description: String - The symbol of the token used for the payment. decimals: type: integer description: Integer - The number of decimals of the token used for the payment. royaltyFee: type: object description: The payment from buyer to the royalty address of the NFT collection. properties: amount: type: string description: String - The amount of the payment to the royalty collector as a decimal integer string. tokenAddress: type: string description: String - The smart contract address of the token used for the payment. symbol: type: string description: String - The symbol of the token used for the payment. decimals: type: integer description: Integer - The number of decimals of the token used for the payment. blockNumber: type: integer description: Integer - The block number the NFT sale took place in. logIndex: type: integer description: Integer - The log number of the sale event emitted within the block. bundleIndex: type: integer description: Integer - The index of the token within the bundle of NFTs sold in the sale. transactionHash: type: string description: String - The transaction hash of the transaction containing the sale. pageKey: type: string description: String - The page key to use to fetch the next page of results. Returns null if there are no more results. 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: nftSales_response: summary: Response (with pagination) value: nftSales: - marketplace: seaport contractAddress: '0x49cf6f5d44e70224e2e23fdcdd2c053f30ada28b' tokenId: '13749' quantity: '1' buyerAddress: '0x78f6c2458b53d0735208992c693bb2b2dafebb52' sellerAddress: '0x558a18f94cabdea4e47c5965384f457d8e870419' taker: BUYER sellerFee: amount: '11100000000000000000' symbol: ETH decimals: 18 protocolFee: amount: '300000000000000000' symbol: ETH decimals: 18 royaltyFee: amount: '600000000000000000' symbol: ETH decimals: 18 blockNumber: 15000002 logIndex: 130 bundleIndex: 0 transactionHash: '0xecfa1b29c9016bd2556fde637c6b48484eeb14f273af54c49317e3856ab7cb16' - marketplace: looksrare contractAddress: '0x34d85c9cdeb23fa97cb08333b511ac86e1c4e258' tokenId: '75417' quantity: '1' buyerAddress: '0xb3aa9923489bc2bfec323bf05346acd4afbc92a0' sellerAddress: '0x206ccba024c236dced07c35b4e9eb0bade7ef166' taker: BUYER sellerFee: amount: '2222700000000000000' symbol: WETH decimals: 18 protocolFee: amount: '47800000000000000' symbol: WETH decimals: 18 royaltyFee: amount: '119500000000000000' symbol: WETH decimals: 18 blockNumber: 15000002 logIndex: 197 bundleIndex: 0 transactionHash: '0x4c23163e4f855e143e573776bc6129bee370dff6ce760e71553fc93201b292e2' pageKey: MTUwMDAwNzgsODcsMA validAt: blockNumber: 17091500 blockHash: '0x2a34a65c4e0cd7fdf187d6a497214ad2bee255d2d3501868a6b8c09b4d1261bd' blockTimestamp: '2023-04-21T01:25:59Z' operationId: getNFTSales-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: - 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**. - 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. - 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: - 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**. - 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. - 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. - 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. Confidence Levels: - VERY_HIGH - HIGH - MEDIUM - LOW The 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. Defaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet. **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}/getCollectionsForOwner: get: summary: Collections By Owner description: | Retrieves all NFT collections held by a specified owner address. This endpoint is only supported on Ethereum. Use `getContractsForOwner` for support across all other chains we support! 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: - 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**. - 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. - 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: - 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**. - 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. - 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 responses: '200': description: Returns a list of NFT collections held by the specified owner address. content: application/json: schema: type: object properties: collections: type: array items: 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 pageKey: type: string totalCount: type: string description: String - Total number of NFT collections held by the given address. examples: withoutMetadata: summary: Response (withMetadata = false) value: collections: - address: '0x3a5051566b2241285BE871f650C445A88A970edd' name: 'The Humanoids ' slug: thehumanoids totalBalance: '1' numDistinctTokensOwned: '1' isSpam: false totalCount: 2120 pageKey: 20ef9df5-0d81-42e5-b741-140f595a407b withMetadata: summary: Response (withMetadata = true) value: collections: - name: The Humanoids slug: thehumanoids floorPrice: marketplace: seaport floorPrice: 0.37 priceCurrency: ETH description: |- The Humanoids (Gen 1) is a collection of 10,000 unique 3D 4K personalities. [GEN 1.1 (CUSTOMIZABLE PFP)](https://opensea.io/collection/the-humanoids-gen-1-1/) | [DISCORD](https://discord.gg/thehumanoids) | [TWITTER](https://twitter.com/thehumanoids) Stake your Gen 1 Humanoid and earn $ION to customize Gen 1.1 Humanoids using our proprietary Trait Factory. Note: Holder Count is inaccurate as Humanoids are currently being staked. externalUrl: http://thehumanoids.com twitterUsername: thehumanoids discordUrl: https://discord.gg/thehumanoids contract: address: '0x3a5051566b2241285BE871f650C445A88A970edd' name: 'The Humanoids ' symbol: HMNDS tokenType: ERC721 contractDeployer: '0xB8256c1c6654cedb9607644b07deC91Ca15fb9f6' deployedBlockNumber: 13313830 totalBalance: '1' numDistinctTokensOwned: '1' isSpam: false displayNft: tokenId: '5880' name: 'Humanoid #5880' image: cachedUrl: https://nft-cdn.alchemy.com/eth-mainnet/57dab2f078ca70e310c387064f66daaa thumbnailUrl: https://res.cloudinary.com/alchemyapi/image/upload/thumbnailv2/eth-mainnet/57dab2f078ca70e310c387064f66daaa pngUrl: https://res.cloudinary.com/alchemyapi/image/upload/convert-png/eth-mainnet/57dab2f078ca70e310c387064f66daaa contentType: image/jpeg size: 1898134 originalUrl: https://ipfs.io/ipfs/QmcjYgWMokcqnaSGZ31GVbGDe9V9z1KeNerRGfgeBEkn4k/5880.jpg totalCount: 2120 pageKey: 03949322-9b2c-4fdd-aab6-1369e29fa5b2 operationId: getCollectionsForOwner-v3 /v3/{apiKey}/reportSpam: get: summary: Report Spam Address description: | Reports a specific address to the API if it is suspected to be spam. Spam 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! 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: | Submits a request for Alchemy to refresh the cached metadata of a specific NFT token. Please note that this endpoint is only supported on Ethereum (Mainnet & Sepolia), Polygon (Mainnet, Mumbai & 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! 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 /v2/{apiKey}/getNFTs: get: summary: getNFTs description: Gets all NFTs currently owned by a given address. tags: - NFT API V2 Methods (Older Version) 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. - 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: - 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**. - 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. - 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: - 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**. - 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. - 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. Confidence Levels: - VERY_HIGH - HIGH - MEDIUM - LOW The 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. Defaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet. **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 items: 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. pageKey: type: string totalCount: type: integer description: Integer - Total number of NFTs (distinct `tokenIds`) owned by the given address. blockHash: type: string description: String - The canonical head block hash of when your request was received i.e. the block corresponding to `latest` examples: byDefault: summary: Response (By Default) value: ownedNfts: - contract: address: '0x0beed7099af7514ccedf642cfea435731176fb02' id: tokenId: '28' tokenMetadata: tokenType: ERC721 title: '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. tokenUri: raw: https://duskbreakers.gg/api/breakers/28 gateway: https://duskbreakers.gg/api/breakers/28 media: - raw: https://duskbreakers.gg/breaker_images/28.png gateway: https://duskbreakers.gg/breaker_images/28.png 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: Big Smile (Purple) trait_type: Mouth - value: Yellow trait_type: Background timeLastUpdated: '2022-02-16T22:52:54.719Z' contractMetadata: name: DuskBreakers symbol: DUSK totalSupply: '10000' tokenType: ERC721 - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '5527' tokenMetadata: tokenType: ERC721 title: 'Runner #5527' description: Chain Runners are Mega City renegades 100% generated on chain. tokenUri: raw: https://api.chainrunners.xyz/tokens/metadata/5527?dna=73247164192459371523281785218958151913554625578441142916970699984935810987041 gateway: https://api.chainrunners.xyz/tokens/metadata/5527?dna=73247164192459371523281785218958151913554625578441142916970699984935810987041 media: - raw: https://img.chainrunners.xyz/api/v1/tokens/png/5527 gateway: https://img.chainrunners.xyz/api/v1/tokens/png/5527 metadata: name: 'Runner #5527' description: Chain Runners are Mega City renegades 100% generated on chain. image: https://img.chainrunners.xyz/api/v1/tokens/png/5527 attributes: - value: Purple Green Diag trait_type: Background - value: Human trait_type: Race - value: Cig trait_type: Mouth Accessory timeLastUpdated: '2022-02-18T00:42:04.401Z' contractMetadata: name: Chain Runners symbol: RUN totalSupply: '10000' tokenType: ERC721 totalCount: 6 blockHash: '0xeb2d26af5b6175344a14091777535a2cb21c681665a734a8285f889981987630' withoutMetadata: summary: Response (withMetadata = false) value: ownedNfts: - contract: address: '0x0beed7099af7514ccedf642cfea435731176fb02' id: tokenId: '0x000000000000000000000000000000000000000000000000000000000000001c' - contract: address: '0x0beed7099af7514ccedf642cfea435731176fb02' id: tokenId: '0x000000000000000000000000000000000000000000000000000000000000001d' balance: '1' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x0000000000000000000000000000000000000000000000000000000000001597' balance: '1' totalCount: 6 blockHash: '0xf9a2a4e15116680e22b160c734529f62d89d54cde0759daf5135672fad0ecebc' withContractFiltering: summary: Response (with contract filtering) value: ownedNfts: - contract: address: '0x34d77a17038491a2a9eaa6e690b7c7cd39fc8392' id: tokenId: '0x0000000000000000000000000000000000000000000000000000000000000277' totalCount: 1 blockHash: '0x3d8bca59c08e41f55d46ebbe738327eb12955cf280bd06ef7d40352919c188d8' withPagination: summary: Response (with pagination) value: ownedNfts: - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x00000000000000000000000000000000000000000000000000000000000009cb' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x00000000000000000000000000000000000000000000000000000000000009cc' - contract: address: '0x5ab21ec0bfa0b29545230395e3adaca7d552c948' id: tokenId: '0x00000000000000000000000000000000000000000000000000000000000006dc' - contract: address: '0x3b3ee1931dc30c1957379fac9aba94d1c48a5405' id: tokenId: '0x000000000000000000000000000000000000000000000000000000000000001a' - contract: address: '0x69c40e500b84660cb2ab09cb9614fa2387f95f64' id: tokenId: '0x0000000000000000000000000000000000000000000000000000000000000391' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x00000000000000000000000000000000000000000000000000000000000008d5' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x0000000000000000000000000000000000000000000000000000000000000a1d' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x000000000000000000000000000000000000000000000000000000000000002a' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x000000000000000000000000000000000000000000000000000000000000038e' - contract: address: '0x97597002980134bea46250aa0510c9b90d87a587' id: tokenId: '0x000000000000000000000000000000000000000000000000000000000000244b' pageKey: 88434286-7eaa-472d-8739-32a0497c2a18 totalCount: 277 blockHash: '0x94d5ab52b8a6571733f6b183ef89f31573b82a4e78f8129b0ce90ef0beaf208b' operationId: getNFTs /v2/{apiKey}/getNFTMetadata: get: summary: getNFTMetadata description: Gets the metadata associated with a given NFT. tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: 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. operationId: getNFTMetadata /v2/{apiKey}/getNFTMetadataBatch: post: summary: getNFTMetadataBatch description: Gets the metadata associated with up to 100 given NFT contracts. tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: type: array items: 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. operationId: getNFTMetadataBatch /v2/{apiKey}/getContractMetadata: get: summary: getContractMetadata description: Queries NFT high-level collection/contract level information. tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: type: object properties: address: type: string description: String - Contract address for the queried NFT collection 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 operationId: getContractMetadata /v2/{apiKey}/getContractMetadataBatch: post: summary: getContractMetadataBatch description: Gets the metadata associated with the given list of contract addresses tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: type: array items: type: object properties: address: type: string default: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' contractMetadata: 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 operationId: getContractMetadataBatch /v2/{apiKey}/getNFTsForCollection: get: summary: getNFTsForCollection description: Gets all NFTs for a given NFT contract. tags: - NFT API V2 Methods (Older Version) 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: '' 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 /v2/{apiKey}/getOwnersForToken: get: summary: getOwnersForToken description: Get the owner(s) for a token. tags: - NFT API V2 Methods (Older Version) 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 token to get the owner for. in: query schema: type: string default: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' 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: 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 owners to be returned per page. schema: type: integer in: query responses: '200': description: '' content: application/json: schema: type: object properties: owners: type: array description: List of all addresses that own the given NFT. items: type: string operationId: getOwnersForToken /v2/{apiKey}/getOwnersForCollection: get: summary: getOwnersForCollection description: Gets all owners for a given NFT contract. tags: - NFT API V2 Methods (Older Version) 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: 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 collections 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: '' content: application/json: schema: type: array description: List of all addresses that own the given NFT. items: type: string operationId: getOwnersForCollection /v2/{apiKey}/getSpamContracts: get: summary: getSpamContracts description: Returns a list of all spam contracts marked by Alchemy. tags: - NFT API V2 Methods (Older Version) 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 responses: '200': description: '' content: application/json: schema: type: object description: Object that has list of contract addresses properties: contractAddresses: type: array items: type: string description: A list of contract addresses earmarked as spam by Alchemy. operationId: getSpamContracts /v2/{apiKey}/isSpamContract: get: summary: isSpamContract description: Returns whether a contract is marked as spam or not by Alchemy. tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: type: boolean description: | True - if the queried contract is marked as spam. False - if the queried contract is considered valid or if the contract hasn't been evaluated by us yet. operationId: isSpamContract /v2/{apiKey}/isAirdrop: get: summary: isAirdrop description: Returns whether a token is marked as an airdrop or not. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: type: boolean description: | True - if the queried token is marked as an airdrop. False - if the queried token is not marked as an airdrop. operationId: isAirdrop /v2/{apiKey}/invalidateContract: get: summary: invalidateContract description: Marks all cached tokens for the particular contract as stale. So the next time the endpoint is queried it fetches live data instead of fetching from cache. tags: - NFT API V2 Methods (Older Version) 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: '' content: application/json: schema: type: object description: | True - if the queried contract is marked as spam. False - if the queried contract is considered valid. properties: success: type: string description: | True if the contract was invalidated. False - if it wasn't. numTokensInvalidated: type: number description: The number of tokens that were invalidated as a result of running this query. operationId: invalidateContract /v2/{apiKey}/getFloorPrice: get: summary: getFloorPrice description: Returns the floor prices of a NFT collection by marketplace. tags: - NFT API V2 Methods (Older Version) servers: - url: https://{network}.g.alchemy.com/nft variables: network: enum: - eth-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: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' required: true responses: '200': description: '' content: application/json: schema: type: object properties: nftMarketplace: type: object description: Name of the NFT marketplace where the collection is listed. Current marketplaces supported - OpenSea, LooksRare 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 an error if there was an error fetching floor prices from the given marketplace. operationId: getFloorPrice /v2/{apiKey}/computeRarity: get: summary: computeRarity description: Computes the rarity of each attribute of an NFT. tags: - NFT API V2 Methods (Older Version) 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: '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: '' content: application/json: schema: type: object description: Object containing the rarity info of the collection properties: rarities: type: array description: NFT attributes and their associated prevalence. items: type: object properties: trait_type: type: string description: Name of the trait category, i.e. Hat, Color, Face, etc. value: type: string description: Value for the trait, i.e. White Cap, Blue, Angry, etc. prevalence: type: number description: Floating point value from 0 to 1 representing the prevalence of this value for this trait type. operationId: computeRarity /v2/{apiKey}/searchContractMetadata: get: summary: searchContractMetadata description: Search for a keyword across metadata of all ERC-721 and ERC-1155 smart contracts tags: - NFT API V2 Methods (Older Version) servers: - url: https://{network}.g.alchemy.com/nft variables: network: enum: - eth-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: query description: String - The search string that you want to search for in contract metadata in: query schema: type: string default: bored required: true responses: '200': description: Returns the list of NFT contracts where the metadata has one or more keywords from the search string. content: application/json: schema: type: array description: List of contracts where the metadata contains one or more keywords from the search string. items: type: object properties: address: type: string default: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' 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 operationId: searchContractMetadata /v2/{apiKey}/summarizeNFTAttributes: get: summary: summarizeNFTAttributes description: Generate a summary of attribute prevalence for an NFT collection. tags: - NFT API V2 Methods (Older Version) 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: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' required: true responses: '200': description: '' content: application/json: schema: type: object description: Prevalence counts for each attribute within a collection. properties: totalSupply: type: string description: String - Total number of NFTs in a given NFT collection. summary: type: object description: Object mapping trait types to the prevalence of each trait within that type. contractAddress: type: string default: '0xe785E82358879F061BC3dcAC6f0444462D4b5330' operationId: summarizeNFTAttributes /v2/{apiKey}/isHolderOfCollection: get: summary: isHolderOfCollection description: Checks whether a wallet holds a NFT in a given collection tags: - NFT API V2 Methods (Older Version) 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: wallet description: String - Address for NFT owner (can be in ENS format for Eth Mainnet). schema: type: string default: '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045' in: query 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: '' content: application/json: schema: type: object description: Data related to a wallet's ownership of any token in an NFT collection. properties: isHolderOfCollection: type: boolean description: Whether the given wallet owns any token in the given NFT collection. operationId: isHolderOfCollection /v2/{apiKey}/getNFTSales: get: summary: getNFTSales description: Gets NFT sales that have happened through on-chain marketplaces tags: - NFT API V2 Methods (Older Version) servers: - url: https://{network}.g.alchemy.com/nft variables: network: enum: - eth-mainnet - polygon-mainnet - opt-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: 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' - name: toBlock description: String - The block number to start fetching NFT sales data from. Allowed values are decimal and hex integers, and "latest". Defaults to "latest". in: query schema: type: string default: latest - 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 - 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 - description: String - The contract address of a NFT collection to filter sales by. Defaults to returning all NFT contracts. name: contractAddress in: query schema: type: string required: false - description: String - The token ID of an NFT within the collection specified by contractAddress to filter sales by. Defaults to returning all token IDs. name: tokenId in: query schema: type: string default: '44' required: false - 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 - 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 - 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 - description: Integer - The maximum number of NFT sales to return. Maximum and default values are 1000. name: limit in: query schema: type: integer - 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 responses: '200': description: '' content: application/json: schema: type: object properties: nftSales: description: List of NFT sales that match the query type: array items: type: object properties: marketplace: type: string description: String - The marketplace the sale took place on. contractAddress: type: string description: String - The contract address of the collection the NFT belongs to. tokenId: type: string description: String - The decimal token ID of the NFT being sold. quantity: type: string description: Integer - The number of tokens sold in the sale as a decimal integer string. buyerAddress: type: string description: String - The address of the buyer in the NFT sale. sellerAddress: type: string description: String - The address of the seller in the NFT sale. taker: type: string description: String - Whether the price taker in the trade was the buyer or the seller. enum: - BUYER - SELLER sellerFee: type: object description: The payment from buyer to the seller properties: amount: type: string description: String - The amount of the payment from the buyer to seller as a decimal integer string. symbol: type: string description: String - The symbol of the token used for the payment. decimals: type: integer description: Integer - The number of decimals of the token used for the payment. protocolFee: type: object description: The payment from buyer to the NFT marketplace protocol properties: amount: type: string description: String - The amount of the payment to the marketplace as a decimal integer string. symbol: type: string description: String - The symbol of the token used for the payment. decimals: type: integer description: Integer - The number of decimals of the token used for the payment. royaltyFee: type: object description: The payment from buyer to the royalty address of the NFT collection properties: amount: type: string description: String - The amount of the payment to the royalty collector as a decimal integer string. symbol: type: string description: String - The symbol of the token used for the payment. decimals: type: integer description: Integer - The number of decimals of the token used for the payment. blockNumber: type: integer description: Integer - The block number the NFT sale took place in. logIndex: type: integer description: Integer - The log number of the sale event emitted within the block. bundleIndex: type: integer description: Integer - The index of the token within the bundle of NFTs sold in the sale. transactionHash: type: string description: String - The transaction hash of the transaction containing the sale. pageKey: type: string description: String - The page key to use to fetch the next page of results. Returns null if there are no more results. examples: nftSales_response: summary: Response (with pagination) value: nftSales: - marketplace: seaport contractAddress: '0x49cf6f5d44e70224e2e23fdcdd2c053f30ada28b' tokenId: '13749' quantity: '1' buyerAddress: '0x78f6c2458b53d0735208992c693bb2b2dafebb52' sellerAddress: '0x558a18f94cabdea4e47c5965384f457d8e870419' taker: BUYER sellerFee: amount: '11100000000000000000' symbol: ETH decimals: 18 protocolFee: amount: '300000000000000000' symbol: ETH decimals: 18 royaltyFee: amount: '600000000000000000' symbol: ETH decimals: 18 blockNumber: 15000002 logIndex: 130 bundleIndex: 0 transactionHash: '0xecfa1b29c9016bd2556fde637c6b48484eeb14f273af54c49317e3856ab7cb16' - marketplace: looksrare contractAddress: '0x34d85c9cdeb23fa97cb08333b511ac86e1c4e258' tokenId: '75417' quantity: '1' buyerAddress: '0xb3aa9923489bc2bfec323bf05346acd4afbc92a0' sellerAddress: '0x206ccba024c236dced07c35b4e9eb0bade7ef166' taker: BUYER sellerFee: amount: '2222700000000000000' symbol: WETH decimals: 18 protocolFee: amount: '47800000000000000' symbol: WETH decimals: 18 royaltyFee: amount: '119500000000000000' symbol: WETH decimals: 18 blockNumber: 15000002 logIndex: 197 bundleIndex: 0 transactionHash: '0x4c23163e4f855e143e573776bc6129bee370dff6ce760e71553fc93201b292e2' pageKey: MTUwMDAwNzgsODcsMA validAt: blockNumber: 17091500 blockHash: '0x2a34a65c4e0cd7fdf187d6a497214ad2bee255d2d3501868a6b8c09b4d1261bd' blockTimestamp: '2023-04-21T01:25:59Z' operationId: getNFTSales /v2/{apiKey}/getContractsForOwner: get: summary: getContractsForOwner description: Gets all NFT contracts held by an owner address. tags: - NFT API V2 Methods (Older Version) 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: - 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**. - 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. - 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: - 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**. - 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. - 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. - 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. Confidence Levels: - VERY_HIGH - HIGH - MEDIUM - LOW The 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. Defaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet. **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: '' 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: 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 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 /v2/{apiKey}/reportSpam: get: summary: reportSpam description: Report a particular address to our APIs if you think it is spam tags: - NFT API V2 Methods (Older Version) 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 description: Boolean - Whether the address is spam. in: query schema: type: boolean default: true required: true responses: '200': description: '' content: application/json: schema: type: string description: 'String - "Address was successfully reported as spam" if calling the API was successful. ' operationId: reportSpam 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: - 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**. - 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. - 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: - 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**. - 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. - 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. Confidence Levels: - VERY_HIGH - HIGH - MEDIUM - LOW The 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. Defaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet. **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 collectionSlugRequired: name: collectionSlug description: String - OpenSea slug for the NFT collection. in: query schema: type: string default: boredapeyachtclub required: true 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. - 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 collectionMetadatav3: type: object properties: name: type: string description: String - Name of the queried NFT Collection 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 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 ```

getSpamContracts

Path Parameters

apiKey

Responses

200