get_address_summary
Get an XCH balance summary for a Chia address or puzzle hash, paging unspent coin records and returning a flag when results are incomplete.
Instructions
Get a complete balance summary for a Chia address (xch1.../txch1...) or puzzle hash (0x...). Pages through unspent coin records using automatic height-windowed pagination (scanning from peak downward) to produce a total with a complete flag indicating whether all coins were reached. A single get_coin_records_by_puzzle_hash call may return at most 50,000 records (the Coinset per-request cap). Returns: total_mojos, total_xch (string), unspent_coin_count, pages_scanned, excludes (always [CAT, NFT, DID] — this tool counts XCH only), and a complete flag (true when all coins were enumerated; false if pagination was cut short — the result is a lower bound, not the full balance). ⚠️ Addresses with 50k+ coins (e.g. active farming addresses) may return complete: false with incomplete_reason: 'time_budget_exceeded' or 'early_exit_sparse' — the total_mojos is a lower bound, not the true balance. For full enumeration of large farming addresses, use get_coin_records_by_puzzle_hash with explicit start_height/end_height windows to page through the full history. Also returns a network-mismatch warning if the address prefix doesn't match the configured network. Use this tool for balance lookups — do NOT sum raw coin record results.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"address": "<address>"
},
"name": "get_address_summary"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| address | Yes | A Chia address (xch1.../txch1...) or puzzle hash (0x-prefixed 64-char hex). Addresses are auto-decoded. |