Docs / API overview
API reference
Base URL: https://farbeamlabs.com/api/v1. Every endpoint below is live. Responses are JSON. See authentication, rate limits, errors and the OpenAPI file.
#Service
| Method | Path | What it does |
|---|---|---|
GET | /health | Service health |
GET | /status | Status |
GET | /status/history | Status history |
#Chains
| Method | Path | What it does |
|---|---|---|
GET | /chains | List chains |
GET | /chains/{chain} | Get a chain |
GET | /chains/{chain}/blocks | Recent blocks |
GET | /gas | Gas and fees |
GET | /prices | Asset prices |
#Transfers
| Method | Path | What it does |
|---|---|---|
GET | /transfers | List large transfers |
GET | /transfers/stats | Transfer statistics |
GET | /api/live | Live stream |
#Wallets
| Method | Path | What it does |
|---|---|---|
GET | /wallets/{address} | Wallet overview |
GET | /wallets/{address}/activity | Wallet activity |
#Tokens
| Method | Path | What it does |
|---|---|---|
GET | /tokens/{chain}/{address} | Token report |
#Transactions
| Method | Path | What it does |
|---|---|---|
GET | /tx/{chain}/{hash} | Transaction lookup |
#Labels
| Method | Path | What it does |
|---|---|---|
GET | /labels | List labels |
GET | /labels/{address} | Get a label |
#Markets
| Method | Path | What it does |
|---|---|---|
GET | /markets/chains | Chain TVL |
GET | /markets/stablecoins | Stablecoin supply |
GET | /markets/dexs | DEX volume |
GET | /markets/pools | Trending pools |
#Account
| Method | Path | What it does |
|---|---|---|
POST | /auth/challenge | Start wallet sign-in |
POST | /auth/verify | Finish wallet sign-in |
GET | /auth/session | Session state |
POST | /auth/logout | Sign out |
GET | /account | Account |
POST | /account/telegram | Link Telegram |
DELETE | /account/telegram | Unlink Telegram |
#Keys
| Method | Path | What it does |
|---|---|---|
POST | /keys | Create an API key |
DELETE | /keys/{id} | Revoke a key |
GET | /me | Current key |
DELETE | /me | Revoke the current key |
#Alert rules
| Method | Path | What it does |
|---|---|---|
POST | /rules/validate | Validate a rule |
GET | /rules | List rules |
POST | /rules | Create a rule |
GET | /rules/{id} | Get a rule |
PATCH | /rules/{id} | Update a rule |
DELETE | /rules/{id} | Delete a rule |
POST | /rules/{id}/test | Send a test delivery |
GET | /rules/{id}/deliveries | List deliveries |