🎨 NFT APINft API V2 Methods (Older Version)

getNFTs

Gets all NFTs currently owned by a given address.

Path parameters

apiKeystringRequired

Query parameters

ownerstringRequired

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

contractAddresses[]list of stringsOptional

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

withMetadatabooleanOptionalDefaults 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.

orderByenumOptional

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.
Allowed values:
excludeFilters[]list of enumsOptional

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
Allowed values:
includeFilters[]list of enumsOptional

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
Allowed values:
spamConfidenceLevelenumOptional

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.

Allowed values:
tokenUriTimeoutInMsintegerOptional

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.

pageKeystringOptional

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.

pageSizeintegerOptionalDefaults to 100

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

Response

Returns the list of all NFTs owned by the given address and satisfying the given input parameters.

ownedNftslist of objectsOptional
pageKeystringOptional
totalCountintegerOptional

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

blockHashstringOptional

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