Wasabi Remote Procedure Call Interface

Wasabi Wallet provides an RPC interface to interact with the wallet programmatically. The RPC server is listening by default on port 37128.

Limitations

The RPC server does NOT support batch requests or TLS communications (because it is not supported on Linux and on Macopen in new window). Requests are served in order one-by-one in series (no parallel processing). It is intentionally limited to serve only one whitelisted local address and it is disabled by default.

The more user friendly command line interface wcli can be found hereopen in new window.

Configure RPC

The RPC server has to be configured and enabled. This is done in the Config.json file and the relevant settings are:

JsonRpcServerEnabled: [true | false] (default: false)
JsonRpcServerPrefixes: [an array of string with prefixes]
	(default: [	"http://127.0.0.1:37128/", "http://localhost:37128/"])

The RPC server can be configured to allow Anonymous access or Basic authentication just by editing:

JsonRpcUser: [username] (default: empty)
JsonRpcPassword: [userpassword] (default: empty)

By default both JsonRpcUser and JsonRpcPassword are empty "", which means that Anonymous requests are allowed. On the other hand, if JsonRpcUser and JsonRpcPassword are not empty it means that the requester has to provide the right credentials, otherwise he will get a http status code 401 (Unauthorized).

It is recommended to install the jq command line json processoropen in new window with sudo apt-get install jq, and then adding | jq at the end of every RPC command to have a structured output.

Then start Wasabi Wallet and load the wallet you want to use. Open a new terminal and use the following RPC commands to interact with your wallet, instead of the GUI.

For Windows Users

Using a Windows command prompt to execute any method, one must use double quotation marks " to surround the JSON data structure, and escape each double quotation mark that is inside the JSON structure by using a backslash \ before each double quotation mark. Example:

curl -s --data-binary "{ \"jsonrpc\":\"2.0\",\"id\":\"1\",\"method\":\"getwalletinfo\" }" http://127.0.0.1:37128/WalletName | jq

Another option is to install Gitopen in new window and to use Git Bash.
To install jq check this video tutorialopen in new window.

Available methods

The current version handles the following methods: getstatus, createwallet, recoverwallet, listwallets, loadwallet, listcoins, listunspentcoins, getwalletinfo, getnewaddress, send, build, broadcast, speeduptransaction, canceltransaction, gethistory, getfeerates, listkeys, excludefromcoinjoin, startcoinjoin, payincoinjoin, listpaymentsincoinjoin, cancelpaymentincoinjoin, startcoinjoinsweep, stopcoinjoin, buildunsafetransaction, and stop.

For certain methods, the RPC call may not require the passphrase whereas a similar action in the GUI does require it. This difference is because the RPC call can use the clear text wallet file, which does not require the passphrase to access. For example, the GUI requires a passphrase to open a wallet (and access certain wallet information), because it uses different logic, such as start coinjoining immediately.

For wallet-specific calls, the wallet name should be specified in the URL path. Example:

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"getwalletinfo"}' http://127.0.0.1:37128/WalletName | jq

The methods can be used as follows:

getstatus

Returns information useful to understand Wasabi and its synchronization status.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"getstatus"}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "result": {
    "torStatus": "Running",
    "onionService": "Unavailable",
    "backendStatus": "Connected",
    "bestBlockchainHeight": "1517613",
    "bestBlockchainHash": "0000000000000064db138798b6b789910bc7f29546a1ff506734dc7bb5780b28",
    "filtersCount": 689039,
    "filtersLeft": 0,
    "network": "TestNet",
    "exchangeRate": 7822.24,
    "peers": [
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:20.0452963+00:00",
        "endpoint": "[::ffff:178.128.20.150]:18333",
        "userAgent": "/Satoshi:0.17.1(bitcore)/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:40.5267439+00:00",
        "endpoint": "[::ffff:142.93.231.134]:18333",
        "userAgent": "/Satoshi:0.17.0/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:35.6408702+00:00",
        "endpoint": "[::ffff:47.74.4.44]:18884",
        "userAgent": "/Satoshi:0.13.2/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:44.371711+00:00",
        "endpoint": "[fd87:d87e:eb43:7081:2a4e:edaa:f8bb:10d0]:18333",
        "userAgent": "/Satoshi:0.16.2/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:05.6071169+00:00",
        "endpoint": "[::ffff:153.126.145.243]:18333",
        "userAgent": "/Satoshi:0.15.1/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:35.3028356+00:00",
        "endpoint": "[::ffff:46.4.171.125]:18333",
        "userAgent": "/Satoshi:0.16.0/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:36.1277937+00:00",
        "endpoint": "[::ffff:52.213.124.148]:18333",
        "userAgent": "/Satoshi:0.17.1/"
      },
      {
        "isConnected": true,
        "lastSeen": "2019-05-20T19:35:35.6409197+00:00",
        "endpoint": "[::ffff:35.241.203.98]:18333",
        "userAgent": "/Satoshi:0.15.2/"
      }
    ]
  },
  "id": "1"
}

