useUnclaimedNFTs() function

This feature is currently in beta and may change based on feedback that we receive.

Use this to get a list of *unclaimed* NFT tokens of your ERC721 Drop contract.

Example

const { data: unclaimedNfts, isLoading, error } = useUnclaimedNFTs(<YourERC721DropContractInstance>, { start: 0, count: 100 });

Signature:

export declare function useUnclaimedNFTs(
  contract: RequiredParam<NFTDrop>,
  queryParams?: QueryAllParams,
): import("@tanstack/react-query").UseQueryResult<
  {
    [x: string]: import("@thirdweb-dev/sdk/dist/browser").Json;
    name?: string | undefined;
    description?: string | null | undefined;
    image?: string | null | undefined;
    external_url?: string | null | undefined;
    animation_url?: string | null | undefined;
    uri: string;
    id: import("ethers").BigNumber;
  }[],
  unknown
>;

Parameters

Parameter	Type	Description
contract	RequiredParam<NFTDrop>	an instance of a contract that extends the Erc721 spec (nft drop, custom contract that follows the Erc721 & drop spec)
queryParams	QueryAllParams	(Optional) query params to pass to the query for the sake of pagination

Returns:

import("@tanstack/react-query").UseQueryResult<{ [x: string]: import("@thirdweb-dev/sdk/dist/browser").Json; name?: string | undefined; description?: string | null | undefined; image?: string | null | undefined; external_url?: string | null | undefined; animation_url?: string | null | undefined; uri: string; id: import("ethers").BigNumber; }[], unknown>

a response object that includes an array of NFTs that are unclaimed