Skip to main content

Get Token Accounts by Asset Type

POST
Retrieves the list of accounts holding a specific asset type.
Path Parameters
chainstringrequired
Parameter specifying the target chain to query.
networkstringrequired
Parameter specifying the network of the target chain.
Request Body
assetTypestring
Parameter specifying the asset type to query.The asset type must be entered as a 64-character hexadecimal string (including "0x") using one of the following formats:
  • Coin: Asset ID in Struct format such as "0x1::aptos_coin::AptosCoin"
  • Fungible Asset: Object address that owns the Token Metadata
linkedAssetTypestring
Common identifier for querying Coin and FA (Fungible Asset) as a single asset unit.linkedAssetType must contain the Object address of the migrated FA, entered in 64-character hexadecimal format (including "0x").
pageinteger
The page parameter specifies the data page to query. It accepts values up to 100; for pages exceeding 100, use the cursor pagination method.The page and cursor parameters cannot be used together. If both page and cursor are empty, cursor pagination is used.
rppinteger
rpp stands for results per page and specifies the page size. You can specify a number greater than 0 and up to 100.
cursorstring
The cursor parameter supports pagination and data navigation between pages. Provide the cursor value from the previous page in the next request to load the next page of data.The page and cursor parameters cannot be used together. If both page and cursor are empty, cursor pagination is used.
withCountboolean
Parameter specifying whether to include the count field in the response. The count field indicates the total number of requested data items. When set to true, the count field is included and response speed may be slower.
Responses
pageinteger
Field representing the page number specified in the page parameter. This field is only included in the response when a value greater than 0 is specified for the page parameter.
rppinteger
Field representing the number of results per page specified in the rpp parameter.
cursorstring
A field for cursor pagination. This value must be provided in the next request to load the next page of data.
countinteger
Field representing the total count of requested data. This field is only included in the response when true is set for the withCount parameter.
ownerAddressstringrequired
A field that represents the address of the account holding the asset.Provided as a 64-character hexadecimal string prefixed with 0x; identifies the actual owner of the asset.For Coin: the holding account address; for Fungible Asset: the Object owner's address.
objectAddressstringrequired
A field that represents the address of the Object where the asset is stored.Provided depending on storage location:
  • Coin: empty string ("") as it is stored directly in the account
  • Fungible Asset: Object address where the token is stored (64-character hexadecimal string prefixed with 0x)
valuestringrequired
A field that represents the quantity of the held asset.Provided as a string in integer form; decimals are not included.The asset's decimals must be considered when calculating the actual value.
isFrozenbooleanrequired
A field that indicates whether the asset can be transferred.true means the asset is frozen and cannot be transferred.Used to check the transfer restriction status of the asset.
isPrimarybooleanrequired
A field that indicates whether this Object is the representative Object for the Owner address.true means this Object is the representative Object for the Owner address.
assetTypestringrequired
A field that represents the unique identifier of the asset.Provided in one of two formats:
  • Coin: Asset ID in Move struct format (e.g., 0x1::aptos_coin::AptosCoin)
  • Fungible Asset: Object address that owns the metadata of the asset
tokenStandardstringrequired
A field that represents the standard the asset follows.
  • v1: Assets following the Coin standard
  • v2: Assets following the Fungible Asset standard
linkedAssetTypestringrequired
A common identifier that links Coin and Fungible Asset when they have been migrated.This field serves as a unified key that groups Coin/Fungible Asset into a single asset unit for identification and retrieval, providing the Object address where the migrated Fungible Asset's Metadata is stored.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "MISSING_REQUIRED_PARAMETER",
  "message": "Missing required parameter: { PARAMETER_NAME }"
}
cURL
curl -X POST 'https://web3.nodit.io/v1/aptos/mainnet/token/getTokenAccountsByAssetType' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "assetType": "0x1::aptos_coin::AptosCoin",
    "linkedAssetType": "0x000000000000000000000000000000000000000000000000000000000000000a",
    "page": 1,
    "rpp": 10
  }'