createwallet

Returns the twelve recovery words of the freshly generated wallet.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"createwallet","params":["WalletName", "UserPassphrase"]}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "result": "jazz garment survey smart cricket child pizza reform physical alien envelope lesson",
  "id": "1"
}

In case we try to generate a wallet with an already existing name it will return:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "Wallet name is already taken."
  },
  "id": "1"
}

In case we try to generate a wallet with a reserved wallet name it will return:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "Invalid wallet name."
  },
  "id": "1"
}

In case we try to generate a wallet with a too long passphrase it will return:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "Passphrase is too long."
  },
  "id": "1"
}

recoverwallet

Recovers a wallet using a BIP 39 mnemonic (recovery words).

curl -s --data-binary '{"jsonrpc":"2.0", "id":"1", "method":"recoverwallet", "params":["WalletName", "jazz garment survey smart cricket child pizza reform physical alien envelope lesson", "UserPassphrase"]}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "id": "1"
}

The first parameter is the (new) wallet name, the second parameter is the mnemonic (recovery words), the third parameter is an optional passphrase.

listwallets

Lists the wallets.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listwallets"}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "result": [
    {
      "walletName": "WalletName1"
    },
    {
      "walletName": "WalletName2"
    }
  ],
  "id": "1"
}

loadwallet

Loads a wallet.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"loadwallet","params":["WalletName"]}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "id": "1"
}

listcoins

Returns the list of previously spent and currently unspent coins (confirmed and unconfirmed).

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listcoins"}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": [
    {
      "txid": "88d3e86b215ccbb0136da156fdc75548c3f8e3edd5a5d8aacb2c04d4cbf45987",
      "index": 0,
      "amount": 38478,
      "anonymityScore": 1,
      "confirmed": true,
      "confirmations": 1428,
      "keyPath": "86'/1'/0'/1/0",
      "address": "tb1pf6u35naersjgmzw5szxxkrz47ugl4jdkj2x7n2fcqzmfpzm366wq0dxxv2"
    },
    {
      "txid": "a4f495cbf64f6e1942627954443c8edcf2b14fa6bea53219431c24ccb7f61707",
      "index": 0,
      "amount": 54626,
      "anonymityScore": 1,
      "confirmed": true,
      "confirmations": 29800,
      "keyPath": "84'/1'/0'/0/0",
      "address": "tb1qg7y2xzmy5unyxem8utytwqmh837n30t83jy3z2",
      "spentBy": "95159c33459921cb5cc01364231f36bd6c82c025a057eb150346b37a8b2186cb"
    },
    {
      "txid": "cb4dda1d53e23dd63aba0e7ce6876014a9c8c361026b9835316b338d172802e4",
      "index": 54,
      "amount": 8192,
      "anonymityScore": 1,
      "confirmed": true,
      "confirmations": 2638,
      "keyPath": "84'/1'/0'/1/0",
      "address": "tb1q3qt7a8aw5edjhawmg5964hk6jl7hzmd0wpavme",
      "spentBy": "8094b2d88df19a4cc3b09705935ed63f06736594d65d5cc8e663ac23054ed9a3"
    },
  ],
  "id": "1"
}

In case there is no wallet open it will return:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "There is no wallet loaded."
  },
  "id": "1"
}

listunspentcoins

