Hathor API
About this API
The Hathor Full Node HTTP API is a REST API exposed by hathor-core, the reference implementation of the Hathor protocol. It gives you direct access to ledger state, peer-to-peer network status, transaction submission, and nano contract execution.
This API is designed for:
- External systems and integrations that need to read ledger state (balances, UTXOs, token history) directly from the network.
- Block explorers and dashboards that need real-time transaction and block data.
- Mining software that needs to retrieve block templates and submit mined blocks.
- DApp backends that need to query or execute nano contracts.
If your integration needs to sign and submit transactions programmatically, you should use the Headless Wallet HTTP API instead. The headless wallet wraps key management and transaction signing on top of this full node API.
Prerequisites
Before using this API reference, ensure you have:
- A running Hathor full node (hathor-core v0.63.1 or later). See the Full node pathway for installation options.
- Network access to the full node's HTTP port (default:
8080).
Base URL
The API is served at the root of the full node HTTP port:
http://<your-node-host>:<port>/
For a locally running node with default settings:
http://localhost:8080/
Public mainnet and testnet endpoints are listed in Public networks.
Authentication
By default, the full node HTTP API does not require authentication — it is designed to run within a controlled network environment. If you expose it beyond localhost, restrict access at the network or proxy level.
Never expose the full node HTTP API directly to the public internet without additional access controls.
API scope
This reference covers all HTTP endpoints exposed by hathor-core, organized into the following categories:
| Category | Description |
|---|---|
| healthcheck | Node health and readiness checks |
| p2p | Peer connections, network status, and mining block submission |
| netfilter | Manage peer-to-peer network filtering rules |
| block | Query blocks by height |
| transaction | Create, decode, push, and query transactions |
| mempool | List transactions pending confirmation |
| mining | Block template retrieval and block submission for mining clients |
| utxo | Search and filter UTXOs by address, token, or amount |
| nano-contract | Decode, create, and execute nano contracts |
| wallet | Address balances, address history, token queries, and send tokens |
In addition, the full node exposes a WebSocket API for real-time event streaming, wallet subscriptions, and mining notifications. See the WebSocket API Overview for details.
Next steps
- Full node pathway: installation, configuration, and component overview.
- WebSocket API: real-time subscriptions for address events, blockchain updates, and mining.
- Public networks: mainnet and testnet endpoint URLs and genesis data.
- Headless Wallet HTTP API: for wallet-level operations including transaction signing and token creation.
- Download OpenAPI spec: import into Postman, Insomnia, or other API tools.