TypeScript SDK

getContractNFTs

Get all NFTs from a contract

Example


import { Insight } from "thirdweb";
 
const nfts = await Insight.getContractNFTs({
  client,
  chains: [sepolia],
  contractAddress: "0x1234567890123456789012345678901234567890",
});


function getContractNFTs(args: {
  chains: Array<Readonly<ChainOptions & { rpc: string }>>;
  client: ThirdwebClient;
  contractAddress: string;
  includeMetadata?: boolean;
  includeOwners?: boolean;
  queryOptions?: Omit<
    | undefined
    | {
        chain?: Array<number>;
        chain_id?: Array<number>;
        include_owners?: "false" | "true";
        limit?: number;
        page?: null | number;
        resolve_metadata_links?: "false" | "true";
      },
    "chain"
  >;
}): Promise<Array<NFT>>;

Parameters

Type


let args: {
  chains: Array<Readonly<ChainOptions & { rpc: string }>>;
  client: ThirdwebClient;
  contractAddress: string;
  includeMetadata?: boolean;
  includeOwners?: boolean;
  queryOptions?: Omit<
    | undefined
    | {
        chain?: Array<number>;
        chain_id?: Array<number>;
        include_owners?: "false" | "true";
        limit?: number;
        page?: null | number;
        resolve_metadata_links?: "false" | "true";
      },
    "chain"
  >;
};

Returns


let returnType:
  | {
      chainId: number;
      id: bigint;
      metadata: NFTMetadata;
      owner: string | null;
      tokenAddress: string;
      tokenURI: string;
      type: "ERC721";
    }
  | {
      chainId: number;
      id: bigint;
      metadata: NFTMetadata;
      owner: string | null;
      supply: bigint;
      tokenAddress: string;
      tokenURI: string;
      type: "ERC1155";
    };