Skip to main content

GetBalance

Returns the confirmed and unconfirmed balance for an account.

Request

GET /nxt?requestType=getBalance

All endpoints use port 22024 by default.

Parameters

NameTypeDescriptionRequired
accountstringAccount ID or SHAMWARI addressYes
heightintBlock height for historical balanceOptional

Response

{
"balanceFQT": "1000000000",
"unconfirmedBalanceFQT": "1000000000",
"guaranteedBalanceFQT": "800000000",
"forgedBalanceFQT": "500000000",
"errorCode": 0,
"errorDescription": ""
}

Response Fields

FieldTypeDescription
balanceFQTstringConfirmed balance in NQT
unconfirmedBalanceFQTstringBalance including unconfirmed transactions
guaranteedBalanceFQTstringMinimum guaranteed balance
forgedBalanceFQTstringTotal forged (earned) balance

Error Codes

CodeDescription
3Unknown account

Example

curl "http://localhost:22024/nxt?requestType=getBalance&account=SHAMWARI-ABCD-EFGH-IJKL-MNOPQ"