Address Index RPC Commands

The Address Index allows you to query balances, deltas, and unspent outputs for specific addresses.

!!! warning "Requirement" These commands require the node to be started with the -addressindex=1 flag. If you are enabling it on an existing installation, a -reindex might be necessary.

---

getaddressbalance

Returns the balance for an address(es) (requires addressindex to be enabled).

Arguments

Position	Name	Type	Required	Default	Description
1	addresses	json array	Optional	[]	See CLI help for details
2	asset	string	Optional	RTM) Get balance for a particular asset instead of RTM. ("*" for all assets	See CLI help for details

Examples

 raptoreum-cli getaddressbalance '{"addresses": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"]}'

 curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressbalance", "params": [{"addresses": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/

---

---

getaddressdeltas

Returns all changes for an address or multiple addresses.

Arguments

Position	Name	Type	Required	Default	Description
1	addresses	json array	No	[]	A list of base58check encoded addresses.
2	asset	string	No	"RTM"	Get deltas for a particular asset instead of RTM.

Result

[
  {
    "satoshis" : n,       /* The difference of duffs */
    "assetId" : "str",    /* The asset id */
    "txid" : "hex",       /* The related txid */
    "index" : n,          /* The related input or output index */
    "blockindex" : n,     /* The related block index */
    "height" : n,         /* The block height */
    "address" : "str"     /* The base58check encoded address */
  }
]

Examples

> raptoreum-cli getaddressdeltas '{"addresses": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"]}'

> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressdeltas", "params": [{"addresses": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/

---

getaddressmempool

Returns all mempool deltas for an address (requires addressindex to be enabled).

Arguments

Position	Name	Type	Required	Default	Description
1	addresses	json array	Optional	[]	See CLI help for details

Result

[                          (json array)
  {                        (json object)
    "address" : "str",     (string) The base58check encoded address
    "asset" : "str",       (string) The asset name of the associated asset
    "assetId" : "str",     (string) (only on assets) The asset Id of the associated asset
    "txid" : "hex",        (string) The related txid
    "index" : n,           (numeric) The related input or output index
    "satoshis" : n,        (numeric) The difference of duffs
    "timestamp" : xxx,     (numeric) The time the transaction entered the mempool (seconds)
    "prevtxid" : "hex",    (string) The previous txid (if spending)
    "prevout" : n          (numeric) The previous transaction output index (if spending)
  },
  ...
]

Examples

 raptoreum-cli getaddressmempool '{"addresses": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"]}'

 curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressmempool", "params": [{"addresses": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"]}] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/

---