Returns the list of confirmed and unconfirmed coins that are unspent.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listunspentcoins"}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": [
    {
      "txid": "7958defd85bb4f34dc66b3323eaa2f4fbdbece35f5e1b2d7b49b461ddc2066ec",
      "index": 0,
      "amount": 109859,
      "anonymityScore": 1,
      "confirmed": true,
      "confirmations": 6,
      "label": "kyced-exchange",
      "keyPath": "84'/0'/0'/0/616",
      "address": "tb1qgcng6v7wt03t80x6gh7s2x4rawg9zhenzrek4y",
      "excludedFromCoinjoin": false
    },
    {
      "txid": "06482d847623e096394ecfae58e86e075b7761da493e6eee45a6f2f9c8909582",
      "index": 0,
      "amount": 2994272,
      "anonymityScore": 9,
      "confirmed": true,
      "confirmations": 1,
      "label": "",
      "keyPath": "84'/0'/0'/1/79",
      "address": "tb1qgfcv3pgj6tvzc5g73l7tps58q30zx8qk3y35uu",
      "excludedFromCoinjoin": false
    },
    {
      "txid": "aaddc190fe0c2612559b28f9a4a6f4e78906e1794545badccd2fc318257fe2c4",
      "index": 0,
      "amount": 195218,
      "anonymityScore": 1,
      "confirmed": true,
      "confirmations": 245,
      "label": "Maria, Andrew",
      "keyPath": "84'/0'/0'/0/623",
      "address": "tb1q2dgj9u3ggjg08hvvhf3l4m3u3ncpdxud8m0yqu",
      "excludedFromCoinjoin": false
    }
  ],
  "id": "1"
}

In case there is no wallet open it will return:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "There is no wallet loaded."
  },
  "id": "1"
}

getwalletinfo

Returns information about the current loaded wallet.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"getwalletinfo"}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": {
    "walletName": "WalletName",
    "walletFile": "/home/user/.walletwasabi/client/Wallets/WalletName.json",
    "State": "Started",
    "masterKeyFingerprint": "0b946bac",
    "anonScoreTarget": 5,
    "isWatchOnly": false,
    "isHardwareWallet": false,
    "isAutoCoinjoin": true,
    "isNonPrivateCoinIsolation": false,
    "accounts": [
      {
        "name": "segwit",
        "publicKey": "tpubDCpc4bh9QGicUMskHuXhwxdxDJPEs73f3YbTAoU1EqhJmHjKWpRg8gwrurvpmUDywNLbLQTu2aY9US3W4AV8uyrP2np9gTLtyZrtZ5VuHzr",
        "keyPath": "m/84'/0'/0'"
      },
      {
        "name": "taproot",
        "publicKey": "tpubDCqNm3Xmaju7SZk2vfa8kfDC4iNuwSbRNjVfqkCdg4dHu63fyNpHhUNAtcehRnKVrzU7ZgaFqkmHZGVVgFphYL3B3BBNxqVN7NbD33PcXUv",
        "keyPath": "m/86'/0'/0'"
      }
    ],
    "balance": 0,
    "coinjoinStatus": "Idle"
  },
  "id": "1"
}

In case there is no wallet open it will return:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "There is no wallet loaded."
  },
  "id": "1"
}

getnewaddress

Creates an address and returns detailed information about it.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"getnewaddress","params":["Daniel, Alice", false]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": {
    "address": "tb1qdskc4y529ayqkqrddknnhdjqwnqc9wzl8940pn",
    "keyPath": "84'/1'/0'/0/30",
    "label": ["Alice", "Daniel"],
    "publicKey": "0263ea6712e56277bcb07b14b61c30bae2267ec10e0bbf7a024d2c6a0634d6e634",
    "scriptPubKey": "00146c2d8a928a2f480b006d6da73bb64074c182b85f"
  },
  "id": "1"
}

The first parameter is the label(s), the second parameter is whether to generate a taproot address (the default is false, which returns a SegWit address).

In case an empty label is provided:

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32603,
    "message": "Parameter cannot be empty. (Parameter 'label')"
  },
  "id": "1"
}

send

