Wallet NFTs

This API endpoint allows you to retrieve a list of NFTs that are present in a specified wallet. The response is not restricted to a single contract and includes various optional parameters to filter and customize the results.

Endpoint Details

DescriptionData

API Name

HTTP Method

GET

URL

/v1/wallet/nft/list

Headers

KeyValue

Content-Type

application/json

x-api-key

API_KEY

Query Parameters

ParameterTypeDescription

walletAddress

string, optional

One of wallet identifier. A wallet address for an Ethereum wallet - compatible with any EVM-based blockchain.

walletId

string, optional

One of wallet identifier. A unique, anonymized identifier for a user's wallet.

email

string, optional

One of wallet identifier. The email address of the user that is associated with their wallet

phone

string, optional

One of wallet identifier. The phone number of the user that is associated with their wallet. Include a + and the country code.

includeMetadata

Boolean

Default: false. Toggle whether the metadata for each NFT should be included in the response.

contractIds

string

Contract IDs separated by a comma. If this parameter is not specified, then results for all contracts will be returned.

contractAddresses

string, optional

Contract addresses separated by ','

retrieveAll

Boolean

Default: false. Toggle whether all NFTs in the specified wallet should be retrieved, or only ones that you minted to the wallet.

This request is very flexible and can be used to retrieve all NFTs in a wallet, or only NFTs that match a specific set of criteria. You must include one of the following to identify the wallet you want to retrieve the NFTs of:

  • email

  • phone

  • walletId

  • walletAddress

Examples

Notes

  1. Ensure to provide exactly one wallet identifier and appropriately handle the optional parameters based on the requirements.

  2. You should set includeMetadata to true if you want to retrieve the metadata of the NFTs (traits, image URL, etc).

  3. You should include either contractIds or both contractAddresses and blockchain if you want to filter the response for NFTs on certain contracts.

  4. You should set retrieveAll to true if you want NFTs that are in the wallet but that you did not mint to the wallet to be included in the response.

Last updated