Retrieve Holder Snapshot for NFT 📊 - /nft/holder_snapshot

Endpoint

POST /nft/holder_snapshot

Path Parameters

Parameter	Type	Required	Description
collection_symbol	str	No	Symbol of the NFT collection
nft_address	str	No	Address of the NFT
staking_program_address	str	No	Address of the staking program associated with the NFT
creator_addresses	list[str]	No	Address(es) of the creator(s) associated with the NFT
collection_addresses	list[str]	No	Address(es) of the collection(s) associated with the NFT
update_authority	str	No	Address of the update authority associated with the NFT
candy_machine	str	No	Address of the candy machine associated with the NFT
filter_holder_count	int	No	Minimum number of NFT holdings for a wallet to be included in the snapshot
response_type	str	No	Response type, either "json" or "excel" (default is "json")
exclude_exchanges	bool	No	Whether to exclude exchange wallets when building the holder snapshot (default is False)
include_discord_users	bool	No	Whether to include Discord users in the response (default is False)

Description

This endpoint retrieves the holder snapshot for a given NFT address. The response includes the NFT addresses, the number of holdings for each wallet, and the NFTs held by each wallet.

Query Parameters

The following query parameters can be used to customize the response:

• collection_symbol: Symbol of the NFT collection

• nft_address: Address of the NFT

• staking_program_address: Address of the staking program associated with the NFT

• creator_addresses: Address(es) of the creator(s) associated with the NFT

• collection_addresses: Address(es) of the collection(s) associated with the NFT

• update_authority: Address of the update authority associated with the NFT

• candy_machine: Address of the candy machine associated with the NFT

• filter_holder_count: Minimum number of NFT holdings for a wallet to be included in the snapshot

• response_type: Response type, either "json" or "excel" (default is "json")

• exclude_exchanges: Whether to exclude exchange wallets when building the holder snapshot (default is False)

• include_discord_users: Whether to include Discord users in the response (default is False)

Response

If the response type is "json", the response will be a dictionary containing the following:

• nfts: A list of NFT addresses

• snapshot_owner_counts: A dictionary of wallet addresses and their NFT holdings count

• snapshot_owners: A dictionary of wallet addresses and the NFTs they hold

• owner_count: The number of wallets included in the snapshot

• discord_users: A dictionary of wallet addresses and their corresponding Discord user information (only included if `include_discord