Farbeam
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

MethodPathWhat it does
GET/healthService health
GET/statusStatus
GET/status/historyStatus history

#Chains

MethodPathWhat it does
GET/chainsList chains
GET/chains/{chain}Get a chain
GET/chains/{chain}/blocksRecent blocks
GET/gasGas and fees
GET/pricesAsset prices

#Transfers

MethodPathWhat it does
GET/transfersList large transfers
GET/transfers/statsTransfer statistics
GET/api/liveLive stream

#Wallets

MethodPathWhat it does
GET/wallets/{address}Wallet overview
GET/wallets/{address}/activityWallet activity

#Tokens

MethodPathWhat it does
GET/tokens/{chain}/{address}Token report

#Transactions

MethodPathWhat it does
GET/tx/{chain}/{hash}Transaction lookup

#Labels

MethodPathWhat it does
GET/labelsList labels
GET/labels/{address}Get a label

#Markets

MethodPathWhat it does
GET/markets/chainsChain TVL
GET/markets/stablecoinsStablecoin supply
GET/markets/dexsDEX volume
GET/markets/poolsTrending pools

#Account

MethodPathWhat it does
POST/auth/challengeStart wallet sign-in
POST/auth/verifyFinish wallet sign-in
GET/auth/sessionSession state
POST/auth/logoutSign out
GET/accountAccount
POST/account/telegramLink Telegram
DELETE/account/telegramUnlink Telegram

#Keys

MethodPathWhat it does
POST/keysCreate an API key
DELETE/keys/{id}Revoke a key
GET/meCurrent key
DELETE/meRevoke the current key

#Alert rules

MethodPathWhat it does
POST/rules/validateValidate a rule
GET/rulesList rules
POST/rulesCreate a rule
GET/rules/{id}Get a rule
PATCH/rules/{id}Update a rule
DELETE/rules/{id}Delete a rule
POST/rules/{id}/testSend a test delivery
GET/rules/{id}/deliveriesList deliveries