API reference
Every Rarebl Open API endpoint (v1 and v2), grouped by Stats, Blocks, Transactions, Hosted signing, Addresses, Tokens, Gas, Search, Webhooks and Market, plus the WebSocket stream.
# API reference
Rarebl Open API (v1 and v2): 42 HTTP endpoints for BTC, LTC, BCH, DASH, ETH and TRON, at `https://api.rarebl.com/open/<module>/<action>`, plus a [WebSocket stream](https://docs.rarebl.com/api/websocket). v1 reads accept `GET` with query parameters or `POST` with a JSON body; v2 writes are `POST` with a JSON body. No API key is needed: clients are limited per IP by rate class.
Each endpoint page documents its parameters, headers, a request example, realistic responses and the error codes it can return. Shared response shapes are on [Data types](https://docs.rarebl.com/data-types).
### Stats
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Chains](https://docs.rarebl.com/api/stats/chains) | `GET` / `POST` | `/open/stats/chains` | read | List the six supported chains with their identity, units, current tip, health and which features each one supports today. |
| [Live stats](https://docs.rarebl.com/api/stats/live) | `GET` / `POST` | `/open/stats/live` | read | One cheap call with the head of every chain: tip, mempool size and the current fee. Refreshed about every 2 seconds, so it is the one to poll. |
| [Token](https://docs.rarebl.com/api/token/info) | `GET` / `POST` | `/open/token/info` | read | Metadata of a token contract on ETH or TRON: standard, name, symbol, decimals and total supply. |
### Blocks
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Latest blocks](https://docs.rarebl.com/api/block/latest) | `GET` / `POST` | `/open/block/latest` | read | The newest blocks of a chain, newest first, with a cursor to page back in time. |
| [Block](https://docs.rarebl.com/api/block/get) | `GET` / `POST` | `/open/block/get` | read | One block by height or hash, with its chain-specific details and a page of its transactions. |
### Transactions
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Transaction](https://docs.rarebl.com/api/tx/get) | `GET` / `POST` | `/open/tx/get` | read | Full detail of one transaction by hash: status, block, amounts and fee, plus inputs and outputs (UTXO chains) or sender, gas, token transfers and logs (ETH and TRON). |
| [Transaction status](https://docs.rarebl.com/api/tx/status) | `GET` / `POST` | `/open/tx/status` | read | A small, fast status check for one transaction: pending, success or failed, its block, confirmations and time. Built for polling a deposit until it confirms. |
| [Mempool](https://docs.rarebl.com/api/tx/mempool) | `GET` / `POST` | `/open/tx/mempool` | read | Unconfirmed transactions the node currently sees, newest first, with the mempool size. |
| [Build a transaction](https://docs.rarebl.com/api/tx/build) | `POST` | `/open/tx/build` | compute | Builds an unsigned transaction on any chain and returns the digests to sign. The API supplies UTXOs or nonce and fees; your keys never leave you. |
| [Assemble a signed transaction](https://docs.rarebl.com/api/tx/assemble) | `POST` | `/open/tx/assemble` | compute | Inserts your signatures into an unsigned transaction from tx/build, verifies them, and can broadcast the result in the same call. |
| [Broadcast a transaction](https://docs.rarebl.com/api/tx/broadcast) | `POST` | `/open/tx/broadcast` | write | Sends a fully signed transaction to the network through Rarebl's own nodes, with pre-checks and an idempotency key. |
| [Decode a transaction](https://docs.rarebl.com/api/tx/decode) | `POST` | `/open/tx/decode` | compute | Decodes a raw transaction (signed or unsigned) into the v1 Tx shape, with status `unsent`, so you can check what you are about to send. |
| [Estimate a transaction](https://docs.rarebl.com/api/tx/estimate) | `POST` | `/open/tx/estimate` | compute | Estimates the fee of a transaction without building digests. It takes the same body as tx/build. |
| [Output spend status](https://docs.rarebl.com/api/tx/outspends) | `GET` | `/open/tx/outspends` | read | For each output of a UTXO transaction, whether it is spent, by which transaction, and whether the spend is still in the mempool. |
| [Signer public key](https://docs.rarebl.com/api/tx/signer-key) | `GET` | `/open/tx/signer-key` | read | The X25519 public key you encrypt private keys to when you use hosted signing. Only the signer process can read what you encrypt to it. |
### Hosted signing
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Sign a transaction (hosted)](https://docs.rarebl.com/api/tx/sign) | `POST` | `/open/tx/sign` | write | Sends private keys to Rarebl, which signs an unsigned transaction in memory and forgets the keys. It never broadcasts. |
| [Build, sign and send (hosted)](https://docs.rarebl.com/api/tx/send) | `POST` | `/open/tx/send` | write | One call that builds, signs with the keys you send, and broadcasts. |
| [New address and key (hosted)](https://docs.rarebl.com/api/address/new) | `POST` | `/open/address/new` | write | Generates a new keypair inside the signer, never stores it, and returns it once. The SDKs can also generate keys locally (`keys.generate`). |
### Addresses
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Address](https://docs.rarebl.com/api/address/balance) | `GET` / `POST` | `/open/address/balance` | read | Balance and summary of an address: validity, type, balance, totals received and sent, transaction count and chain-specific details. |
| [Address transactions](https://docs.rarebl.com/api/address/transactions) | `GET` / `POST` | `/open/address/transactions` | read | The transactions of an address, newest first, with a cursor to page back in time. |
| [Address tokens](https://docs.rarebl.com/api/address/tokens) | `GET` / `POST` | `/open/address/tokens` | read | Token balances held by an ETH or TRON address: known tokens such as USDT and USDC, plus TRC-10 assets on TRON. |
| [Validate an address](https://docs.rarebl.com/api/address/validate) | `GET` | `/open/address/validate` | compute | Checks that an address is well formed for a chain and returns its type and normalized form. For ETH it also tells whether the address is a contract. |
| [Watch addresses](https://docs.rarebl.com/api/address/watch) | `POST` | `/open/address/watch` | watch | Starts tracking BTC, LTC or BCH addresses (their UTXOs and activity) so that UTXOs, balances and webhooks become exact. |
| [Address UTXOs](https://docs.rarebl.com/api/address/utxos) | `GET` | `/open/address/utxos` | read | The unspent outputs and balance of an address, for sweeps and payouts. BTC, LTC and BCH addresses must be watched and active; DASH uses its node index. |
| [Address nonce (ETH)](https://docs.rarebl.com/api/address/nonce) | `GET` | `/open/address/nonce` | read | The latest and pending transaction count of an Ethereum address, to set the nonce of the next transaction. |
| [Address resources (TRON)](https://docs.rarebl.com/api/address/resources) | `GET` | `/open/address/resources` | read | The energy and bandwidth of a TRON account, and its frozen balances, to know whether a transfer burns TRX. |
### Gas and miner fees
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Recommended fees](https://docs.rarebl.com/api/fees/recommended) | `GET` / `POST` | `/open/fees/recommended` | read | Recommended fees for every chain at three speeds — fastest, medium and normal: the miner fee on BTC, LTC, BCH and DASH (sat/vB), the gas price on ETH (Gwei) and the energy price on TRON (sun). |
### Search
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Search](https://docs.rarebl.com/api/search/query) | `GET` / `POST` | `/open/search/query` | read | Find out what a pasted string is: a block height, a transaction or block hash, an address in any format, a token name or a contract, or a link from another explorer. Every plausible match comes back ranked, with a confidence and a reason. |
### Webhooks
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Create a webhook](https://docs.rarebl.com/api/hooks/create) | `POST` | `/open/hooks/create` | hooks | Creates a webhook subscription. There are no accounts: the reply carries a management token and a signing secret, both shown once. |
| [Get a webhook](https://docs.rarebl.com/api/hooks/get) | `GET` | `/open/hooks/get` | read | Reads a subscription. Secrets are not returned again. |
| [Update a webhook](https://docs.rarebl.com/api/hooks/update) | `POST` | `/open/hooks/update` | hooks | Changes fields of a subscription, for example its URL or confirmation threshold. |
| [Pause a webhook](https://docs.rarebl.com/api/hooks/pause) | `POST` | `/open/hooks/pause` | hooks | Stops deliveries without deleting the subscription. |
| [Resume a webhook](https://docs.rarebl.com/api/hooks/resume) | `POST` | `/open/hooks/resume` | hooks | Restarts deliveries of a paused subscription. |
| [Delete a webhook](https://docs.rarebl.com/api/hooks/delete) | `POST` | `/open/hooks/delete` | hooks | Deletes a subscription permanently. |
| [Webhook deliveries](https://docs.rarebl.com/api/hooks/deliveries) | `GET` | `/open/hooks/deliveries` | read | The last 100 delivery attempts of a subscription, to debug your endpoint. |
| [Send a test event](https://docs.rarebl.com/api/hooks/test) | `POST` | `/open/hooks/test` | hooks | Sends a signed sample event to your URL so you can test signature verification. |
| [Replay an event](https://docs.rarebl.com/api/hooks/replay) | `POST` | `/open/hooks/replay` | hooks | Re-sends a past event to your URL. |
### Market
| Endpoint | Method | Path | Rate class | Description |
| --- | --- | --- | --- | --- |
| [Prices](https://docs.rarebl.com/api/market/price) | `GET` | `/open/market/price` | read | Reference prices aggregated from public exchange feeds: the median of fresh sources, outliers more than 2% from the median excluded. Not Rarebl trading rates. |
| [Tickers](https://docs.rarebl.com/api/market/tickers) | `GET` | `/open/market/tickers` | read | The individual exchange tickers behind a price. |
| [Price history](https://docs.rarebl.com/api/market/history) | `GET` | `/open/market/history` | read | OHLCV candles for an asset. |
| [Assets](https://docs.rarebl.com/api/market/assets) | `GET` | `/open/market/assets` | read | The assets with prices: symbol, name, chain, token contract and decimals. |
| [FX rates](https://docs.rarebl.com/api/market/fx) | `GET` | `/open/market/fx` | read | Foreign-exchange reference rates, for example usd to ghs and ngn. |