GET/tokenization/token

Get Tokens

Outcome - Lists this vault's tokens: fungible tokens (ERC-20, ERC-3643, Solana) and ERC-721 collections. Solana NFTs are listed by Get NFTs.

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.

searchstringnullable

Search by name or symbol.

clientIdstringnullable

Your client id (externalId). Returns only tokens owned by this client.

filtersobjectnullable

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

Show child parameters (5)
networkIdnumbernullable

Network ID. Example: filters[networkId]=1

statusstringnullable

PENDING, DEPLOYED, REVERTED, INSUFFICIENT_GAS, ERROR or NONCE_TOO_LOW

idnumbernullable

Token ID

isCollectionbooleannullable

NFTs: true for collections

parentIdnumbernullable

NFTs: collection ID

Responses

Response attributes

messagestring

Response message

dataarray

The tokens. Same fields as Get Token by ID, without vault.

Show child attributes (31)
idnumber

Token ID. Use it in the token routes (Get Token by ID, Get Token Roles, Token Operations).

networkIdnumber

Network the contract is deployed on

deployingWalletIdstring

ID of the vault wallet that sent the deployment

templateVersionstring | null

Contract template: erc20-v1, erc721-v1, erc3643-v1 or title-fraction-v1. null for Solana tokens.

namestring

Token name

symbolstring

Token symbol

decimalsnumber

Decimals of the token. Amounts in the API are in whole units with up to this many decimals.

feesstring | null

Deployment fee paid, in the network's coin. null until deployed.

contractAddressstring | null

Contract address. null until deployed.

assetIdnumber | null

Asset created for the token once deployed: wallets of this asset hold the token. null until deployed.

vaultIdnumber

Vault that created the token

internalOwnerTypestring | null

CLIENT when the owner is a client's wallet, MASTER when it is a master wallet of the vault, null when the owner is outside RoxCustody

internalOwnerTargetIdnumber | null

The RoxCustody client ID when internalOwnerType is CLIENT

ownerAddressstring

Owner of the contract (the OWNER role)

recipientAddressstring

Address that received the initial supply (equal to ownerAddress when none was given)

configobject

The config sent at creation (template settings). Solana and v1 tokens also carry metadataUrl and additional here.

verificationMessagestring | null

The block explorer's answer to the source-code verification

verificationStatusstring

Source-code verification on the block explorer: PENDING, VERIFIED, REJECTED, LimitReached or UNEXPECTED_ERROR

imagestring | null

Image URL, when an image was uploaded

isCollectionboolean

true for an NFT collection

parentIdnumber | null

For an NFT, its collection

parentobject | null

For an NFT, its collection

childrenCountnumber

For a collection, number of NFTs in it

networkobject

The network

Show child attributes (12)
idnumber

Network ID

namestring

Network name

symbolstring

Symbol of the network's coin

createdAtstring

Creation date

updatedAtstring

Last update date

typestring

PUBLIC or PRIVATE

statusstring

Network status, for example ACTIVE

logostring

Network logo URL

isSwappableboolean

Whether swaps are available on this network

categorystring

Network family, for example EVM or Solana

chainobject

Chain details: id, name, nativeCurrency, rpcUrls, blockExplorers and testnet

addressFormatobject

Address format: prefixes and lengthRange

createdAtstring

Creation date

updatedAtstring

Last update date

typestring

Asset type of the token: ERC20 for every fungible EVM token (ERC-20 and ERC-3643 alike), NFT_COLLECTION for an ERC-721 collection, TOKEN or NFT on Solana

standardstring | null

Token standard: ERC20, ERC3643, ERC721, SPL_TOKEN or SOLANA_NFT

statusstring

Deployment status: PENDING, DEPLOYED, REVERTED, INSUFFICIENT_GAS, ERROR or NONCE_TOO_LOW

tokenExplorerUrlstring | null

Link to the contract on the block explorer. null until deployed.

initialSupplystring

Supply minted at creation, in whole units. "0" for ERC-3643 and ERC-721, whose supply comes from later operations.

statusnumber

HTTP status code

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

Was this page helpful?