Create and start a wallet and add to store. | Hathor docs

Skip to main content

Home
Pathways
Explanations
Tutorials
How-to guides
References
Core (full node)
Headless wallet
HTTP API
Create and start a wallet and add to store.
Create and start a read-only wallet through an HSM, then add it to store.
Start a fireblocks client wallet on Hathor network.
Get MultiSig xpub for a seed.
Return the wallet status
Return the balance of HTR
Return the current address
Get the index of an address
Return all generated addresses of the wallet.
Send a transaction to exactly one output.
Decode tx hex or serialized partial tx into human readable inputs and outputs with metadata to assist informed decision-making. To obtain input metadata, this method retrieves a transaction per input from the wallet's transaction history. If the required transaction is not located, the method queries the fullnode for the transaction details.
Mark or unmark the inputs of a given transaction as selected as inputs on the storage. This prevents the inputs from being chosen by another transaction.
Build a transaction with many outputs without sending. Will not include signatures.
Get the hex representation of a melt tokens transaction without input data.
Add signatures to the transaction and return the txHex with the signatures.
Push a transaction from the txHex.
Identify which inputs on the transaction are from the loaded wallet.
Build an input data from the ECDSA signature(s).
Get the hex representation of a transaction without input data.
Get the hex representation of a create a token transaction without input data.
Get the hex representation of a mint tokens transaction without input data.
Get the hex representation of a melt tokens transaction without input data.
Get the signatures for all inputs from the wallet
Returns a transaction hex with input data calculated from the arguments
Send a transaction from the transaction hex and collected signatures
Create or update an atomic-swap proposal.
Get this wallet signatures for a proposal.
Registers a proposal for the Headless Wallet to listen to and interact with the Atomic Swap Service
Fetches a proposal data from the Atomic Swap Service
Fetches the list of listened proposals for this wallet
Removes a proposal from the registered listened proposals
Add signatures to a proposal and return the signed transaction in hex format.
Add signatures to a proposal and push the signed transaction.
Unlock all inputs if they are marked as selected on the wallet storage.
Get all utxos marked selected as input on a transaction to be sent.
Extract input data from a txHex in an atomic-swap compliant format.
Send a transaction with many outputs.
Create a token.
Mint tokens.
Melt tokens.
Create an NFT.
Return the data of a transaction, if it exists in the wallet
Return the number of blocks confirming the transaction, if it exists in the wallet
Return the transaction history
Stop a running wallet and remove from store.
Return utxos and some helpful information regarding it.
Consolidates utxos to a given address.
Get information of a given address.
Get state of a nano contract.
Get the history of a nano contract.
Get the oracle data.
Get the result signed by the oracle. Returns the string of the argument to be used in the method.
Create a nano contract of a blueprint.
Execute a nano contract method.
Get configuration string of a token.
Reload configuration of the wallet.
Return the health of the wallet headless.
Get the last loaded address index of a wallet.
Load more addresses by pushing the end index of a wallet configured to index-limit scanning policy.
Set the last address index of a wallet configured to index-limit scanning policy.
Configuration
Troubleshooting
Creating external notification custom plugin
Starting a wallet
Getting status
Getting addresses
Getting balance
Getting UTXOs
Transactions with Data Script Outputs
Creating tokens
Getting history
Stopping a wallet
SDK
FAQ
Glossary
Encyclopedia
Besides documentation
References
Headless wallet
HTTP API
Create and start a wallet and add to store.
Create and start a wallet and add to store.

POST
/start

Create and start a wallet and add to store.

Request

application/json
Body
required
Data to start the wallet
wallet-id stringrequired
Defines the key of wallet that future requests will need to use as a reference.
passphrase string
Passphrase of the wallet that will be created.
seedKey stringrequired
Key of the corresponding seed in the config file to create the wallet.
seed string
24-words seed separated with spaces. This parameter is incompatible with seedKey. Either seed or seedKey are required.
xpubkey string
Account level xpubkey. This will be used to start wallet on readonly mode.
multisig boolean
Start as a multisig wallet. Requires multisig configuration.
multisigKey string
Key of the multisig wallet data in the config. This allow wallets to be started without a seedKey, e.g. with the seed on the parameters or from an xpubkey.
scanPolicy string
Possible values: [gap-limit, index-limit]
Default value: gap-limit
Address scanning policy to use.
gapLimit number
Gap limit to use when scanning addresses. Only used when scanPolicy is set to 'gap-limit'. If not given the configured default will apply.
policyStartIndex number
Default value: 0
Load addresses starting from this index. Only used when scanPolicy is set to 'index-limit'.
policyEndIndex number
Stop loading addresses at this index. Only used when scanPolicy is set to 'index-limit'. Defaults to policyStartIndex
historySyncMode string
Possible values: [polling_http_api, xpub_stream_ws, manual_stream_ws]
Default value: polling_http_api
History sync mode for the wallet to use.

Responses
200
Start a wallet
application/json
Schema
success
seed-not-found
no-wallet-id
wallet-already-started
start-failed
Schema
any
Loading...
Previous
Introduction
Next
Create and start a read-only wallet through an HSM, then add it to store.