klay_getBalance

How to use it

// yarn add @tatumio/tatum

import { TatumSDK, Klaytn, Network } from '@tatumio/tatum'

const tatum = await TatumSDK.init<Klaytn>({network: Network.KLAYTN})

const balance = await tatum.rpc.getBalance('0x11f56be8b506f546f65662279a8641a0f490df40')

await tatum.destroy() // Destroy Tatum SDK - needed for stopping background jobs

Overview

The klay_getBalance method is an JSON-RPC method that allows you to retrieve the balance of a specified address. This method can be used to query the balance of any address, whether it is a contract or an externally owned account (EOA). A common use case for this method is to display the current balance of a user's account in a wallet application or a decentralized application (DApp).

Parameters

The method requires two parameters:

  1. address (required): The address of the account or contract whose balance you want to query.

    • Example: "0x99D270f4a42b296fB888f168a5985e1d9839B064"

  2. blockParameter (optional): The block number or block identifier to specify the point in time for which you want to query the balance.

    • Example: "latest" or "0x1"

Transaction Details

For the purpose of this documentation, we'll also describe the transactions field of a full transaction object. The klay_getBalance method does not return transaction details, but we provide this information for completeness.

A full transaction object includes the following fields:

  • hash: The transaction hash.

  • nonce: The number of transactions made by the sender prior to this one.

  • blockHash: The hash of the block in which the transaction was included.

  • blockNumber: The block number in which the transaction was included.

  • transactionIndex: The index of the transaction in the block.

  • from: The sender's address.

  • to: The recipient's address (or null for contract creation transactions).

  • value: The value transferred, in wei.

  • gasPrice: The gas price provided by the sender, in wei.

  • gas: The maximum gas allowed for the transaction.

  • input: The data sent with the transaction (typically for contract interaction).

  • v, r, s: The raw signature values of the transaction.

Return Object

The method returns a single field:

  • result: The balance of the specified address in wei, as a hexadecimal string.

    • Example: "0x1a2e1a", which corresponds to 1,726,666 wei.

JSON-RPC Request and Response Examples

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "klay_getBalance",
  "params": [
    "0x99D270f4a42b296fB888f168a5985e1d9839B064",
    "latest"
  ]
}

Response

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "BigNumber": {
            "s": 1,
            "e": 18,
            "c": [10611, 3542686313455]
        }
    }
}

Last updated