owner
: [string] address for NFT owner (can be in ENS format!)pageKey
: [string] (optional) UUID for pagination. If more results are available, a UUID pageKey
will be returned in the response. Pass that UUID into pageKey
to fetch the next 100 NFTs. NOTE: pageKeys expire after 10 minutes. contractAddresses[]
: [array of strings] (optional) array of contract addresses to filter the responses with. Max limit 20 contracts.withMetadata
: [boolean] true
by default (optional); if boolean is set to true
the query will include metadata for each returned token filters[]
: [array of ENUMS] (optional) array of filters (as string ENUMS) that will be applied to the query. NFTs that are match one or more of these filters will be excluded from the response. "SPAM"
: NFTs that have been classified as spam. Spam classification has a wide range of criteria that includes but is not limited to emitting fake events and copying other well-known NFTs. withMetadata
parameter tofalse
will reduce payload size and may result in a faster API call.pageKey
you can include in the next request to return the remaining responses. This uses cursor based pagination with an idempotent result. This means if you provide one it serves as a static reference to the NFTs owned at time of the first call. This means if an owner acquires or transfers an NFT in between a paginated call, this will NOT be reflected.ownedNfts
: list of objects that represent NFTs owned by the address. Max results per response = 100. contract
: address
: address of NFT contractid
:tokenId
: Id for NFT (hex) tokenMetadata
tokenType
: "ERC721
" or "ERC1155
"balance
: token balancetitle
: name of the NFT assetdescription
: brief human-readable descriptiontokenUri
:raw:
uri representing the location of the NFT's original metadata blob. This is a backup for you to parse when the metadata
field is not automatically populated.gateway:
public gateway uri for the raw uri above.media
[array of object] :raw:
uri representing the location of the NFT media asset. This is a backup for you to parse when the metadata
field is not automatically populated.gateway:
public gateway uri for the raw asset above. gateway
field and feature a Cloudinary URL for faster loading times and can be configured for image re-sizing. For more info on using Alchemy-hosted media, see this doc. metadata
: relevant metadata for NFT contract. This is useful for viewing image url, traits, etc. without having to follow the metadata url in tokenUri
to parse manually.
NOTE: Not all metadata fields may be filled in if the provided NFT contract does not contain relevant information.external_url
: The image URL that appears alongside the asset image on NFT platforms.background_color
: Background color of the NFT item. Usually must be defined as a six-character hexadecimal.name
Name of the NFT asset.description
: human-readable description of the NFT asset. (Markdown is supported/rendered on OpenSea and other NFT platforms)attributes
: traits/attributes/characteristics for each NFT asset.pageKey
: (optional) UUID for pagination - returned if there are more NFTs to fetch. Max NFTs per page = 100.totalCount
: total number of NFTs owned by the given address. blockHash
: the canonical head block hash of when your request was receivederror
: A string describing a particular reason that we were unable to fetch complete metadata for the NFT.
See the Handling Errors section for a complete list of potential errors.gateway
URI within media
objector theexternal_url
within metadata
object. Visit the FAQ for more info on IPFS gateways.withMetadata
= false)ownedNfts
: list of objects that represent NFTs owned by the address. Max results per response = 100. contract
: address
: address of NFT contractid
:tokenId
: Id for NFT (integer) balance
: token balancepageKey
: (optional) UUID for pagination - returned if there are more NFTs to fetch. Max NFTs per page = 100.totalCount
: total number of NFTs owned by the given address. blockHash
: the canonical head block hash of when your request was receivedtotalCount
and ownedNfts
reported may not reflect certain NFTs that we do not current support. If you notice an NFT that our API does not currently support, please submit a feature request or reach out to us over Discord.https:/
polygon-mainnet.g.alchemy.com/nft/v2/your-api-key/getNFTs
...withMetadata
= false)pageKey
expires after 10 minutes.