Docs / Overview
Documentation
Farbeam is an on-chain data service. It reads seven chains, stores transfers of at least $100,000 for 7 days, and exposes the results through a REST API, a live stream and signed webhooks. These docs state what each part does, where its data comes from and where it stops.
The site holds 101 documentation pages, including a reference page for each of the 40 endpoints. Every example response on these pages was captured from the running service, with the UTC date next to it.
Get started
9 pages. Start with Introduction.
Core concepts
7 pages. Start with Data model.
Data
15 pages. Start with Chain coverage.
Alerts and webhooks
9 pages. Start with Alerts overview.
SDK guides
10 pages. Start with SDK overview.
Reference
5 pages. Start with Limits.
Security and policy
4 pages. Start with Security.
API overview
1 page. Start with API reference index.
#Popular pages
- Quickstart: first call, first key and first webhook.
- Beamline rule language: the grammar, the fields and the error messages.
- Webhook signatures: verification code for curl, JavaScript, Python and Go.
- Token checks: every check, threshold and source field.
- Indexing: how each poller works and what it misses.
- Limits: every limit in one table.
- API reference: all endpoints, with real responses.