createwallet

createwallet "wallet_name" ( disable_private_keys blank "passphrase" avoid_reuse descriptors load_on_startup external_signer ) Creates and loads a new wallet. Arguments: 1. wallet_name (string, required) The name for the new wallet. If this is a path, the wallet will be created at the path location. 2. disable_private_keys (boolean, optional, default=false) Disable the possibility of private keys (only watchonlys are possible in this mode). 3. blank (boolean, optional, default=false) Create a blank wallet. A blank wallet has no keys. 4. passphrase (string, optional) Encrypt the wallet with this passphrase. 5. avoid_reuse (boolean, optional, default=false) Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind. 6. descriptors (boolean, optional, default=true) If set, must be "true" 7. load_on_startup (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged. 8. external_signer (boolean, optional, default=false) Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true. 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. "warnings" : [ (json array, optional) Warning messages, if any, related to creating and loading the wallet. "str", (string) ... ] } Examples: > bitcoin-cli createwallet "testwallet" > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "createwallet", "params": ["testwallet"]}' -H 'content-type: application/json' http://127.0.0.1:8332/ > bitcoin-cli -named createwallet wallet_name=descriptors avoid_reuse=true descriptors=true load_on_startup=true > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "createwallet", "params": {"wallet_name":"descriptors","avoid_reuse":true,"descriptors":true,"load_on_startup":true}}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

createwallet(wallet_name: string, disable_private_keys?: boolean, blank?: boolean, passphrase?: string, avoid_reuse?: boolean, descriptors?: boolean, load_on_startup?: boolean, external_signer?: boolean) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"createwallet","params":["\"<wallet_name>\"",false,false,"\"<passphrase>\"",false,true,false,false]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli createwallet "testwallet"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "createwallet", "params": ["testwallet"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

bitcoin-cli -named createwallet wallet_name=descriptors avoid_reuse=true descriptors=true load_on_startup=true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "createwallet", "params": {"wallet_name":"descriptors","avoid_reuse":true,"descriptors":true,"load_on_startup":true}}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "createwallet",
        "params": ["\"<wallet_name>\"", false, false, "\"<passphrase>\"", false, true, false, false],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "createwallet",
    params: ["\"<wallet_name>\"",false,false,"\"<passphrase>\"",false,true,false,false],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
wallet_name	`string`	yes	The name for the new wallet. If this is a path, the wallet will be created at the path location.
disable_private_keys	`boolean`	—	Disable the possibility of private keys (only watchonlys are possible in this mode).
blank	`boolean`	—	Create a blank wallet. A blank wallet has no keys.
passphrase	`string`	—	Encrypt the wallet with this passphrase.
avoid_reuse	`boolean`	—	Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind.
descriptors	`boolean`	—	If set, must be "true"
load_on_startup	`boolean`	—	Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged.
external_signer	`boolean`	—	Use an external signer such as a hardware wallet. Requires -signer to be configured. Wallet creation will fail if keys cannot be fetched. Requires disable_private_keys and descriptors set to true.

Result

Type: any

{ (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. "warnings" : [ (json array, optional) Warning messages, if any, related to creating and loading the wallet. "str", (string) ... ] }

Source: services/core-node/bcore/src/wallet/rpc/wallet.cpp:343

C++ symbol: createwallet

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"createwallet","params":["\"<wallet_name>\"",false,false,"\"<passphrase>\"",false,true,false,false]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli createwallet "testwallet"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "createwallet", "params": ["testwallet"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

bitcoin-cli -named createwallet wallet_name=descriptors avoid_reuse=true descriptors=true load_on_startup=true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "createwallet", "params": {"wallet_name":"descriptors","avoid_reuse":true,"descriptors":true,"load_on_startup":true}}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "createwallet",
        "params": ["\"<wallet_name>\"", false, false, "\"<passphrase>\"", false, true, false, false],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "createwallet",
    params: ["\"<wallet_name>\"",false,false,"\"<passphrase>\"",false,true,false,false],
  }),
});
console.log(await res.json());