Gets the stored height of the blockchain.
Gets the stored height of the blockchain.
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | number | Block height |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "block_height"
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": 318492
}
Get a block by height or hash.
Gets a block with it's transaction hashes given a block height or block hash.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params?.height | number | Block height to fetch | |
| params?.hash | number | Block hash to fetch |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Block details | |
| result.hash | string | Hash of block | |
| result.height | number | Height of block | |
| result.prev_hash | string | Hash of previous block | |
| result.time | number | Time of block in seconds from epoch | |
| result.transactions | array | Block transaction descriptions | |
| result.transactions[] | object | Transaction hash | |
| result.transactions[]?.hash | string | Transaction hash | |
| result.transactions[]?.type | string | Transaction type |
| Code | Message | Description |
|---|---|---|
| -100 | Block not found | |
| -150 | Failed to get block | |
| -3602 | Invalid parameter |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "block_get",
"params": {
"height": 318492
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"hash": "vX_PzD2DvIQZPlpM_LiDCCewpWuZkwcdAhjnJXeg5Gk",
"height": 318492,
"prev_hash": "OLv5ah-94zg3ySJK5x50-W6Kw4gd510ikhpbByq37ZU",
"time": 1588558709,
"transactions": [
{
"hash": "UOVRPuEO2IE8y9fxiuO9JBcBLrqP0Hbh7cUqt-n_8QE",
"type": "poc_request_v1"
},
{
"hash": "67NdSWYjdE8LaR0DE_NNWqMr4XVK8hwrFJ616c9BPmE",
"type": "poc_request_v1"
},
{
"hash": "KfHpj8ytLV6bqNaMS8wbWXeqXkHxjS-G_U_AAUrFvSQ",
"type": "poc_request_v1"
},
{
"hash": "r4mgtbBnrY0v6_m01-akrUtZ7KSsLIF4XTJBIUWiaZs",
"type": "poc_request_v1"
},
{
"hash": "KMFPXYw9QYdW3mtciOuitcWm1qVknm5IDluckN7IcaY",
"type": "poc_request_v1"
},
{
"hash": "1cpS1AnemprqCmm8SHq9_S-eiCE6zjzf2QsOIaV4GgI",
"type": "poc_request_v1"
},
{
"hash": "1Rh4iR3eBQIIywqSQ0TCO04tdl2Dl7dW4qWng5q65Es",
"type": "poc_request_v1"
}
]
}
}
Get account details.
Get account details for a given account address.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the account to fetch |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Account | |
| result.address | string | Address of the account | |
| result.balance | number | HNT balance of the account in bones | |
| result.mobile_balance | number | MOBILE balance of the account in bones | |
| result.iot_balance | number | IOT balance of the account in bones | |
| result.nonce | number | The current nonce for the account | |
| result.speculative_nonce | number | The larger of the maximum pending balance nonce or the current nonce | |
| result.dc_balance | number | Data credit balance of the account | |
| result.dc_nonce | number | The current data credit nonce for the account | |
| result.sec_balance | number | Security token balance of the account | |
| result?.sec_nonce | number | The current security token nonce for the account (deprecated). | |
| result?.sec_speculative_nonce | number | The larger of the maximum pending security nonce or the current security token nonce for the account (deprecated) | |
| result.staked_balance | number | Staked HNT balance of the account | |
| result.cooldown_balance | number | Staked HNT balance of the account currently in cooldown |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "account_get",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"address": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5",
"balance": 1000,
"mobile_balance": 1000,
"iot_balance": 1000,
"nonce": 3,
"speculative_nonce": 12,
"dc_balance": 0,
"dc_nonce": 0,
"sec_balance": 0,
"sec_nonce": 0,
"sec_speculative_nonce": 0,
"staked_balance": 0,
"cooldown_balance": 0
}
}
Get transaction details.
Get details for a given transaction hash.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.hash | string | B64 hash of the transaction to fetch |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Transaction details. The exact fields returned depend on the transaction type returned in the result. | |
| result.hash | string | B64 hash of the transaction | |
| result.type | string | The type of the transaction | |
| result?.implicit_burn | object | Implicit burn details | |
| result?.implicit_burn.fee | number | Amount of HNT (in bones) burned for the fee of the corresponding transaction | |
| result?.implicit_burn.payer | string | Address of the account that paid the fee |
| Code | Message | Description |
|---|---|---|
| -100 | Transaction not found | |
| -150 | Failed to get transaction |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "transaction_get",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"implicit_burn": {
"fee": 1401125,
"payer": "1b93cMbumsxd2qgahdn7dZ19rzNJ7KxEHsLfT4zQXiS9YnbR39F"
}
}
}
Gets the current oracle price.
Gets the oracle price at the current height of the blockchain.
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Oracle Price | |
| result.price | number | The oracle price at the indicated height | |
| result.height | number | The block height of the oracle price |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "oracle_price_current"
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"price": 131069500,
"height": 633936
}
}
Gets an oracle price at a height.
Gets the oracle price at the given height of the blockchain (if known).
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.height | number | Block height to get the oracle price for. |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Oracle Price | |
| result.price | number | The oracle price at the indicated height | |
| result.height | number | The block height of the oracle price |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "oracle_price_get",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"price": 131069500,
"height": 633936
}
}
Get a pending transaction.
Get the previously submitted transaction with status.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.hash | string | B64 hash of the pending transaction to fetch |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Pending transaction details. The exact fields returned depend on the transaction type returned in the result. The transaction will be absent if status is cleared or failed | |
| result?.txn | object | Transaction details. The exact fields returned depend on the transaction type returned in the result. | |
| result?.txn.hash | string | B64 hash of the transaction | |
| result?.txn.type | string | The type of the transaction | |
| result?.txn?.implicit_burn | object | Implicit burn details | |
| result?.txn?.implicit_burn.fee | number | Amount of HNT (in bones) burned for the fee of the corresponding transaction | |
| result?.txn?.implicit_burn.payer | string | Address of the account that paid the fee | |
| result.status | string | One of pending, cleared or failed | |
| result?.failed_reason | string | Present during failed status |
| Code | Message | Description |
|---|---|---|
| -100 | Pending transaction not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "pending_transaction_get",
"params": {
"hash": "xG-KdomBEdp4gTiJO1Riif92DoMd5hPxadcSci05pIs"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"txn": {
"implicit_burn": {
"fee": 1401125,
"payer": "1b93cMbumsxd2qgahdn7dZ19rzNJ7KxEHsLfT4zQXiS9YnbR39F"
}
}
}
}
Get pending transaction status.
Get the status a previously submitted transaction.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.hash | string | B64 hash of the pending transaction to fetch |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | string | One of 'pending', 'cleared', 'not_found' or a failure reason |
| Code | Message | Description |
|---|---|---|
| -100 | Pending transaction not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "pending_transaction_status",
"params": {
"hash": "xG-KdomBEdp4gTiJO1Riif92DoMd5hPxadcSci05pIs"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": "cleared"
}
Submit a transaction to the pending queue.
Submits a pending transaction to the pending queue. The transactions needs to be in a blockchain_txn envelope and base64 encoded
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.txn | string | B64 encoded transaction |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Transaction details. The exact fields returned depend on the transaction type returned in the result. | |
| result.hash | string | B64 hash of the transaction | |
| result.type | string | The type of the transaction | |
| result?.implicit_burn | object | Implicit burn details | |
| result?.implicit_burn.fee | number | Amount of HNT (in bones) burned for the fee of the corresponding transaction | |
| result?.implicit_burn.payer | string | Address of the account that paid the fee |
| Code | Message | Description |
|---|---|---|
| -3602 | Invalid parameter |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "pending_transaction_submit",
"params": {
"txn": "QoWBCIe..."
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"implicit_burn": {
"fee": 1401125,
"payer": "1b93cMbumsxd2qgahdn7dZ19rzNJ7KxEHsLfT4zQXiS9YnbR39F"
}
}
}
Verify a transaction prior to submitting to the pending queue.
Verifies a transaction prior to submitting to the pending queue. The transactions needs to be in a blockchain_txn envelope and base64 encoded. Result returns "valid" if the transaction is valid; otherwise, the error message is present.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.txn | string | B64 encoded transaction |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result |
| Code | Message | Description |
|---|---|---|
| -3602 | Invalid parameter |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "pending_transaction_verify",
"params": {
"txn": "QoWBCIe..."
}
}
{
"jsonrpc": "2.0",
"id": "1234567890"
}
Gets an implicit burn for a transaction hash.
Gets an implicit burn for a transaction hash. Returns amount of HNT burned for a DC fee.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.hash | string | Transaction hash to get implicit burn for. |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Implicit burn details | |
| result.fee | number | Amount of HNT (in bones) burned for the fee of the corresponding transaction | |
| result.payer | string | Address of the account that paid the fee |
| Code | Message | Description |
|---|---|---|
| -100 | Implicit burn not found for transaction |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "implicit_burn_get",
"params": {
"hash": "13BnsQ6rZVHXHxT8tgYX6njGxppkVEEcAxDdHV51Vwikrh8XBP9"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"fee": 1401125,
"payer": "1b93cMbumsxd2qgahdn7dZ19rzNJ7KxEHsLfT4zQXiS9YnbR39F"
}
}
Gets HTLC details for an HTLC address.
Gets HTLC details for an HTLC address. If an HTLC was redeemed, it will also show the redemption height.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | HTLC address |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | HTLC details | |
| result.address | string | B58 address of the HTLC | |
| result.balance | number | Amount of HNT locked | |
| result.hashlock | string | Hash to unlock HTLC | |
| result.payee | string | Address of the payee | |
| result.payer | string | Address of the payer | |
| result?.redeemed_at | number | Block height at which HTLC was redeemed | |
| result.timelock | number | Number of blocks HTLC is locked for until payer can reclaim |
| Code | Message | Description |
|---|---|---|
| -100 | HTLC not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "htlc_get",
"params": {
"address": "13BnsQ6rZVHXHxT8tgYX6njGxppkVEEcAxDdHV51Vwikrh8XBP9"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"address": "13BnsQ6rZVHXHxT8tgYX6njGxppkVEEcAxDdHV51Vwikrh8XBP9",
"balance": 10,
"hashlock": "AQEFmiouhIzFHBeCyW4J3sBKvBD3m2yuktTxUf14cIo",
"payee": "14zemQxLLimdTkHnpBU8f6o3DMmU9QfrreqsR1rYUF4tLveyc62",
"payer": "13udMhCkD4RmVCKKtprt96UAEBMppT55fs1z9viS6Uha8EWSWGe",
"redeemed_at": 930213,
"timelock": 100
}
}
Create a new wallet.
Creates a new wallet, encrypted with the given password. The wallet is locked after creation.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.password | string | Password used to encrypt the wallet |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | string | The B58 encoded public address of the wallet |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_create",
"params": {
"password": "a password"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5"
}
Delets a wallet.
Permanently removes the wallet from the database.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the wallet to delete |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | boolean | Returns true if the wallet was deleted |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_delete",
"params": {
"address": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": true
}
List all wallets.
Lists the public keys of all wallets.
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | array | ||
| result[] | string | The B58 encoded public address of a wallet |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_list"
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": [
"13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5"
]
}
Unlock a wallet for signing.
Unlock a wallet for signing. The wallet will be unlocked for 60 seonds.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the wallet to unlock | |
| params.password | string | Password used to decrypt the wallet |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | boolean | Returns true if the wallet is unlocked |
| Code | Message | Description |
|---|---|---|
| -100 | Wallet not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_unlock",
"params": {
"address": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5",
"password": "a password"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": true
}
Lock a wallet.
Locks a previously unlocked wallet.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the wallet to lock |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | boolean | Returns true regardless of whether the wallet is found or not |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_lock",
"params": {
"address": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": true
}
Checks if a wallet is locked.
Checks if a wallet is unlocked.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the wallet to check |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | boolean | Returns true if the wallet is locked or uknown |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_is_locked",
"params": {
"address": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": true
}
Send a payment to another account.
Sends a single payment in bones to a given account address. Note that 1 HNT it 100_000_000 bones
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the payer wallet | |
| params.payee | string | B58 address of the payee account | |
| params?.bones | integer | Amount in bones to send. Must be specified if "max" = false. | |
| params?.token_type | string | Token type to send. [hnt, mobile, iot, hst. Default: hnt] | |
| params?.max | boolean | If true, send entire wallet balance rather than specific amount. | |
| params?.nonce | integer | Nonce to use for transaction |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Transaction details. The exact fields returned depend on the transaction type returned in the result. | |
| result.hash | string | B64 hash of the transaction | |
| result.type | string | The type of the transaction | |
| result?.implicit_burn | object | Implicit burn details | |
| result?.implicit_burn.fee | number | Amount of HNT (in bones) burned for the fee of the corresponding transaction | |
| result?.implicit_burn.payer | string | Address of the account that paid the fee |
| Code | Message | Description |
|---|---|---|
| -100 | Wallet not found or locked |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_pay",
"params": {
"address": "13Ya3s4k8dsbd1dey6dmiYbwk4Dk1MRFCi3RBQ7nwKnSZqnYoW5",
"payee": "13buBykFQf5VaQtv7mWj2PBY9Lq4i1DeXhg7C4Vbu3ppzqqNkTH",
"bones": 1000,
"token_type": "hnt",
"max": "false",
"nonce": 422
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"implicit_burn": {
"fee": 1401125,
"payer": "1b93cMbumsxd2qgahdn7dZ19rzNJ7KxEHsLfT4zQXiS9YnbR39F"
}
}
}
Send multiple paymens in a single transation.
Sends multiple payments in bones to one or more payees. Note that 1 HNT it 100_000_000 bones
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the payer wallet | |
| params.payments | array | ||
| params.payments[] | object | ||
| params.payments[]?.payee | string | B58 address of the payee account | |
| params.payments[]?.bones | integer | Amount in bones to send. Must be specified if "max" = false | |
| params.payments[]?.token_type | string | Token type to send. [hnt, mobile, iot, hst. Default: hnt] | |
| params.payments[]?.max | boolean | If true, send entire wallet balance rather than specific amount. Only one payment entry per token type can have "max" set to true. |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | Transaction details. The exact fields returned depend on the transaction type returned in the result. | |
| result.hash | string | B64 hash of the transaction | |
| result.type | string | The type of the transaction | |
| result?.implicit_burn | object | Implicit burn details | |
| result?.implicit_burn.fee | number | Amount of HNT (in bones) burned for the fee of the corresponding transaction | |
| result?.implicit_burn.payer | string | Address of the account that paid the fee |
| Code | Message | Description |
|---|---|---|
| -100 | Wallet not found or locked |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_pay_multi",
"params": {
"payments": [
{
"token_type": "hnt",
"max": "false"
}
]
}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"implicit_burn": {
"fee": 1401125,
"payer": "1b93cMbumsxd2qgahdn7dZ19rzNJ7KxEHsLfT4zQXiS9YnbR39F"
}
}
}
Import an encrypted wallet.
Import an encrypted wallet into the wallet database. The password is only used to verify that the wallet can be unlocked and is not stored.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.password | string | Password used to decrypt the wallet | |
| params.path | string | Path to the file to import the wallet from |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | string | The public key of the wallet |
| Code | Message | Description |
|---|---|---|
| -100 | Wallet file not found | |
| -110 | Invalid password for wallet |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_import",
"params": {
"password": "a password"
}
}
{
"jsonrpc": "2.0",
"id": "1234567890"
}
Export an encrypted wallet to a given path.
Exports an encrypted wallet to the given path.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the payer wallet | |
| params.path | string | Path to the file to save the wallet to |
| Code | Message | Description |
|---|---|---|
| -100 | Wallet not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_export",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890"
}
Export the secret key bytes for a wallet to a given path.
Exports the secret keybytes of a given unlocked wallet to the given path.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.address | string | B58 address of the wallet | |
| params.path | string | Path to the file to save the export to |
| Code | Message | Description |
|---|---|---|
| -100 | Wallet not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_export_secret",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890"
}
Lists information on the list of backups in the given path.
Backup list information includes the backup ID, size, and the time the backup was created.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.path | string | Path to the backup folder |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | array | ||
| result[] | object | ||
| result[].backup_id | integer | ID of the backup | |
| result[].number_files | integer | Number of files in the backup | |
| result[].size | integer | Size of backup, in bytes | |
| result[].timestamp | integer | Timestamp (seconds since epoch) of backup |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_backup_list",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": [
{
"backup_id": 2,
"number_files": 3
}
]
}
Creates a backup of the wallet database.
Creates a backup of the backup database in the given path.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.path | string | Path to the backup folder | |
| params.max_backups | integer | Maximum number of backups to maintain in the folder |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | object | ||
| result.backup_id | integer | ID of the backup | |
| result.number_files | integer | Number of files in the backup | |
| result.size | integer | Size of backup, in bytes | |
| result.timestamp | integer | Timestamp (seconds since epoch) of backup |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_backup_create",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890",
"result": {
"backup_id": 2,
"number_files": 3
}
}
Delete a backup.
Delete the backup with the given ID from the given backup path.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.path | string | Path to the backup folder | |
| params.backup_id | integer | Backup ID to delete |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | boolean | True if the backup was deleted succesfully |
| Code | Message | Description |
|---|---|---|
| -100 | Backup not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_backup_delete",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890"
}
Restore the wallet database.
Restores the wallet database from the backup ID in the given backup folder.
| Name | Type | Constraints | Description |
|---|---|---|---|
| params | object | ||
| params.path | string | Path to the backup folder | |
| params.backup_id | integer | Backup ID to restore from |
| Name | Type | Constraints | Description |
|---|---|---|---|
| result | boolean | True if the backup was restored succesfully |
| Code | Message | Description |
|---|---|---|
| -100 | Backup not found |
{
"jsonrpc": "2.0",
"id": "1234567890",
"method": "wallet_backup_restore",
"params": {}
}
{
"jsonrpc": "2.0",
"id": "1234567890"
}