# Create / Restore

**POST /wallets**

<p align="right">status: <strong>stable</strong></p>

Create and restore a wallet from a mnemonic sentence or account public key.



## Servers
- https://localhost:8090/v2: https://localhost:8090/v2 ()



## Parameters



## Body parameters
Content-type: application/json

- **name** (string)
  
- **mnemonic_sentence** (array[string(bip-0039-mnemonic-word{english})])
  A list of mnemonic words
- **mnemonic_second_factor** (array[string(bip-0039-mnemonic-word{english})])
  An optional passphrase used to encrypt the mnemonic sentence.
- **passphrase** (string)
  A master passphrase to lock and protect the wallet for sensitive operation (e.g. sending funds)
- **address_pool_gap** (integer)
  Number of consecutive unused addresses allowed.

**IMPORTANT DISCLAIMER:** Using values other than `20` automatically makes your wallet invalid with regards to BIP-44 address discovery. It means that you **will not** be able to fully restore
your wallet in a different software which is strictly following BIP-44.

Beside, using large gaps is **not recommended** as it may induce important performance degradations. Use at your own risks.

**IMPORTANT DISCLAIMER 2:** There is no way to `import` addresses generated outside (e.g. using cardano-addresses) into the wallet.
Wallet only discovers transactions on its used and unused addresses that are within its currently seen `address_pool_gap`.
Transactions on addresses that "belong" to the wallet but happen to be beyond its `address_pool_gap` will not be visible to the wallet.
This is a technical limitation of the industry standard [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki). See also [CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/CIP-1852.md).

- **one_change_address_mode** (boolean)
  
- **restoration_mode** (string | object)
  The wallet restoration mode determines since when the wallet should
be restored from the blockchain.


## Responses
### 415: Unsupported Media Type

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when providing an invalid 'Content-Type' header.
- **code** (string)
  

### 409: Conflict

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when a otherwise valid request would yield a wallet that already exists.
- **code** (string)
  

### 406: Not Acceptable

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when providing an invalid 'Accept' header.
- **code** (string)
  

### 400: Bad Request

#### Body Parameters: application/json (object)
- **message** (string)
  May occur when a request is not well-formed; that is, it fails to parse
successfully. This could be the case when some required parameters
are missing or, when malformed values are provided.

- **code** (string)
  

### 201: Created

#### Body Parameters: application/json (object)
- **id** (string(hex))
  A unique identifier for the wallet
- **address_pool_gap** (integer)
  Number of consecutive unused addresses allowed.

**IMPORTANT DISCLAIMER:** Using values other than `20` automatically makes your wallet invalid with regards to BIP-44 address discovery. It means that you **will not** be able to fully restore
your wallet in a different software which is strictly following BIP-44.

Beside, using large gaps is **not recommended** as it may induce important performance degradations. Use at your own risks.

**IMPORTANT DISCLAIMER 2:** There is no way to `import` addresses generated outside (e.g. using cardano-addresses) into the wallet.
Wallet only discovers transactions on its used and unused addresses that are within its currently seen `address_pool_gap`.
Transactions on addresses that "belong" to the wallet but happen to be beyond its `address_pool_gap` will not be visible to the wallet.
This is a technical limitation of the industry standard [BIP-44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki). See also [CIP-1852](https://github.com/cardano-foundation/CIPs/blob/master/CIP-1852/CIP-1852.md).

- **balance** (object)
  Wallet current Ada balance(s).
- **assets** (object)
  Current non-Ada asset holdings of the wallet.

The amount of assets available to spend may be less than the total
unspent assets due to transaction change amounts which are yet to
be fully confirmed (pending).

- **delegation** (object)
  Delegation settings
- **name** (string)
  
- **passphrase** (object)
  Information about the wallet's passphrase
- **state** (object)
  Whether a wallet is ready to use or still syncing
- **tip** (object)
  A reference to a particular time slot, and the block height at that point.


[Powered by Bump.sh](https://bump.sh)