Builds and broadcasts a transaction.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"send", "params": { "payments":[ {"sendto": "tb1qgvnht40a08gumw32kp05hs8mny954hp2snhxcz", "amount": 15000, "label": "David" }, {"sendto":"tb1qpyhfrpys6skr2mmnc35p3dp7zlv9ew4k0gn7qm", "amount": 86200, "label": "Michael"} ], "coins":[{"transactionid":"ab83d9d0b2a9873b8ab0dc48b618098f3e7fbd807e27a10f789e9bc330ca89f7", "index":0}], "feeTarget":2, "password": "UserPassphrase" }}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc":"2.0",
  "result": {
    "txid":"c493bf3d9e0279968bf677f0b3661f8f67823b6d7524b9c8a278701d0fb357a5",
    "tx":"0100000000010121e11e8682d93ec842eb41f7271e8922b31591cdbb8b54cdda680cf1e0f65e8c0000000000ffffffff0247590000000000001600143cc0c9d8649532ad77fe0ac5032c1c9ad9529109983a00000000000016001497ff0a7a7ab2078d379e21aade978b6c1bdcba480247304402206bdbf36d0be8062e69b22441ed496ce6b5d639663bd4e580d11b71e34d79c6760220375219a8eb695f15a992b502ff4b639ea809547a3b7f0596cf9a69c1ae1d0df60121033e8670324ec33f15dcb17f346c1927ee3b717070596e397eb00020899c9c913300000000"
  }
}

Note that one can set a specific fee rate using the parameter feeRate instead of feeTarget.

The fees for the transaction will be added on top of the sum of the outputs' amounts. If you have three outputs with 0.4, 0.3 and 0.3 BTC, the amount of BTC in the inputs must be at least 0.4+0.3+0.3 + mining fees.

You can add subtractFee: true to one of the request's payments to change this behaviour. Now the mining fee will be subtracted from the output in which subtractFee was set to true so the input amounts summed up can be exactly the output amounts summed up. ( 0.4 - (mining fee) ) + 0.3 + 0.3 With this you can send the max amount of the coin, by setting the same value of the input coins for the output address.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"send", "params": { "payments":[ {"sendto": "tb1qgvnht40a08gumw32kp05hs8mny954hp2snhxcz", "amount": 15000, "label": "David", "subtractFee": true }, {"sendto":"tb1qpyhfrpys6skr2mmnc35p3dp7zlv9ew4k0gn7qm", "amount": 86200, "label": "Michael"} ], "coins":[{"transactionid":"ab83d9d0b2a9873b8ab0dc48b618098f3e7fbd807e27a10f789e9bc330ca89f7", "index":0}], "feeTarget":2, "password": "UserPassphrase" }}' http://127.0.0.1:37128/WalletName | jq

In case of error, it is reported in the json's error object:

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"send", "params": { "payments": [{ "sendto": "tb1qnmfmkylkd548bbbcd9115b322891e27f741eb42c83ed982861ee121", "amount": 2015663, "label": "Mr. Who" }], "coins":[{"transactionid":"c68dacd548bbbcd9115b38ed982861ee121c5ef6e0f1022891e27f741eb42c83", "index":0}], "feeTarget": 2, "password": "UserPassphrase" }}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc":"2.0",
  "error":{
    "code":-32603,
    "message":"Needed: 0.02015663 BTC, got only: 0.001 BTC."
  },
  "id":"1"
}

Note: error codes are generic and not Wasabi specific.

build

Builds a transaction. It is similar to the send method, except that it will not automatically broadcast the transaction. So it is also possible to send to many and to subtract the fee.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"build", "params": { "payments":[ {"sendto": "tb1qgjgy9k7q32rcvdjsp3nhq0x8saqcvyahhy8up2", "amount": 15000, "label": "David" }, ], "coins":[{"transactionid":"cdfda1d9839e71e82ca539a4f60e947b1cdfbeecb198616e1daa5c43e2e6fbb3", "index":0}], "feeTarget":2, "password": "UserPassphrase" }}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": "01000000000101b3fbe6e2435caa1d6e6198b1ecbedf1c7b940ef6a439a52ce8719e83d9a1fdcd0000000000fdffffff02cfc40300000000002251203ad2f2cf18af791235fbc634333e30becbf7a3d566f9b2cbf36960d68d6e95f5983a000000000000160014449042dbc08a878636500c67703cc787418613b70247304402206cf8fd02465b77b189cb752c15e8baf69c5de7a1e1c9b27380227fc21b55ffa7022059533d0046e6a6b58bc6ff4be297d02773651849e6ba40f2dec31a98b9fa7863012103d626df6a18ed29d4c7e80199f7f183bd4949f6c8073463c81f3802b57f9546d000000000",
  "id": "1"
}

