Skip to main content

GetAccount

Returns detailed information about an account on the Shamwari Network.

Request

GET /nxt?requestType=getAccount

All endpoints use port 22024 by default.

Parameters

NameTypeDescriptionRequired
accountstringAccount ID or SHAMWARI address (e.g., SHAMWARI-ABCD-EFGH-IJKL-MNOPQ)Yes
includeLessorsbooleanInclude lessor informationOptional
includeTotemsbooleanInclude Totem holdingsOptional
includeCurrenciesbooleanInclude currency holdingsOptional
includeEffectiveBalancebooleanInclude effective balanceOptional
requireBlockstringBlock ID required for responseOptional
requireLastBlockstringLast block ID requiredOptional

Response

{
"account": "1234567890",
"accountRS": "SHAMWARI-ABCD-EFGH-IJKL-MNOPQ",
"balanceFQT": "1000000000",
"unconfirmedBalanceFQT": "1000000000",
"forgedBalanceFQT": "500000000",
"effectiveBalanceFXT": 100,
"guaranteedBalanceFQT": "800000000",
"publicKey": "abc123...",
"domain": "example.com",
"lessors": [],
"totems": [],
"currencies": [],
"errorCode": 0,
"errorDescription": ""
}

Response Fields

FieldTypeDescription
accountstringAccount ID (unsigned 64-bit integer as string)
accountRSstringAccount Reed-Solomon address in SHAMWARI format
balanceFQTstringConfirmed balance in NQT (1 QKP = 10^8 NQT)
unconfirmedBalanceFQTstringBalance including unconfirmed transactions
forgedBalanceFQTstringTotal forged (earned) balance
effectiveBalanceFXTnumberEffective balance in FXT (1 QKP = 10^8 FXT)
guaranteedBalanceFQTstringMinimum guaranteed balance
publicKeystringAccount's public key (hex)
domainstringAssociated account domain
lessorsarrayList of lessor account IDs
totemsarrayList of Totem IDs held by this account
currenciesarrayList of currency IDs held

Error Codes

CodeDescription
3Unknown account

Example

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