Skip to content

Get Balance

Get the balance of an account.

Request:

  • requestType is getBalance
  • account is an account ID
  • includeEffectiveBalance is true to include effectiveBalanceXIN and guaranteedBalanceTQT (optional)
  • height is the height to retrieve account balance for, if still available (optional)
  • requireBlock is the block ID of a block that must be present in the blockchain during execution (optional)
  • requireLastBlock is the block ID of a block that must be last in the blockchain during execution (optional)

Response:

  • unconfirmedBalanceTQT (S) is balanceTQT less unconfirmed outgoing transactions, the balance displayed in the client
  • guaranteedBalanceTQT (S) is the balance (in TQT) of the account with at least 1440 confirmations
  • effectiveBalance (N) is the balance (in XIN) of the account available for forging: the unleased guaranteedBalance of this account plus the leased
  • guaranteedBalance of all lessors to this account
  • forgedBalanceTQT (S) is the balance (in TQT) that the account has forged
  • balanceTQT (S) is the minimally confirmed basic balance (in TQT) of the account
  • lastBlock (S) is the last block ID on the blockchain (applies if requireBlock is provided but not requireLastBlock)
  • requestProcessingTime (N) is the API request processing time (in millisec)