The result is the transaction hex, waiting to be broadcast.

Note that one can set a specific fee rate using the parameter feeRate instead of feeTarget.

broadcast

Broadcasts a transaction. Enter the transaction hex in the params field.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"broadcast", "params":["020000000001021cb46e8537e18398c382d0d5622ad9e475245cd789e31fb2de285c802e7b56e50100000000fefffffffe0fa22998e2dd1e4d66b09bf7e253d201f7e0b88098973bfd5e6c5ac426398d0000000000feffffff02c315100000000000160014b60bfb6774881b531d70228fb36a5fd60bd36c6ca07a0300000000001600145d576a81f460e7a1ed254fe9bfff075ab3bc45650247304402206b6d7d282b796920bf1742ca996733866321e5b491cd4a50749b9f62192f635202200f7d5a2105da3361f41810868526545c1b01160e6381ab34c56956df2995bd2c012102549fa9f712caffdf63da7d077e6a26dc3d01ca275312e9f64d1d9accf949d2bc0247304402206afcb357fa31aa5d9d241b1365492b85f058f8029ba348ff7ffd2ee15bb972fe022064818c8ab49ce649a4bb37d645d933c5860b1d5a6916fe267f3fb29e6bafca10012102a80b143904f60ede946ba9a44f29df12b7fb16f6ae3dc93a728d6a00ef658e62ad2d2500"]}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "result": {
    "txid": "7cb3c78e10a4730f157589e348ea12b29d3d638826a31f77baccc82e6047de25"
  },
  "id": "1"
}

speeduptransaction

Speeds up a transaction and returns the hex of a new transaction; ready for broadcast. It first tries to speed it up using RBF, if that is not possible it will do CPFP.

curl -s --data-binary '{"jsonrpc":"2.0", "id":"1", "method":"speeduptransaction", "params":["ab83d9d0b2a9873b8ab0dc48b618098f3e7fbd807e27a10f789e9bc330ca89f7", "UserPassphrase"]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": "01000000000101b3fbe6e2435caa1d6e6198b1ecbedf1c7b940ef6a439a52ce8719e83d9a1fdcd0000000000fdffffff02cfc40300000000002251203ad2f2cf18af791235fbc634333e30becbf7a3d566f9b2cbf36960d68d6e95f5983a000000000000160014449042dbc08a878636500c67703cc787418613b70247304402206cf8fd02465b77b189cb752c15e8baf69c5de7a1e1c9b27380227fc21b55ffa7022059533d0046e6a6b58bc6ff4be297d02773651849e6ba40f2dec31a98b9fa7863012103d626df6a18ed29d4c7e80199f7f183bd4949f6c8073463c81f3802b57f9546d000000000",
  "id": "1"
}

The first parameter is the transaction ID of the transaction to be accelerated, the second parameter is the wallet passphrase.

It does not automatically broadcast the new transaction, so it still needs to be manually broadcasted.

canceltransaction

Cancels a transaction and returns the hex of a new transaction; ready for broadcast. It first tries to use RBF, if that is not possible it will do CPFP. It is similar to the speeduptransaction method, except that the transaction sends the bitcoin back to the wallet (to an unused internal address).

curl -s --data-binary '{"jsonrpc":"2.0", "id":"1", "method":"canceltransaction", "params":["ab83d9d0b2a9873b8ab0dc48b618098f3e7fbd807e27a10f789e9bc330ca89f7", "UserPassphrase"]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": "01000000000101b3fbe6e2435caa1d6e6198b1ecbedf1c7b940ef6a439a52ce8719e83d9a1fdcd0000000000fdffffff02cfc40300000000002251203ad2f2cf18af791235fbc634333e30becbf7a3d566f9b2cbf36960d68d6e95f5983a000000000000160014449042dbc08a878636500c67703cc787418613b70247304402206cf8fd02465b77b189cb752c15e8baf69c5de7a1e1c9b27380227fc21b55ffa7022059533d0046e6a6b58bc6ff4be297d02773651849e6ba40f2dec31a98b9fa7863012103d626df6a18ed29d4c7e80199f7f183bd4949f6c8073463c81f3802b57f9546d000000000",
  "id": "1"
}

