very fast at protocol indexer with flexible filtering, xrpc queries, cursor-backed event stream, and more, built on fjall
rust
fjall
at-protocol
atproto
indexer
1---
2title: rest api
3---
4
5hydrant's REST API is split into public endpoints (safe to expose) and management endpoints (keep private). see [getting started](../getting-started.md#reverse-proxying) for guidance on what to expose.
6
7## public
8
9- `GET /stream`: subscribe to the event stream. query params: `cursor` (optional, start from a specific event ID). slow consumers may receive a `{"type":"error","error":"ConsumerTooSlow",...}` frame before the connection closes.
10- `GET /stats`: get stats about the database (counts of repos, records, events; sizes of keyspaces on disk).
11- `GET /health` / `GET /_health`: health check.
12
13## management
14
15- [filter](filter.md): NSID filter configuration
16- [ingestion](ingestion.md): enable/disable crawler, firehose, backfill at runtime
17- [crawler](crawler.md): crawler source management
18- [firehose](firehose.md): firehose source management
19- [pds](pds.md): rate-limit tier assignments
20- [repos](repos.md): explicit repository tracking, resyncing, untracking
21- [database](database.md): compression training, compaction