AptosAptos Network's breakthrough technology and seamless user experience are now available on QuickNode.

Start building today!     

Contents

getTokenAccountsByOwner RPC Method

The API credit value for this method is 1 . To learn more about API credits and each method's value, visit the API Credits page.

Parameters:

  1. Pubkey - string - The Pubkey of account delegate to query encoded as base-58 string
  2. object - (optional) The JSON object with the following fields:

    mint - string - The Pubkey of the specific token Mint to limit accounts to, as base-58 encoded string

    programId - string - The Pubkey of the Token program ID that owns the accounts, as base-58 encoded string

    object - (optional) The configuration object with the following fields:

    Commitment - string - (optional) The level of commitment required for the query. The options include:

    Finalized - string - The node will query the most recent block confirmed by the supermajority of the cluster as having reached maximum lockout, meaning the cluster has recognized this block as finalized

    Confirmed - string - The node will query the most recent block that has been voted on by the supermajority of the cluster

    Processed - string - The node will query its most recent block. Note that the block may not be complete

    encoding - string - (optional) The encoding format for account data. It can be one of base58 (slow), base64, base64+zstd or jsonParsed

    dataSlice - string - (optional) The returned account data using the provided offset: 'usize' and length: 'usize' fields; only available for base58, base64, or base64+zstd encodings

    minContextSlot - integer - (optional) The minimum slot at which the request can be evaluated

Returns:

  1. result - An object with the following fields:

    context - The information about the current state of the program

    apiVersion - The version of the Solana RPC API to use

    slot - An integer representing the slot for which to retrieve the fee calculator

    value - A JSON object with the following fields:

    account - An address on the Solana blockchain that is used to store assets

    data - A string containing the encoded data to be passed to the instruction

    parsed - An array of parsed instructions that were executed in the block's transactions

    info - An array of information objects that provide additional details about the transactions in the block

    isNative - A boolean value indicating whether the token is a native token of the Solana blockchain

    mint - Provides information about the creation of new tokens

    owner - The base-58 encoded Pubkey of the program this account has been assigned to

    state - The current state of the token account

    tokenAmount - The balance of the token in the token account

    amount - The raw total token supply without decimals, a string representation of a u64 integer

    decimals - An integer value representing the number of decimal places used by the token

    uiAmount - The total token supply using mint-prescribed decimals (DEPRECATED)

    uiAmountString - The total token supply as a string using mint-prescribed decimals

    type - The type of the block. It can be used to differentiate between regular blocks and special blocks such as snapshot or transaction confirmation blocks

    program - The program that manages the token

    space - The amount of storage space required to store the token account

    executable - A boolean indicating if the account contains a program (and is strictly read-only)

    lamports - The number of lamports assigned to this account as u64 (64-bit unsigned integer)

    owner - The base-58 encoded Pubkey of the program this account has been assigned to

    rentEpoch - The epoch at which the token account's storage will be subject to rent

    pubkey - The public key associated with the token account

Code Examples:

curl http://sample-endpoint-name.network.quiknode.pro/token-goes-here/ \
  -X POST \
  -H "Content-Type: application/json" \
  --data '{"jsonrpc": "2.0","id": 1,"method": "getTokenAccountsByOwner","params": ["GgPpTKg78vmzgDtP1DNn72CHAYjRdKY7AV6zgszoHCSa",{"mint": "1YDQ35V8g68FGvcT85haHwAXv1U7XMzuc4mZeEXfrjE"},{"encoding": "jsonParsed"}]}'
Ready to get started? Create a free account