The first parameter is the transaction ID of the transaction to be accelerated, the second parameter is the wallet passphrase.

It does not automatically broadcast the new transaction, so it still needs to be manually broadcasted.

gethistory

Returns the list of all transactions sent and received.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"gethistory"}' http:/127.0.0.1:37128/WalletName | jq

  "jsonrpc": "2.0",
  "result": [
    {
      "datetime": "2019-10-01T12:31:57+00:00",
      "height": 597871,
      "amount": -2110090,
      "label": "David",
      "tx": "680d8940145f53cf2a0c24b27ba0bb53fbd639011eba3d23c9d53123ddae5f32"
      "islikelycoinjoin": "false"
    },
    {
      "datetime": "2019-10-04T17:00:15+00:00",
      "height": 597872,
      "amount": -2120000,
      "label": "Pablo",
      "tx": "e5e4486ad2c9fc6f3c262c4c64fa5fbcc607aa301182d45848a6692c5a0d0fc0"
      "islikelycoinjoin": "true"
    },
    {
      "datetime": "2019-09-22T11:59:32+00:00",
      "height": 5965600,
      "amount": 44480000,
      "label": "kyed-exchange",
      "tx": "6a2e99298dbbd201230a99e62ea584d7f63f62ad1de7166f24eb2e24867f6faf"
      "islikelycoinjoin": "false"
    },

getfeerates

Returns current fee rates for certain block confirmation targets.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"getfeerates"}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "result": {
    "2": 50,
    "144": 37,
    "432": 32
  },
  "id": "1"
}

In this case the block targets are 2, 144 and 432 and their corresponding fee rates in sat/vB, according to bitcoind's smart fee algorithm.

listkeys

Returns the list of all the generated keys.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listkeys"}' http://127.0.0.1:37128/WalletName | jq

  "jsonrpc": "2.0",
  "result": [
    {
      "fullKeyPath": "84'/1'/0'/1/0",
      "internal": true,
      "keyState": 2,
      "label": "Adam",
      "scriptPubKey": "0 9d71708d966c8900e40f5563aab93d5394c2cca5",
      "pubkey": "031606b4c6a8651726020af23cbd014c39695171444effd799ba00c41e2b37aad6",
      "pubKeyHash": "9d71708d966c8900e40f5563aab93d5394c2cca5",
      "address": "tb1qn4chprvkdjyspeq024364wfa2w2v9n99ucent4"
    },
    {
      "fullKeyPath": "84'/1'/0'/0/0",
      "internal": false,
      "keyState": 0,
      "label": "Valeria",
      "scriptPubKey": "0 952bae5f20dc6d0ca8a5b92b3aeafef46ac7c52c",
      "pubkey": "038131d9917592ef142bad9db15d2d96ff4562f83105a50abbcc53362b8e1dffa6",
      "pubKeyHash": "952bae5f20dc6d0ca8a5b92b3aeafef46ac7c52c",
      "address": "tb1qj546uheqm3kse299hy4n46h7734v03fvdpz3wv"
    },
    {
      "fullKeyPath": "86'/1'/0'/1/0",
      "internal": true,
      "keyState": 2,
      "label": "Bernardo",
      "scriptPubKey": "1 760064fb5ca04f897ae1ab962fb722b3e2c1cb876d891f15ded89372d5ed80f0",
      "pubkey": "030548856287d8da7e02f3ec79d2d77cb91c6271d2bb5cd316370b6f798ae24347",
      "pubKeyHash": "6fdd4e1578612eaa6c3cac493244fc3536ae1169",
      "address": "tb1pwcqxf76u5p8cj7hp4wtzldezk03vrju8dky379w7mzfh940dsrcql6v8zr"
    }
  ],
  "id": "1"
}

This call can be adapted to query certain keys too.

All unused keys

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listkeys"}' http://127.0.0.1:37128/WalletName | jq '.result[] | select(.keyState == 0)'

All unused keys for change

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listkeys"}' http://127.0.0.1:37128/WalletName | jq '.result[] | select(.keyState == 0 and .internal == true)'

