Skip to main content

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]: unknown;
name?: string | number | undefined;
description?: string | null | undefined;
image?: string | null | undefined;
external_url?: string | null | undefined;
animation_url?: string | null | undefined;
background_color?: string | undefined;
properties?:
| {
[x: string]: unknown;
}
| {
[x: string]: unknown;
}[]
| undefined;
attributes?:
| {
[x: string]: unknown;
}
| {
[x: string]: unknown;
}[]
| undefined;
id: string;
uri: string;
}[],
unknown
>;

Parameters

ParameterTypeDescription
contractRequiredParam<NFTDrop>an instance of a contract that extends the Erc721 spec (nft drop, custom contract that follows the Erc721 & drop spec)
queryParamsQueryAllParams(Optional) query params to pass to the query for the sake of pagination

Returns:

import("@tanstack/react-query").UseQueryResult<{ [x: string]: unknown; name?: string | number | undefined; description?: string | null | undefined; image?: string | null | undefined; external_url?: string | null | undefined; animation_url?: string | null | undefined; background_color?: string | undefined; properties?: { [x: string]: unknown; } | { [x: string]: unknown; }[] | undefined; attributes?: { [x: string]: unknown; } | { [x: string]: unknown; }[] | undefined; id: string; uri: string; }[], unknown>

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