API Reference
Alchemy Login
Start typing to search…

getNFTs

get https://{network}.g.alchemy.com/nft/v2//getNFTs

Gets all NFTs currently owned by a given address.

🚧

Method rename

This method has been renamed to getNftsForOwner in V3 version of the NFT API

Path Params
string
required
Defaults to docs-demo

For higher throughput, create your own API key

Query Params
string
required
Defaults to 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045

String - Address for NFT owner (can be in ENS format for Eth Mainnet).

contractAddresses[]
array of strings

Array of contract addresses to filter the responses with. Max limit 45 contracts.

contractAddresses[]
boolean
Defaults to true

Boolean - if set to true, returns NFT metadata. Setting this to false will reduce payload size and may result in a faster API call. Defaults to true.

string

Enum - ordering scheme to use for ordering NFTs in the response. If unspecified, NFTs will be ordered by contract address and token ID.

  • transferTime: NFTs will be ordered by the time they were transferred into the wallet, with newest NFTs first. NOTE: this ordering is only supported on Ethereum Mainnet and Polygon Mainnet.
excludeFilters[]
array of strings

Array of filters (as ENUMS) that will be applied to the query. NFTs that match one or more of these filters will be excluded from the response. May not be used in conjunction with includeFilters[]. Filter Options:

  • 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. Please note that this filter is currently supported only on Ethereum Mainnet and Matic Mainnet, and is available exclusively on paid tiers.
  • AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.
  • To learn more about spam, you can refer to this: Spam NFTs and how to fix them
excludeFilters[]
includeFilters[]
array of strings

Array of filters (as ENUMS) that will be applied to the query. Only NFTs that match one or more of these filters will be included in the response. May not be used in conjunction with excludeFilters[]. Filter Options:

  • 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. Please note that this filter is currently supported only on Ethereum Mainnet and Matic Mainnet, and is available exclusively on paid tiers.
  • AIRDROPS: NFTs that have were airdropped to the user. Airdrops are defined as NFTs that were minted to a user address in a transaction sent by a different address. NOTE: this filter is currently supported on Ethereum Mainnet, Ethereum Goerli, and Matic Mainnet only.
  • To learn more about spam, you can refer to this: Spam NFTs and how to fix them
includeFilters[]
string

Enum - the confidence level at which to filter spam at.

Confidence Levels:

  • VERY_HIGH
  • HIGH
  • MEDIUM
  • LOW

The confidence level set means that any spam that is at that confidence level or higher will be filtered out. For example, if the confidence level is HIGH, contracts that we have HIGH or VERY_HIGH confidence in being spam will be filtered out from the response.
Defaults to VERY_HIGH for Ethereum Mainnet and MEDIUM for Matic Mainnet.

Please note that this filter is only available on paid tiers. Upgrade your account here.

integer

No set timeout by default - When metadata is requested, this parameter is the timeout (in milliseconds) for the website hosting the metadata to respond. If you want to only access the cache and not live fetch any metadata for cache misses then set this value to 0.

string

String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results.

integer
Defaults to 100

Number of NFTs to be returned per page. Defaults to 100. Max is 100.

Response

Response body
object
ownedNfts
array of objects
ownedNfts
object
contract
object

Object - Contract for returned NFT

id
object
string

String - Token balance

string

String - Name of the NFT asset.

string

String - Brief human-readable description

tokenUri
object
media
object
metadata
object

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.

string

String - ISO timestamp of the last cache refresh for the information returned in the metadata field.

string

String - A string describing a particular reason that we were unable to fetch complete metadata for the NFT.

contractMetadata
object
spamInfo
object
acquiredAt
object

Only present if the request specified orderBy=transferTime.

string

String - key for pagination. If more results are available, a pageKey will be returned in the response. Pass back the pageKey as a param to fetch the next page of results.

string

String - Total number of NFTs (distinct tokenIds) owned by the given address.

string

String - The canonical head block hash of when your request was received i.e. the block corresponding to latest

Updated 5 months ago

Did this page help you?
Language
URL
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?
ReadMe
Support Hub