RPC Browser

Arguments


Help Content

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 or HD seed. One can be set using sethdseed.
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=false) Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation
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.
  "warning" : "str"     (string) Warning message if wallet was not loaded cleanly.
}

Examples:
> bitcoin-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:8332/
> bitcoin-cli -named createwallet wallet_name=descriptors avoid_reuse=true descriptors=true load_on_startup=true
> curl --user myusername --data-binary '{"jsonrpc": "1.0", "id": "curltest", "method": "createwallet", "params": {"wallet_name":"descriptors","avoid_reuse":true,"descriptors":true,"load_on_startup":true}}' -H 'content-type: text/plain;' http://127.0.0.1:8332/

wallet_name

{
    "name": "wallet_name",
    "detailsLines": [],
    "properties": [
        "string",
        "required"
    ],
    "description": "The name for the new wallet. If this is a path, the wallet will be created at the path location."
}

disable_private_keys

{
    "name": "disable_private_keys",
    "detailsLines": [],
    "properties": [
        "boolean",
        "optional",
        "default=false"
    ],
    "description": "Disable the possibility of private keys (only watchonlys are possible in this mode)."
}

blank

{
    "name": "blank",
    "detailsLines": [],
    "properties": [
        "boolean",
        "optional",
        "default=false"
    ],
    "description": "Create a blank wallet. A blank wallet has no keys or HD seed. One can be set using sethdseed."
}

passphrase

{
    "name": "passphrase",
    "detailsLines": [],
    "properties": [
        "string",
        "optional"
    ],
    "description": "Encrypt the wallet with this passphrase."
}

avoid_reuse

{
    "name": "avoid_reuse",
    "detailsLines": [],
    "properties": [
        "boolean",
        "optional",
        "default=false"
    ],
    "description": "Keep track of coin reuse, and treat dirty and clean coins differently with privacy considerations in mind."
}

descriptors

{
    "name": "descriptors",
    "detailsLines": [],
    "properties": [
        "boolean",
        "optional",
        "default=false"
    ],
    "description": "Create a native descriptor wallet. The wallet will use descriptors internally to handle address creation"
}

load_on_startup

{
    "name": "load_on_startup",
    "detailsLines": [],
    "properties": [
        "boolean",
        "optional"
    ],
    "description": "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

{
    "name": "external_signer",
    "detailsLines": [],
    "properties": [
        "boolean",
        "optional",
        "default=false"
    ],
    "description": "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."
}

Recent (1)

Blockchain (25)

Control (6)

Generating (3)

Mining (6)

Network (13)

Rawtransactions (17)

Signer (1)

Util (8)

Wallet (61)

Zmq (1)