🛠️ Alchemy SDKSDK V2 Methods

getNftsForContract - SDK

Get all NFTs for a given contract address. This method returns the full NFTs in the contract. To get all NFTs without their associated metadata, use the options parameter.

Get all NFTs for a given contract address.

This method returns the full NFTs in the contract. To get all NFTs without their associated metadata, use the options parameter.

Don’t have an API key?

Start using this method in your app today. Get started for free

Description

Get all NFTs for a given contract address.

This method returns the full NFTs in the contract. To get all NFTs without their associated metadata, use the options parameter.

Parameters

NameTypeDescription
contractAddressstringThe contract address of the NFT contract.
optionsobjectThe parameters to use for the request.

options paramters

PropertyTypeDescription
pageKey?stringOptional page key from an existing OwnedBaseNftsResponse or OwnedNftsResponse to use for pagination.
pageSizenumberSets the total number of NFTs to return in the response. Defaults to 100. Maximum page size is 100.
omniMetadatabooleanOptional boolean flag to omit NFT metadata. Defaults to false.
tokenUriTimeoutInMsnumberNo 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.

Response

PropertyTypeDescription
Promise<NftContractNftsResponse>objectThe NFTs for the contract

NftContractNftsResponse object parameters

PropertyTypeDescription
nftsarray of stringsAn array of NFTs with metadata.
pageKeystringPagination token that can be passed into another request to fetch the next NFTs. If there is no page key, then there are no more NFTs to fetch.

Example Request and Response

Prerequisite: You will need to install the Alchemy SDK before making requests with it.

The commands for installing it using npm or yarn are given below:

$npm install alchemy-sdk

Request

index.js
1// Imports the Alchemy SDK
2const { Alchemy, Network } = require("alchemy-sdk");
3
4// Configures the Alchemy SDK
5const config = {
6    apiKey: "alchemy-replit", // Replace with your API key
7    network: Network.ETH_MAINNET, // Replace with your network
8};
9
10// Creates an Alchemy object instance with the config to use for making requests
11const alchemy = new Alchemy(config);
12
13const main = async () => {
14    // define the contract address whose NFTs you want to fetch
15    const address = "0x61fce80d72363b731425c3a2a46a1a5fed9814b2";
16
17    //Call the method to fetch metadata
18    const response = await alchemy.nft.getNftsForContract(address)
19
20    //Logging the response to the console
21    console.log(response)
22}
23
24main();

Response

shell
${
>  [
>   {
>      contract: [Object],
>      tokenId: '345',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #345',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:14.728Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '346',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #346',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:15.998Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '347',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #347',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:17.183Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '348',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #348',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:19.944Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '349',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #349',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:21.174Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '350',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #350',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:22.455Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '351',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #351',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:23.755Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '352',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #352',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-12T22:59:29.229Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    },
>    {
>      contract: [Object],
>      tokenId: '353',
>      tokenType: 'ERC1155',
>      title: 'Undead Warrior #353',
>      description: 'Undead Warriors are a collection of NFTs powered by the Undead Coin (UDC) battling the most difficult challenges in the E-Gaming and Web 3 space.',
>      timeLastUpdated: '2023-02-04T14:55:26.213Z',
>      metadataError: undefined,
>      rawMetadata: [Object],
>      tokenUri: [Object],
>      media: [Array],
>      spamInfo: undefined
>    }
>  ],
>  pageKey: '0x0162'
>}

Use Cases

Here are some potential use cases for the getNftsForContract method:

  • NFT marketplace integration: An NFT marketplace could use the getNftsForContract method to display all the NFTs associated with a particular contract address. This would allow users to easily browse and search for NFTs on the marketplace.

  • Portfolio tracking: NFT collectors or investors could use the getNftsForContract method to track their NFT holdings associated with a specific contract address. This could be particularly useful for investors who are interested in tracking the performance of specific NFT projects or creators.

  • Gaming applications: Gaming applications that use NFTs could use the getNftsForContract method to retrieve all the NFTs associated with a particular game or game studio. This could help developers create more immersive gaming experiences and reward players with unique NFTs for their in-game achievements.

Related Methods