Get Lamport Balance
Gets the SOL balance of an account in lamports (1 SOL = 1,000,000,000 lamports). Lamports are the smallest unit of SOL, similar to how cents are the smallest unit of dollars.
Returns: Promise<Lamports> - The balance in lamports as a bigint
const balance = await connection.getLamportBalance(address, commitment);Options
address:string- Address to check balance forcommitment:Commitment(optional) - Desired commitment level . Can be"processed","confirmed", or"finalized"(default).
Example
// Get balance in lamports
const balanceInLamports = await connection.getLamportBalance("GkFTrgp8FcCgkCZeKreKKVHLyzGV6eqBpDHxRzg1brRn");
// Convert to SOL
const balanceInSOL = Number(balanceInLamports) / 1_000_000_000;
console.log(`Balance: ${balanceInSOL} SOL`);Errors
- Throws if the address is invalid
- Throws if the RPC connection fails
See also: Transfer Lamports, Airdrop if Required
Last updated on