thirdwebDocs
GitHub

getNFT

Retrieves information about a specific ERC721 non-fungible token (NFT).

Example

import { getNFT } from "thirdweb/extensions/erc721";
const nft = await getNFT({
contract,
tokenId: 1n,
});
function getNFT(
includeOwner?: boolean;
tokenByIndex?: boolean;
tokenId: bigint;
useIndexer?: boolean;
}>,
): Promise<NFT>;

Parameters

The options for retrieving the NFT.

Type

let options: BaseTransactionOptions<{
includeOwner?: boolean;
tokenByIndex?: boolean;
tokenId: bigint;
useIndexer?: boolean;
}>;

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";
};

A promise that resolves to the NFT object.