For the complete documentation index, see llms.txt. This page is also available as Markdown.

getBalance

Returns the balance of the account of provided Pubkey.

This method will use 30 Compute Units.


Parameters

  • address string Required. The Pubkey of the account to query encoded as base-58 string.

  • object optional. Configuration object containing the following fields:

    • commitment string. 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.

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

    • dataSlice string.

      • The returned account data using the provided offset: <usize> and length: <usize> fields; only available for base58, base64, or base64+zstd encodings.

    • minContextSlot integer. The minimum slot at which the request can be evaluated.

Returns

  • result object. Null if the account doesn't exist otherwise RpcResponse JSON object with the following fields:

    • context

      • An object that contains metadata about the current state of the Solana network at the time the request was processed.

        • apiVersion - The version number.

        • slot - The current slot in the Solana cluster during which the transactions are processed and new blocks are added to the blockchain.

    • value -The balance of the account of provided Pubkey in lamports (1 billion lamports = 1 SOL).

Last updated

Was this helpful?