Get non-fungible token holdings

Retrieves a list of non-fungible tokens owned by the given principal (STX address or smart contract ID).


GET
/extended/v1/tokens/nft/holdings

Non-Fungible Token holdings

Retrieves the list of Non-Fungible Tokens owned by the given principal (STX address or Smart Contract ID). Results can be filtered by one or more asset identifiers and can include metadata about the transaction that made the principal own each token.

More information on Non-Fungible Tokens on the Stacks blockchain can be found here.

Query Parameters

principal
Required
string

token owner's STX address or Smart Contract ID

Example: "SPNWZ5V2TPWGQGVDR6T7B6RQ4XMGZ4PXTEE0VQ0S.marketplace-v3"

asset_identifiersarray<string>

identifiers of the token asset classes to filter for

Example: "SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy::candy"

limitinteger

max number of tokens to fetch

Default: 50

offsetinteger

index of first tokens to fetch

Example: 42000Default: 0

unanchoredboolean

whether or not to include tokens from unconfirmed transactions

Example: trueDefault: false

tx_metadataboolean

whether or not to include the complete transaction metadata instead of just tx_id. Enabling this option can affect performance and response times.

Default: false
Status codeDescription
200List of Non-Fungible Token holdings
/extended/v1/tokens/nft/holdings

Terminal
$
curl -X GET "https://api.hiro.so/extended/v1/tokens/nft/holdings?principal=SPNWZ5V2TPWGQGVDR6T7B6RQ4XMGZ4PXTEE0VQ0S.marketplace-v3&asset_identifiers=SPQZF23W7SEYBFG5JQ496NMY0G7379SRYEDREMSV.Candy%3A%3Acandy&limit=50&offset=42000&unanchored=true&tx_metadata=false"

List of Non-Fungible Token holdings

{
"limit": 200,
"offset": 0,
"total": 0,
"results": [
{
"asset_identifier": "string",
"value": {
"hex": "string",
"repr": "string"
},
"block_height": 0,
"tx_id": "string"
}
]
}