Unused keys generated by the user

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listkeys"}' http://127.0.0.1:37128/WalletName | jq '.result[] | select(.keyState == 0 and .internal == false and .label != "")'

All already used keys

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listkeys"}' http://127.0.0.1:37128/WalletName | jq '.result[] | select(.keyState == 2)'

All unused locked keys (reserved for coinjoins)

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"listkeys"}' http://127.0.0.1:37128/WalletName | jq '.result[] | select(.keyState == 1 and .internal == true)'

excludefromcoinjoin

Excludes a specific UTXO from participating in coinjoin.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"excludefromcoinjoin","params":["7958defd85bb4f34dc66b3323eaa2f4fbdbece35f5e1b2d7b49b461ddc2066ec", "0", true]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "id": "1"
}

The first parameter is the transaction ID of the UTXO, the second parameter is the index, the third parameter is whether to exclude (true) or not exclude (false) the coin from coinjoin. The exclusion applies until it is reverted (set to false).

Listunspentcoins method can be used to see the wallet's UTXOs and their excludedfromcoinjoin status.

startcoinjoin

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"startcoinjoin", "params":["UserPassphrase", "True", "True"]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "id": "1"
}

The first parameter is the wallet passphrase, the second parameter is stopWhenAllMixed, and the third one isoverridePlebStop.

payincoinjoin

Pay to a specific bitcoin address in a coinjoin.

curl -s --data-binary '{"jsonrpc":"2.0", "id":"1", "method":"payincoinjoin", "params":["tb1qaznf0ky4yh8vc3yhew984jhxugr8apeu7wa98d", 10000]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": "65c21ec1-9865-4cd6-bd67-c2f058a45d24",
  "id": "1"
}

The first parameter is the destination address, the second parameter is the amount in sats. The result is the paymentId.

A payincoinjoin is written to the logs and its status can be seen by using the listpaymentsincoinjoin method.

Payments in coinjoin can theoretically be made to any ScriptPubKey. However, the coordinator may only accept certain types of outputs. It is not possible to use a Silent Payment address as the destination for a payincoinjoin, as you need to know the private keys of all the inputs.

The default maximum is 4 payments per client per coinjoin.

payincoinjoin only registers a payment, so if coinjoin is not running or the amount is lower than the wallet balance, the payment is queued. Currently the coinjoin coin selector does not take into account that a payment is registerd. Therefore, it is possible that the payment will not be executed due to insufficient and/or non-optimal coins being selected, even though there are sufficient funds available.

Pending payments can be removed by using the cancelpaymentincoinjoin method. Pending payments are also removed if the Wasabi client restarts.

listpaymentsincoinjoin

Lists the current payments in coinjoins.

curl -s --data-binary '{"jsonrpc":"2.0", "id":"1", "method":"listpaymentsincoinjoin", "params":[]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": [
    {
      "id": "65c21ec1-9865-4cd6-bd67-c2f058a45d24",
      "amount": 10000,
      "destination": "0014e8a697d89525cecc4497cb8a7acae6e2067e873c",
      "state": [
        {
          "status": "Pending"
        }
      ],
      "address": "tb1qaznf0ky4yh8vc3yhew984jhxugr8apeu7wa98d"
    }
  ],
  "id": "1"
}

cancelpaymentincoinjoin

Cancels a payment in coinjoin.

curl -s --data-binary '{"jsonrpc":"2.0", "id":"1", "method":"cancelpaymentincoinjoin", "params":["65c21ec1-9865-4cd6-bd67-c2f058a45d24"]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0"
  "id": "1"
}

The parameter is the paymentId of the pending payment in coinjoin to be cancelled. It is written to the log when a payment is cancelled.

A payment can only be cancelled if it is not participating in a coinjoin.

Pending payments are automatically cancelled when the Wasabi client restarts.

startcoinjoinsweep

Sweeps (empties) the wallet by sending the coins in coinjoin to the destination wallet. It works the same as normal coinjoin, except that the outputs are sent to (internal addresses of) the destination wallet.

This is not a proper coinjoin to other wallet implementation, but supposed to be used to empty a wallet.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"startcoinjoinsweep", "params":["UserPassphrase", "OutputWalletName"]}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "id": "1"
}

stopcoinjoin

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"stopcoinjoin"}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "id": "1"
}

buildunsafetransaction

