Skip to main content
POST
Create a wallet

Authorizations

Authorization
string
header
required

Base64url-encoded auth token

Body

application/json
network
enum<string>
required

The network to use for the wallet

Available options:
mainnet,
signet,
mutinynet,
regtest
ark_server
string | null

The Ark server to use for the wallet. Optional when a config.toml already exists in the datadir.

ark_server_access_token
string | null
deprecated

An access token for a private Ark server.

Deprecated: access tokens are no longer enforced by the server; this field will be removed in a future release.

birthday_height
integer<int32> | null

An optional birthday height to start syncing the wallet from

Required range: x >= 0
chain_source
object

The chain source to use for the wallet. Optional when a config.toml already exists in the datadir.

force
boolean

Proceed even if the datadir contains unexpected files

gap_limit
integer<int32> | null

How many consecutive unused key indices a VTXO key scan may cross before it concludes the wallet doesn't own a recovered/imported VTXO.

Required range: 0 <= x <= 100000
mnemonic
string | null

The optional mnemonic to use for the wallet

Response

Wallet created successfully

fingerprint
string
required