thirdwebDocs
GitHub

getNFT

Get NFT metadata by contract address and token id

Example

import { Insight } from "thirdweb";
const nft = await Insight.getNFT({
client,
chain: sepolia,
contractAddress: "0x1234567890123456789012345678901234567890",
tokenId: 1n,
});
function getNFT(args: {
chain: Readonly;
client: ThirdwebClient;
contractAddress: string;
includeOwners?: boolean;
queryOptions?: {
chain?: unknown;
include_owners?: "false" | "true";
};
tokenId: string | number | bigint;
}): Promise<undefined | NFT>;

Parameters

Type

let args: {
chain: Readonly;
client: ThirdwebClient;
contractAddress: string;
includeOwners?: boolean;
queryOptions?: {
chain?: unknown;
include_owners?: "false" | "true";
};
tokenId: string | number | bigint;
};

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