Builds a transaction. With the possibility for the mining fee to be higher than the sent amount, which is otherwise not possible in Wasabi.

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"buildunsafetransaction", "params": { "payments":[ {"sendto": "tb1qgjgy9k7q32rcvdjsp3nhq0x8saqcvyahhy8up2", "amount": 15000, "label": "David" }, ], "coins":[{"transactionid":"cdfda1d9839e71e82ca539a4f60e947b1cdfbeecb198616e1daa5c43e2e6fbb3", "index":0}], "feeTarget":2, "password": "UserPassphrase" }}' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "result": "01000000000101b3fbe6e2435caa1d6e6198b1ecbedf1c7b940ef6a439a52ce8719e83d9a1fdcd0000000000fdffffff02cfc40300000000002251203ad2f2cf18af791235fbc634333e30becbf7a3d566f9b2cbf36960d68d6e95f5983a000000000000160014449042dbc08a878636500c67703cc787418613b70247304402206cf8fd02465b77b189cb752c15e8baf69c5de7a1e1c9b27380227fc21b55ffa7022059533d0046e6a6b58bc6ff4be297d02773651849e6ba40f2dec31a98b9fa7863012103d626df6a18ed29d4c7e80199f7f183bd4949f6c8073463c81f3802b57f9546d000000000",
  "id": "1"
}

The result is the transaction hex, waiting to be broadcast.

Note that one can set a specific fee rate using the parameter feeRate instead of feeTarget.

stop

Stops and exits Wasabi.

curl -s --data-binary '{"jsonrpc":"2.0", "method":"stop"}' http://127.0.0.1:37128/ | jq

Errors

Method not found

curl -s --data-binary '{"jsonrpc":"2.0","id":"1","method":"howknows"}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "'howknows' method not found."
  },
  "id": "1"
}

Parse error

curl -s --data-binary '{"jsonrpc":"2.0" []}' http://127.0.0.1:37128/ | jq

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32700,
    "message": "Parse error"
  }
}

Mismatching parameters

curl -s --data-binary '{"jsonrpc":"2.0", "method": "getnewaddress", "params": { "lable": "label with a typo" }, "id":"1" }' http://127.0.0.1:37128/WalletName | jq

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32602,
    "message": "A value for the 'label' is missing."
  },
  "id": "1"
}

Expose the RPC server as an onion service

Since Wasabi version 2.0.6open in new window the RPC can be exposed as an onion service, which enables remote control.

The RPC server can be exposed as an onion service by using the rpconionenabled=true start up parameter or the environment variable.

A few notes:

Tor needs to be enabled.
Anonymous access is not allowed: jsonrpcuser & jsonrpcpassword need to be specified.
RpcOnionEnabled is only available as a command line switch (start up parameter) and an environment variable, it is not available in the config file.
A new onion address is generated at each startup.

The onion service which the RPC server is listening on is being logged at startup and visible using the getstatus RPC method.

To start Wasabi with rpconionenabled enabled:

wassabeed --rpconionenabled=true

The onion address is shown in the log:

INFO       Global.StartTorProcessManagerAsync (284)        RPC server listening on http://rrdayxv2pngzl3jyal5dfjvl6s4bt4frvo5jj2rgnajz5gyevrm4fvyd.onion/

The onion service cannot be started in case the jsonrpcuser and/or jsonrpcpassword are not specified and it will log: Anonymous access RPC server cannot be exposed as onion service.

You need to specify them in the config file, or add them as command line switches or environment variables.

In the RPC calls, the localhost, jsonrpcuser and jsonrpcpassword need to be specified.

Example

We assume the Tor instance is running on the default port (9050). Use Tor as a socks proxy for your client.

curl -s --socks5-hostname 127.0.0.1:9050 --user Myjsonrpcuser:Myjsonrpcpassword --data-binary '{"jsonrpc":"2.0","id":"1","method":"listwallets"}' http://rrdayxv2pngzl3jyal5dfjvl6s4bt4frvo5jj2rgnajz5gyevrm4fvyd.onion/ | jq

{
  "jsonrpc": "2.0",
  "result": [
    {
      "walletName": "Wallet1"
    },
    {
      "walletName": "Wallet2"
    }
  ],
  "id": "1"
}