Skip to main content

GetAccountProperties

Retrieves properties set on a specific account, optionally filtered by property name, setter, or recipient.

Request

GET /nxt?requestType=get-account-properties

All endpoints use port 22024 by default.

Parameters

NameTypeDescriptionRequired
accountstringAccount ID or SHAMWARI addressOptional
recipientstringFilter by recipient accountOptional
propertystringFilter by property nameOptional
setterstringFilter by setter accountOptional
firstIndexintPagination start indexOptional
lastIndexintPagination end indexOptional

Response

{
"properties": [
{
"property": "my_property",
"value": "my_value",
"setter": "1234567890",
"setterRS": "SHAMWARI-WXYZ-ABCD-EFGH-IJKLM",
"recipient": "0987654321",
"recipientRS": "SHAMWARI-MNOP-QRST-UVWX-YZABC",
"height": 250
}
]
}

Response Fields

FieldTypeDescription
propertystringProperty name
valuestringProperty value
setterstringAccount ID that set the property
setterRSstringSetter's SHAMWARI address
recipientstringAccount ID the property is set for
recipientRSstringRecipient's SHAMWARI address
heightintBlock height when property was set

Error Codes

CodeDescription
3Unknown account

Example

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