GetEffectiveBalance
Returns the effective balance of an account, which is the balance used for calculating forging and other network participation metrics. The effective balance is the confirmed balance minus any amounts that are locked in transactions or lease agreements, divided by the number of confirmations required.
Request
GET /nxt?requestType=getEffectiveBalance
All endpoints use port 22024 by default.
Parameters
| Name | Type | Description | Required |
|---|---|---|---|
account | string | Account ID or SHAMWARI address | Yes |
height | int | Block height for historical query | Optional |
Response
{
"balanceFQT": "1000000000",
"effectiveBalanceFXT": 100,
"errorCode": 0,
"errorDescription": ""
}
Response Fields
| Field | Type | Description |
|---|---|---|
balanceFQT | string | Confirmed balance in NQT |
effectiveBalanceFXT | number | Effective balance in FXT (1 QKP = 10^8 FXT) |
Error Codes
| Code | Description |
|---|---|
| 3 | Unknown account |
Example
curl "http://localhost:22024/nxt?requestType=getEffectiveBalance&account=SHAMWARI-ABCD-EFGH-IJKL-MNOPQ"