Return the balance of HTR

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
DApps
FAQ
Glossary
Encyclopedia
Besides documentation
References
Headless wallet
HTTP API
Return the balance of HTR
Return the balance of HTR

GET
/wallet/balance

Return the balance of HTR

Request

Query Parameters
token string
Token uid. Optional parameter to get the balance from a token different than HTR.

Header Parameters
x-wallet-id stringrequired
Defines the key of the wallet on which the request will be executed.

Responses
200
Balance of tokens available and locked. To get the total, you must sum them up.
application/json
Schema
success
wallet-not-ready
no-wallet-id
invalid-wallet-id
Schema
any
Loading...
Previous
Return the wallet status
Next
Return the current address

Return the balance of HTR

/wallet/balance

Request​

Query Parameters

Header Parameters

Responses​

Request

Responses