Skip to main content
The check_balance tool returns the agent’s wallet address and network, and the Nebula Hub automatically enriches that response with the live XLM (Lumen) balance and — if a USDC trustline is open — the current USDC balance. Call this tool any time the agent needs to decide whether it has enough funds to proceed, report its financial state, or confirm that a transfer or funding action landed correctly.

​
Parameters

check_balance takes no parameters. Pass an empty object {} as the tool input.

​
Response

​
status
string
"ok" on success.
​
data.address
string
The agent’s Stellar public key (G…), confirming which wallet was queried.
​
data.network
string
The Stellar network this wallet is on. Either "testnet" or "mainnet".
​
message
string
A human-readable summary of the wallet’s current balances, ready to surface directly in an agent response. Provided by the Hub after fetching live Stellar data.

​
Example

Call: 
{}
Response: 
{
  "status": "ok",
  "data": {
    "address": "GBFSOIY52ZUWZGSCYWRXBBKJKZB5XFXO5X7J7AEACPFN7O3NBSHW3M5",
    "network": "mainnet"
  },
  "message": "XLM: 245.3000000 | USDC: 50.0000000"
}
Balance figures in message are fetched live from the Stellar network by the Nebula Hub at the time of the call. The data object always contains address and network; the Hub appends balance detail to message. USDC only appears when the wallet has an active USDC trustline. To open a trustline, visit the Connect page in your Nebula dashboard.