Skip to main content

useClaimedNFTs() function

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

Use this to get a list of *claimed* (minted) NFT tokens of your ERC721 Drop contract.

Example

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

Signature:

export declare function useClaimedNFTs(
contract: RequiredParam<DropContract>,
queryParams?: QueryAllParams,
): import("@tanstack/react-query").UseQueryResult<
import("../../types").NFT<DropContract>[],
unknown
>;

Parameters

ParameterTypeDescription
contractRequiredParam<DropContract>an instance of a DropContract
queryParamsQueryAllParams(Optional) query params to pass to the query for the sake of pagination

Returns:

import("@tanstack/react-query").UseQueryResult<import("../../types").NFT<DropContract>[], unknown>

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

Remarks

Equivalent to using useNFTs().