Wallet RPC Commands
Documentation for Raptoreum Wallet RPC calls.
abandontransaction
Mark in-wallet transaction
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
Examples
raptoreum-cli abandontransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abandontransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
abortrescan
Stops current wallet rescan triggered by an RPC call, e.g. by an importprivkey call.
Arguments
No arguments.
Result
true|false (boolean) Whether the abort was successful
Examples
Import a private key
raptoreum-cli importprivkey "mykey"
Abort the running wallet rescan
raptoreum-cli abortrescan
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "abortrescan", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
addmultisigaddress
Add a nrequired-to-sign multisignature address to the wallet. Requires a new wallet backup.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
{ (json object)
"address" : "str", (string) The value of the new multisig address
"redeemScript" : "hex" (string) The string value of the hex-encoded redemption script
}
Examples
Add a multisig address from 2 addresses
raptoreum-cli addmultisigaddress 2 "[\"Xt4qk9uKvQYAonVGSZNXqxeDmtjaEWgfrS\",\"XoSoWQkpgLpppPoyyzbUFh1fq2RBvW6UK2\"]"
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "addmultisigaddress", "params": [2, "[\"Xt4qk9uKvQYAonVGSZNXqxeDmtjaEWgfrS\",\"XoSoWQkpgLpppPoyyzbUFh1fq2RBvW6UK2\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
backupwallet
Safely copies current wallet file to destination, which can be a directory or a path with filename.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
Examples
raptoreum-cli backupwallet "backup.dat"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "backupwallet", "params": ["backup.dat"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
createwallet
Creates and loads a new wallet.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | disable_private_keys |
boolean | Optional | false) Disable the possibility of private keys (only watchonlys are possible in this mode | See CLI help for details |
| 3 | blank |
boolean | Optional | false | See CLI help for details |
Result
{ (json object)
"name" : "str", (string) The wallet name if created successfully. If the wallet was created using a full path, the wallet_name will be the full path.
"warning" : "str" (string) Warning message if wallet was not loaded cleanly.
}
Examples
raptoreum-cli createwallet "testwallet"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "createwallet", "params": ["testwallet"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
dumphdinfo
{ (json object)
Arguments
No arguments.
Result
{ (json object)
"hdseed" : "hex", (string) The HD seed (bip32, in hex)
"mnemonic" : "str", (string) The mnemonic for this HD wallet (bip39, english words)
"mnemonicpassphrase" : "str" (string) The mnemonic passphrase for this HD wallet (bip39)
}
Examples
raptoreum-cli dumphdinfo
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumphdinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
dumpprivkey
Reveals the private key corresponding to 'address'.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
"str" (string) The private key
Examples
raptoreum-cli dumpprivkey "myaddress"
raptoreum-cli importprivkey "mykey"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpprivkey", "params": ["myaddress"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
dumpwallet
Dumps all wallet keys in a human-readable format to a server-side file. This does not allow overwriting existing files.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
{ (json object)
"keys" : n, (numeric) The number of keys contained in the wallet dump
"filename" : "str", (string) The filename with full absolute path
"warning" : "str" (string) A warning about not sharing the wallet dump with anyone
}
Examples
raptoreum-cli dumpwallet "test"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "dumpwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
encryptwallet
Encrypts the wallet with 'passphrase'. This is for first time encryption.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
"str" (string) A string with further instructions
Examples
Encrypt your wallet
raptoreum-cli encryptwallet "my pass phrase"
Now set the passphrase to use the wallet, such as for signing or sending raptoreum
raptoreum-cli walletpassphrase "my pass phrase"
Now we can do something like sign
raptoreum-cli signmessage "address" "test message"
Now lock the wallet again by removing the passphrase
raptoreum-cli walletlock
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "encryptwallet", "params": ["my pass phrase"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getaddressesbylabel
Returns the list of addresses assigned the specified label.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
{ (json object) json object with addresses as keys
"address" : { (json object) json object with information about address
"purpose" : "str" (string) Purpose of address ("send" for sending address, "receive" for receiving address)
},
...
}
Examples
raptoreum-cli getaddressesbylabel "tabby"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressesbylabel", "params": ["tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getaddressinfo
Return information about the given raptoreum address. Some information requires the address
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
{ (json object)
"address" : "str", (string) The raptoreum address validated.
"scriptPubKey" : "hex", (string) The hex-encoded scriptPubKey generated by the address.
"ismine" : true|false, (boolean) If the address is yours.
"iswatchonly" : true|false, (boolean) If the address is watchonly.
"solvable" : true|false, (boolean) Whether we know how to spend coins sent to this address, ignoring the possible lack of private keys.
"desc" : "str", (string, optional) A descriptor for spending coins sent to this address (only when solvable).
"isscript" : true|false, (boolean) If the key is a script.
"ischange" : true|false, (boolean) If the address was used for change output.
"script" : "str", (string, optional) The output script type. Only if "isscript" is true and the redeemscript is known. Possible types: nonstandard, pubkey, pubkeyhash, scripthash, multisig, nulldata
"hex" : "hex", (string, optional) The redeemscript for the p2sh address.
"pubkeys" : [ (json array, optional) Array of pubkeys associated with the known redeemscript (only if "script" is "multisig").
"str", (string)
...
],
"sigsrequired" : n, (numeric, optional) The number of signatures required to spend multisig output (only if "script" is "multisig").
"pubkey" : "hex", (string, optional) The hex value of the raw public key, for single-key addresses.
"iscompressed" : true|false, (boolean, optional) If the pubkey is compressed.
"label" : "str", (string) The label associated with the address, "" is the default label.
"timestamp" : xxx, (numeric, optional) The creation time of the key, if available, expressed in UNIX epoch time.
"hdchainid" : "hex", (string, optional) The ID of the HD chain.
"hdkeypath" : "str", (string, optional) The HD keypath, if the key is HD and available.
"hdseedid" : "hex", (string, optional) The Hash160 of the HD seed.
"hdmasterfingerprint" : "hex", (string, optional) The fingerprint of the master key.
"labels" : [ (json array) Array of labels associated with the address.
"str", (string) The label name. Defaults to "".
{ (json object) json object of label data
"name" : "str", (string) The label.
"purpose" : "str" (string) Purpose of address ("send" for sending address, "receive" for receiving address)
},
...
]
}
Examples
raptoreum-cli getaddressinfo "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getaddressinfo", "params": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getbalance
Returns the total available balance.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | minconf |
numeric | Optional | 0 | See CLI help for details |
| 3 | addlocked |
boolean | Optional | false | See CLI help for details |
| 4 | include_watchonly |
boolean | Optional | false) Also include balance in watch-only addresses (see 'importaddress' | See CLI help for details |
Result
n (numeric) The total amount in RTM received at this wallet.
Examples
The total amount in the wallet with 0 or more confirmations
raptoreum-cli getbalance
The total amount in the wallet at least 6 blocks confirmed
raptoreum-cli getbalance "*" 6
As a json rpc call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getbalance", "params": ["*", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getnewaddress
Returns a new Raptoreum address for receiving payments.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | label |
string | Optional | "" | See CLI help for details |
Result
"str" (string) The new raptoreum address
Examples
raptoreum-cli getnewaddress
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getnewaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getrawchangeaddress
Returns a new Raptoreum address, for receiving change.
Arguments
No arguments.
Result
"str" (string) The address
Examples
raptoreum-cli getrawchangeaddress
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getrawchangeaddress", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getreceivedbyaddress
Returns the total amount received by the given address in transactions with at least minconf confirmations.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | minconf |
numeric | Optional | 1 | See CLI help for details |
| 3 | addlocked |
boolean | Optional | false | See CLI help for details |
Result
n (numeric) The total amount in RTM received at this address.
Examples
The amount from transactions with at least 1 confirmation
raptoreum-cli getreceivedbyaddress "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG"
The amount including unconfirmed transactions, zero confirmations
raptoreum-cli getreceivedbyaddress "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 0
The amount with at least 6 confirmations
raptoreum-cli getreceivedbyaddress "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 6
As a json rpc call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbyaddress", "params": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getreceivedbylabel
Returns the total amount received by addresses with
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | minconf |
numeric | Optional | 1 | See CLI help for details |
| 3 | addlocked |
boolean | Optional | false | See CLI help for details |
Result
n (numeric) The total amount in RTM received at this label.
Examples
Amount received by the default label with at least 1 confirmation
raptoreum-cli getreceivedbylabel ""
Amount received at the tabby label including unconfirmed amounts with zero confirmations
raptoreum-cli getreceivedbylabel "tabby" 0
The amount with at least 6 confirmations
raptoreum-cli getreceivedbylabel "tabby" 6
As a json rpc call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getreceivedbylabel", "params": ["tabby", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
gettransaction
Get detailed information about in-wallet transaction
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | include_watchonly |
boolean | Optional | false | See CLI help for details |
Result
{ (json object)
"amount" : n, (numeric) The amount in RTM
"fee" : n, (numeric) The amount of the fee in RTM. This is negative and only available for the
'send' category of transactions.
"confirmations" : n, (numeric) The number of blockchain confirmations for the transaction. Available for 'send' and
'receive' category of transactions. Negative confirmations indicate the
transaction conflicts with the block chain
"instantlock" : true|false, (boolean) Current transaction lock state. Available for 'send' and 'receive' category of transactions
"instantlock-internal" : true|false, (boolean) Current internal transaction lock state. Available for 'send' and 'receive' category of transactions
"chainlock" : true|false, (boolean) The state of the corresponding block chainlock
"trusted" : true|false, (boolean) Whether we consider the outputs of this unconfirmed transaction safe to spend.
"blockhash" : "hex", (string) The block hash containing the transaction. Available for 'send' and 'receive'
category of transactions.
"blockindex" : n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive'
category of transactions.
"blocktime" : xxx, (numeric) The block time expressed in UNIX epoch time.
"txid" : "hex", (string) The transaction id. Available for 'send' and 'receive' category of transactions.
"time" : xxx, (numeric) The transaction time expressed in UNIX epoch time.
"timereceived" : xxx, (numeric) The time received expressed in UNIX epoch time. Available
for 'send' and 'receive' category of transactions.
"comment" : "str", (string) If a comment is associated with the transaction.
"details" : [ (json array)
{ (json object)
"involvesWatchonly" : true|false, (boolean) Only returns true if imported addresses were involved in transaction
"address" : "str", (string) The raptoreum address involved in the transaction.
"category" : "str", (string) The category, either 'send' or 'receive'.
"amount" : n, (numeric) The amount in RTM
"label" : "str", (string) A comment for the address/transaction, if any
"vout" : n, (numeric) the vout value
"fee" : n, (numeric) The amount of the fee in RTM. This is negative and only available for the
'send' category of transactions.
"abandoned" : true|false (boolean) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the
'send' category of transactions.
},
...
],
"hex" : "hex" (string) Raw data for transaction
}
Examples
raptoreum-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"
raptoreum-cli gettransaction "1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d" true
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "gettransaction", "params": ["1075db55d416d3ca199f55b6084e2115b9345e16c5cf302fc80e9d5fbf5d48d"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
getunconfirmedbalance
n (numeric) The balance
Arguments
No arguments.
Result
n (numeric) The balance
getwalletinfo
{ (json object)
Arguments
No arguments.
Result
{ (json object)
"walletname" : "str", (string) the wallet name
"walletversion" : n, (numeric) the wallet version
"balance" : n, (numeric) the total confirmed balance of the wallet in RTM
"coinjoin_balance" : n, (numeric) the CoinJoin balance in RTM
"unconfirmed_balance" : n, (numeric) the total unconfirmed balance of the wallet in RTM
"immature_balance" : n, (numeric) the total immature balance of the wallet in RTM
"txcount" : n, (numeric) the total number of transactions in the wallet
"timefirstkey" : xxx, (numeric) the UNIX epoch time of the oldest known key in the wallet
"keypoololdest" : xxx, (numeric) the UNIX epoch time of the oldest pre-generated key in the key pool
"keypoolsize" : n, (numeric) how many new keys are pre-generated (only counts external keys)
"keypoolsize_hd_internal" : n, (numeric) how many new keys are pre-generated for internal use (used for change outputs, only appears if the wallet is using this feature, otherwise external keys are used)
"keys_left" : n, (numeric) how many new keys are left since last automatic backup
"unlocked_until" : xxx, (numeric) the UNIX epoch time until which the wallet is unlocked for transfers, or 0 if the wallet is locked
"paytxfee" : n, (numeric) the transaction fee configuration, set in RTM/kB
"hdchainid" : "hex", (string) the ID of the HD chain
"hdaccountcount" : "str", (string) how many accounts of the HD chain are in this wallet
"" : [ (json array)
{ (json object)
"hdaccountindex" : n, (numeric) the index of the account
"hdexternalkeyindex" : n, (numeric) current external childkey index
"hdinternalkeyindex" : n (numeric) current internal childkey index
},
...
],
"scanning" : { (json object) current scanning details, or false if no scan is in progress
"duration" : n, (numeric) elapsed seconds since scan start
"progress" : n (numeric) scanning progress percentage [0.0, 1.0]
},
"private_keys_enabled" : true|false (boolean) false if privatekeys are disabled for this wallet (enforced watch-only wallet)
}
Examples
raptoreum-cli getwalletinfo
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "getwalletinfo", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
importaddress
Adds an address or script (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | label |
string | Optional | "" | See CLI help for details |
| 3 | rescan |
boolean | Optional | true | See CLI help for details |
| 4 | p2sh |
boolean | Optional | false | See CLI help for details |
Result
null (json null)
Examples
Import an address with rescan
raptoreum-cli importaddress "myaddress"
Import using a label without rescan
raptoreum-cli importaddress "myaddress" "testing" false
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importaddress", "params": ["myaddress", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
importselectrumwallet
Arguments
No arguments.
importmulti
Import addresses/scripts (with private or public keys, redeem script (P2SH)), rescanning all addresses in one-shot-only (rescan can be disabled via options). Requires a new wallet backup.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
[ (json array) Response is an array with the same size as the input that has the execution result
{ (json object)
"success" : true|false, (boolean)
"warnings" : [ (json array, optional)
"str", (string)
...
],
"error" : { (json object, optional)
... JSONRPC error
}
},
...
]
Examples
raptoreum-cli importmulti '[{ "scriptPubKey": { "address": "<my address>" }, "timestamp":1455191478 }, { "scriptPubKey": { "address": "<my 2nd address>" }, "label": "example 2", "timestamp": 1455191480 }]'
raptoreum-cli importmulti '[{ "scriptPubKey": { "address": "<my address>" }, "timestamp":1455191478 }]' '{ "rescan": false}'
importprivkey
Adds a private key (as returned by dumpprivkey) to your wallet. Requires a new wallet backup.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | label |
string | Optional | current label if address exists, otherwise "" | See CLI help for details |
| 3 | rescan |
boolean | Optional | true | See CLI help for details |
Result
null (json null)
Examples
Dump a private key
raptoreum-cli dumpprivkey "myaddress"
Import the private key with rescan
raptoreum-cli importprivkey "mykey"
Import using a label and without rescan
raptoreum-cli importprivkey "mykey" "testing" false
Import using default blank label and without rescan
raptoreum-cli importprivkey "mykey" "" false
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importprivkey", "params": ["mykey", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
importprunedfunds
Imports funds without rescan. Corresponding address or script must previously be included in wallet. Aimed towards pruned wallets. The end-user is responsible to import additional transactions that subsequently spend the imported outputs or rescan after the point in the blockchain the transaction is included.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
importpubkey
Adds a public key (in hex) that can be watched as if it were in your wallet but cannot be used to spend. Requires a new wallet backup.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | label |
string | Optional | "" | See CLI help for details |
| 3 | rescan |
boolean | Optional | true | See CLI help for details |
Result
null (json null)
Examples
Import a public key with rescan
raptoreum-cli importpubkey "mypubkey"
Import using a label without rescan
raptoreum-cli importpubkey "mypubkey" "testing" false
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importpubkey", "params": ["mypubkey", "testing", false] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
importwallet
Imports keys from a wallet dump file (see dumpwallet). Requires a new wallet backup to include imported keys.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
Examples
Dump the wallet
raptoreum-cli dumpwallet "test"
Import the wallet
raptoreum-cli importwallet "test"
Import using the json rpc call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "importwallet", "params": ["test"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
keypoolrefill
Fills the keypool.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | newsize |
numeric | Optional | 1000 | See CLI help for details |
Result
null (json null)
Examples
raptoreum-cli keypoolrefill
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "keypoolrefill", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listaddressbalances
Lists addresses of this wallet and their balances
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | minamount |
numeric | Optional | 0 | See CLI help for details |
Result
[ (json array)
n, (numeric) The raptoreum address and the amount in RTM
...
]
Examples
raptoreum-cli listaddressbalances
raptoreum-cli listaddressbalances 10
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressbalances", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressbalances", "params": [10] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listaddressgroupings
Lists groups of addresses which have had their common ownership
Arguments
No arguments.
Result
[ (json array)
[ (json array)
[ (json array)
"str", (string) The raptoreum address
n, (numeric) The amount in RTM
"str", (string, optional) The label
...
],
...
],
...
]
Examples
raptoreum-cli listaddressgroupings
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listaddressgroupings", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listlabels
Returns the list of all labels, or labels that are assigned to addresses with a specific purpose.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
[ (json array)
"str", (string) Label name
...
]
Examples
List all labels
raptoreum-cli listlabels
List labels that have receiving addresses
raptoreum-cli listlabels receive
List labels that have sending addresses
raptoreum-cli listlabels send
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listlabels", "params": [receive] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listlockunspent
Returns list of temporarily unspendable outputs.
Arguments
No arguments.
Result
[ (json array)
{ (json object)
"txid" : "hex", (string) The transaction id locked
"vout" : n (numeric) The vout value
},
...
]
Examples
List the unspent transactions
raptoreum-cli listunspent
Lock an unspent transaction
raptoreum-cli lockunspent false "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
List the locked transactions
raptoreum-cli listlockunspent
Unlock the transaction again
raptoreum-cli lockunspent true "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listlockunspent", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listreceivedbyaddress
List balances by receiving address.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | minconf |
numeric | Optional | 1 | See CLI help for details |
| 2 | addlocked |
boolean | Optional | false | See CLI help for details |
| 3 | include_empty |
boolean | Optional | false | See CLI help for details |
| 4 | include_watchonly |
boolean | Optional | false) Whether to include watch-only addresses (see 'importaddress' | See CLI help for details |
Result
[ (json array)
{ (json object)
"involvesWatchonly" : true|false, (boolean) Only returns true if imported addresses were involved in transaction
"address" : "str", (string) The receiving address
"amount" : n, (numeric) The total amount in RTM received by the address
"confirmations" : n, (numeric) The number of confirmations of the most recent transaction included.
If 'addlocked' is true, the number of confirmations can be less than
configured for transactions locked via InstantSend
"label" : "str", (string) The label of the receiving address. The default label is ""
"txids" : [ (json array)
"hex", (string) The ids of transactions received with the address
...
]
},
...
]
Examples
raptoreum-cli listreceivedbyaddress
raptoreum-cli listreceivedbyaddress 6 false true
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaddress", "params": [6, false, true, true] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbyaddress", "params": [6, false, true, true, "XbtdLrTsrPDhGy1wXtwKYoBpuKovE3JeBK"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listreceivedbylabel
List received transactions by label.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | minconf |
numeric | Optional | 1 | See CLI help for details |
| 2 | addlocked |
boolean | Optional | false | See CLI help for details |
| 3 | include_empty |
boolean | Optional | false | See CLI help for details |
| 4 | include_watchonly |
boolean | Optional | false) Whether to include watch-only addresses (see 'importaddress' | See CLI help for details |
Result
[ (json array)
{ (json object)
"involvesWatchonly" : true|false, (boolean) Only returns true if imported addresses were involved in transaction
"amount" : n, (numeric) The total amount received by addresses with this label
"confirmations" : n, (numeric) The number of confirmations of the most recent transaction included
"label" : "str" (string) The label of the receiving address. The default label is ""
},
...
]
Examples
raptoreum-cli listreceivedbylabel
raptoreum-cli listreceivedbylabel 6 true
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listreceivedbylabel", "params": [6, true, true] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listsinceblock
Get all transactions in blocks since block [blockhash], or all transactions if omitted.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | target_confirmations |
numeric | Optional | 1 | See CLI help for details |
| 3 | include_watchonly |
boolean | Optional | false) Include transactions to watch-only addresses (see 'importaddress' | See CLI help for details |
| 4 | include_removed |
boolean | Optional | true | See CLI help for details |
Result
{ (json object)
"transactions" : [ (json array)
{ (json object)
"involvesWatchonly" : true|false, (boolean) Only returns true if imported addresses were involved in transaction
"address" : "str", (string) The raptoreum address of the transaction. Not present for move transactions (category = move).
"category" : "str", (string) The transaction category. 'send' has negative amounts, 'receive' has positive amounts.
"amount" : n, (numeric) The amount in RTM. This is negative for the 'send' category, and for the 'move' category for moves
outbound. It is positive for the 'receive' category, and for the 'move' category for inbound funds.
"vout" : n, (numeric) the vout value
"fee" : n, (numeric) The amount of the fee in RTM. This is negative and only available for the 'send' category of transactions.
"confirmations" : n, (numeric) The number of blockchain confirmations for the transaction. Available for 'send' and
'receive' category of transactions. Negative confirmations indicate the
transaction conflicts with the block chain
"instantlock" : true|false, (boolean) Current transaction lock state. Available for 'send' and 'receive' category of transactions
"instantlock-internal" : true|false, (boolean) Current internal transaction lock state. Available for 'send' and 'receive' category of transactions
"chainlock" : true|false, (boolean) The state of the corresponding block chainlock
"trusted" : true|false, (boolean) Whether we consider the outputs of this unconfirmed transaction safe to spend.
"blockhash" : "hex", (string) The block hash containing the transaction. Available for 'send' and 'receive'
category of transactions.
"blockindex" : n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive'
category of transactions.
"blocktime" : xxx, (numeric) The block time expressed in UNIX epoch time.
"txid" : "hex", (string) The transaction id. Available for 'send' and 'receive' category of transactions.
"time" : xxx, (numeric) The transaction time expressed in UNIX epoch time.
"timereceived" : xxx, (numeric) The time received expressed in UNIX epoch time. Available
for 'send' and 'receive' category of transactions.
"comment" : "str", (string) If a comment is associated with the transaction.
"abandoned" : true|false, (boolean) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the 'send' category of transactions.
"comment" : "str", (string) If a comment is associated with the transaction.
"label" : "str", (string) A comment for the address/transaction, if any.
"to" : "str" (string) If a comment to is associated with the transaction.
},
...
],
"removed" : [ (json array) <structure is the same as "transactions" above, only present if include_removed=true>
Note: transactions that were re-added in the active chain will appear as-is in this array, and may thus have a positive confirmation count.
...
],
"lastblockhash" : "hex" (string) The hash of the block (target_confirmations-1) from the best block on the main chain. This is typically used to feed back into listsinceblock the next time you call it. So you would generally use a target_confirmations of say 6, so you will be continually re-notified of transactions until they've reached 6 confirmations plus any new ones.
}
Examples
raptoreum-cli listsinceblock
raptoreum-cli listsinceblock "000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad" 6
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listsinceblock", "params": ["000000000000000bacf66f7497b7dc45ef753ee9a7d38571037cdb1a57f663ad", 6] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listtransactions
If a label name is provided, this will return only incoming transactions paying to addresses with the specified label.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | count |
numeric | Optional | 10 | See CLI help for details |
| 3 | skip |
numeric | Optional | 0 | See CLI help for details |
| 4 | include_watchonly |
boolean | Optional | false) Include transactions to watch-only addresses (see 'importaddress' | See CLI help for details |
Result
[ (json array)
{ (json object)
"involvesWatchonly" : true|false, (boolean) Only returns true if imported addresses were involved in transaction
"address" : "str", (string) The raptoreum address of the transaction. Not present for
move transactions (category = move).
"category" : "str", (string) The transaction category.
"send" Transactions sent.
"coinjoin" Transactions sent using CoinJoin funds.
"receive" Non-coinbase transactions received.
"generate" Coinbase transactions received with more than 100 confirmations.
"immature" Coinbase transactions received with 100 or fewer confirmations.
"orphan" Orphaned coinbase transactions received.
"amount" : n, (numeric) The amount in RTM. This is negative for the 'send' category, and is positive
for all other categories
"label" : "str", (string) A comment for the address/transaction, if any
"vout" : n, (numeric) the vout value
"fee" : n, (numeric) The amount of the fee in RTM. This is negative and only available for the
'send' category of transactions.
"confirmations" : n, (numeric) The number of blockchain confirmations for the transaction. Available for 'send' and
'receive' category of transactions. Negative confirmations indicate the
transaction conflicts with the block chain
"instantlock" : true|false, (boolean) Current transaction lock state. Available for 'send' and 'receive' category of transactions
"instantlock-internal" : true|false, (boolean) Current internal transaction lock state. Available for 'send' and 'receive' category of transactions
"chainlock" : true|false, (boolean) The state of the corresponding block chainlock
"trusted" : true|false, (boolean) Whether we consider the outputs of this unconfirmed transaction safe to spend.
"blockhash" : "hex", (string) The block hash containing the transaction. Available for 'send' and 'receive'
category of transactions.
"blockindex" : n, (numeric) The index of the transaction in the block that includes it. Available for 'send' and 'receive'
category of transactions.
"blocktime" : xxx, (numeric) The block time expressed in UNIX epoch time.
"txid" : "hex", (string) The transaction id. Available for 'send' and 'receive' category of transactions.
"time" : xxx, (numeric) The transaction time expressed in UNIX epoch time.
"timereceived" : xxx, (numeric) The time received expressed in UNIX epoch time. Available
for 'send' and 'receive' category of transactions.
"comment" : "str", (string) If a comment is associated with the transaction.
"abandoned" : true|false (boolean) 'true' if the transaction has been abandoned (inputs are respendable). Only available for the
'send' category of transactions.
},
...
]
Examples
List the most recent 10 transactions in the systems
raptoreum-cli listtransactions
List transactions 100 to 120
raptoreum-cli listtransactions "" 20 100
As a json rpc call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listtransactions", "params": ["", 20, 100] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listunspent
Returns array of unspent transaction outputs
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | minconf |
numeric | Optional | 1 | See CLI help for details |
| 2 | maxconf |
numeric | Optional | 9999999 | See CLI help for details |
| 3 | addresses |
json array | Optional | empty array | See CLI help for details |
| 4 | include_unsafe |
boolean | Optional | true | See CLI help for details |
Result
[ (json array)
{ (json object)
"txid" : "hex", (string) the transaction id
"vout" : n, (numeric) the vout value
"address" : "str", (string) the raptoreum address
"label" : "str", (string) The associated label, or "" for the default label
"scriptPubKey" : "str", (string) the script key
"amount" : n, (numeric) the transaction output amount in RTM
"confirmations" : n, (numeric) The number of confirmations
"redeemScript" : "hex", (string) The redeemScript if scriptPubKey is P2SH
"spendable" : true|false, (boolean) Whether we have the private keys to spend this output
"solvable" : true|false, (boolean) Whether we know how to spend this output, ignoring the lack of keys
"desc" : "str", (string) (only when solvable) A descriptor for spending this output
"safe" : true|false, (boolean) Whether this output is considered safe to spend. Unconfirmed transactions from outside keys and unconfirmed replacement transactions are considered unsafe
and are not eligible for spending by fundrawtransaction and sendtoaddress.
"coinjoin_rounds" : n (numeric) The number of CoinJoin rounds
},
...
]
Examples
raptoreum-cli listunspent
raptoreum-cli listunspent 6 9999999 "[\"XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg\",\"XuQQkwA4FYkq2XERzMY2CiAZhJTEDAbtcg\"]"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999 "[\"XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwg\",\"XuQQkwA4FYkq2XERzMY2CiAZhJTEDAbtcg\"]"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
raptoreum-cli listunspent 6 9999999 '[]' true '{ "minimumAmount": 0.005 }'
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listunspent", "params": [6, 9999999, [] , true, { "minimumAmount": 0.005 } ] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listwalletdir
{ (json object)
Arguments
No arguments.
Result
{ (json object)
"wallets" : [ (json array)
{ (json object)
"name" : "str" (string) The wallet name
},
...
]
}
Examples
raptoreum-cli listwalletdir
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listwalletdir", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
listwallets
For full information on the wallet, use "getwalletinfo"
Arguments
No arguments.
Result
[ (json array)
"str", (string) the wallet name
...
]
Examples
raptoreum-cli listwallets
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "listwallets", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
loadwallet
Loads a wallet from a wallet file or directory.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
{ (json object)
"name" : "str", (string) The wallet name if loaded successfully.
"warning" : "str" (string) Warning message if wallet was not loaded cleanly.
}
Examples
raptoreum-cli loadwallet "test.dat"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "loadwallet", "params": ["test.dat"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
lockunspent
Updates list of temporarily unspendable outputs.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 2 | transactions |
json array | Optional | empty array) A json array of objects. Each object the txid (string) vout (numeric | See CLI help for details |
Result
true|false (boolean) Whether the command was successful or not
Examples
List the unspent transactions
raptoreum-cli listunspent
Lock an unspent transaction
raptoreum-cli lockunspent false "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
List the locked transactions
raptoreum-cli listlockunspent
Unlock the transaction again
raptoreum-cli lockunspent true "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "lockunspent", "params": [false, "[{\"txid\":\"a08e6907dbbd3d809776dbfc5d82e371b764ed838b5655e72f463568df1aadf0\",\"vout\":1}]"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
removeprunedfunds
Deletes the specified transaction from the wallet. Meant for use with pruned wallets and as a companion to importprunedfunds. This will affect wallet balances.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
Examples
raptoreum-cli removeprunedfunds "a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5"
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "removeprunedfunds", "params": ["a8d0c0184dde994a09ec054286f1ce581bebf46446a512166eae7628734ea0a5"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
rescanblockchain
Rescan the local blockchain for wallet related transactions.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | start_height |
numeric | Optional | 0 | See CLI help for details |
Result
{ (json object)
"start_height" : n, (numeric) The block height where the rescan started (the requested height or 0)
"stop_height" : n (numeric) The height of the last rescanned block. May be null in rare cases if there was a reorg and the call didn't scan any blocks because they were already scanned in the background.
}
Examples
raptoreum-cli rescanblockchain 100000 120000
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "rescanblockchain", "params": [100000, 120000] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
sendmany
Send multiple times. Amounts are double-precision floating point numbers.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 3 | minconf |
numeric | Optional | 1 | See CLI help for details |
| 4 | addlocked |
boolean | Optional | false | See CLI help for details |
| 7 | use_is |
boolean | Optional | false | See CLI help for details |
| 8 | use_cj |
boolean | Optional | false | See CLI help for details |
| 9 | conf_target |
numeric | Optional | fallback to wallet's default) Confirmation target (in blocks | See CLI help for details |
| 10 | estimate_mode |
string | Optional | UNSET | See CLI help for details |
Result
"hex" (string) The transaction id for the send. Only 1 transaction is created regardless of
the number of addresses.
Examples
Send two amounts to two different addresses:
raptoreum-cli sendmany "" "{\"XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG\":0.01,\"XuQQkwA4FYkq2XERzMY2CiAZhJTEDAbtcG\":0.02}"
Send two amounts to two different addresses setting the confirmation and comment:
raptoreum-cli sendmany "" "{\"XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG\":0.01,\"XuQQkwA4FYkq2XERzMY2CiAZhJTEDAbtcG\":0.02}" 6 false "testing"
As a json rpc call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendmany", "params": ["", "{\"XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG\":0.01,\"XuQQkwA4FYkq2XERzMY2CiAZhJTEDAbtcG\":0.02}", 6, false, "testing"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
sendtoaddress
Send an amount to a given address.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 6 | subtractfeefromamount |
boolean | Optional | false | See CLI help for details |
| 7 | use_is |
boolean | Optional | false | See CLI help for details |
| 8 | use_cj |
boolean | Optional | false | See CLI help for details |
| 9 | conf_target |
numeric | Optional | fallback to wallet's default) Confirmation target (in blocks | See CLI help for details |
| 10 | estimate_mode |
string | Optional | UNSET | See CLI help for details |
Result
"hex" (string) The transaction id.
Examples
raptoreum-cli sendtoaddress "RwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 0.1
raptoreum-cli sendtoaddress "RwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 0.1 '{"future_maturity":100, "future_locktime":10000}'
raptoreum-cli sendtoaddress "RwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 0.1 [] "donation" "seans outpost"
raptoreum-cli sendtoaddress "RwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 0.1 [] "" "" true
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "sendtoaddress", "params": ["RwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG", 0.1, [], "donation", "seans outpost"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
setcoinjoinamount
Set the goal amount in RTM for CoinJoin.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Examples
raptoreum-cli setcoinjoinamount 500
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setcoinjoinamount", "params": [208] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
setcoinjoinrounds
Set the number of rounds for CoinJoin.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Examples
raptoreum-cli setcoinjoinrounds 4
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setcoinjoinrounds", "params": [16] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
setlabel
Sets the label associated with the given address.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
Examples
raptoreum-cli setlabel "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" "tabby"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "setlabel", "params": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG", "tabby"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
settxfee
Set the transaction fee per kB for this wallet. Overrides the global -paytxfee command line parameter.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
true|false (boolean) Returns true if successful
Examples
raptoreum-cli settxfee 0.00001
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "settxfee", "params": [0.00001] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
signmessage
Sign a message with the private key of an address
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
"str" (string) The signature of the message encoded in base 64
Examples
Unlock the wallet for 30 seconds
raptoreum-cli walletpassphrase "mypassphrase" 30
Create the signature
raptoreum-cli signmessage "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" "my message"
Verify the signature
raptoreum-cli verifymessage "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" "signature" "my message"
As json rpc
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signmessage", "params": ["XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG", "my message"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
signrawtransactionwithwallet
Sign inputs for raw transaction (serialized, hex-encoded).
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 3 | sighashtype |
string | Optional | ALL | See CLI help for details |
Result
{ (json object)
"hex" : "hex", (string) The hex-encoded raw transaction with signature(s)
"complete" : true|false, (boolean) If the transaction has a complete set of signatures
"errors" : [ (json array) Script verification errors (if there are any)
{ (json object)
"txid" : "hex", (string) The hash of the referenced, previous transaction
"vout" : n, (numeric) The index of the output to spent and used as input
"scriptSig" : "hex", (string) The hex-encoded signature script
"sequence" : n, (numeric) Script sequence number
"error" : "str" (string) Verification or signing error related to the input
},
...
]
}
Examples
raptoreum-cli signrawtransactionwithwallet "myhex"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "signrawtransactionwithwallet", "params": ["myhex"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
unloadwallet
Specifying the wallet name on a wallet endpoint is invalid.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | wallet_name |
string | Optional | the wallet name from the RPC request | See CLI help for details |
Result
null (json null)
Examples
raptoreum-cli unloadwallet wallet_name
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "unloadwallet", "params": [wallet_name] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
upgradetohd
Upgrades non-HD wallets to HD.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 1 | mnemonic |
string | Optional | [] | See CLI help for details |
| 2 | mnemonicpassphrase |
string | Optional | [] | See CLI help for details |
| 3 | walletpassphrase |
string | Optional | [] | See CLI help for details |
Result
true|false (boolean) true if successful
Examples
raptoreum-cli upgradetohd
raptoreum-cli upgradetohd "mnemonicword1 ... mnemonicwordN"
raptoreum-cli upgradetohd "mnemonicword1 ... mnemonicwordN" "mnemonicpassphrase"
raptoreum-cli upgradetohd "mnemonicword1 ... mnemonicwordN" "mnemonicpassphrase" "walletpassphrase"
walletlock
Removes the wallet encryption key from memory, locking the wallet.
Arguments
No arguments.
Result
null (json null)
Examples
Set the passphrase for 2 minutes to perform a transaction
raptoreum-cli walletpassphrase "my pass phrase" 120
Perform a send (requires passphrase set)
raptoreum-cli sendtoaddress "XwnLY9Tf7Zsef8gMGL2fhWA9ZmMjt4KPwG" 1.0
Clear the passphrase since we are done before 2 minutes is up
raptoreum-cli walletlock
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "walletlock", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
walletpassphrase
Stores the wallet decryption key in memory for 'timeout' seconds.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 3 | mixingonly |
boolean | Optional | false | See CLI help for details |
Result
null (json null)
Examples
Unlock the wallet for 60 seconds
raptoreum-cli walletpassphrase "my pass phrase" 60
Unlock the wallet for 60 seconds but allow CoinJoin only
raptoreum-cli walletpassphrase "my pass phrase" 60 true
Lock the wallet again (before 60 seconds)
raptoreum-cli walletlock
As a JSON-RPC call
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "walletpassphrase", "params": ["my pass phrase", 60] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/
walletpassphrasechange
Changes the wallet passphrase from 'oldpassphrase' to 'newpassphrase'.
Arguments
| Position | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
Result
null (json null)
Examples
raptoreum-cli walletpassphrasechange "old one" "new one"
curl --user myusername --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "walletpassphrasechange", "params": ["old one", "new one"] }' -H 'content-type: text/plain;' http://127.0.0.1:10225/