GET/wallets/{walletId}/nfts

Get Wallet NFTs

Outcome - Lists the individual NFTs held by a wallet of this vault (one entry per token ID), across all collections.

Path Parameters

walletIdnumber

Wallet ID

Query Parameters

pagenumberdefault: 1nullable

Page number, starting at 1.

limitnumberdefault: 10nullable

Number of results per page.

sortKeystringdefault: idnullable

Field to sort by. Allowed values: id.

orderstringnullable

Sort direction: ASC or DESC.

filtersobjectnullable

Filters, passed as filters[field]=value. Only the fields listed below are accepted; any other field returns 422.

Show child parameters (1)
statestringnullable

MINTED or BURNED. Example: filters[state]=MINTED

Responses

Response attributes

messagestring

Success message

dataarray

NFTs held by the wallet

Show child attributes (9)
assetIdnumber

Asset ID of the NFT collection

securityTokenIdnumber | null

ID of the collection created with the Tokens API (null if the NFT comes from an outside collection)

nftTokenIdstring

On-chain token ID of this NFT inside its collection

holderAddressstring

Address that currently holds the NFT

holderWalletIdnumber | null

RoxCustody wallet ID of the holder, or null if the holder is outside RoxCustody

metadataUrlstring | null

URL of the NFT metadata (JSON)

statestring

MINTED or BURNED

createdAtstring

When RoxCustody first saw the NFT

updatedAtstring

Last change (for example a transfer)

metaobject

Page pagination. Increase the page query parameter to get the next page.

Show child attributes (6)
totalItemsnumber

Total number of matching items

itemsPerPagenumber

Page size used for this request

totalPagesnumber

Total number of pages

currentPagenumber

The page returned

hasPreviousPageboolean

true if currentPage > 1

hasNextPageboolean

true if currentPage < totalPages

statusnumber

HTTP status code

Was this page helpful?