API Documentation
Twister exposes a public JSON API for searching indexed Tangled content. No authentication is required for read endpoints.
Base URL
https://<your-twister-domain>All endpoints are relative to the base URL. When using the search site, the API is on the same origin.
Response shape
All responses are JSON. Successful responses return the resource directly. Errors return:
{"error": "error_code", "message": "what went wrong"}Endpoints
| Resource | Description |
|---|---|
| Search | FTS5 keyword search over indexed documents |
| Documents | Fetch a single indexed document by stable ID |
| Actors & Repos | Actor profiles, repo records, and repo sub-resources |
| Issues | Issue detail and comments with pre-joined state |
| Pull Requests | PR detail and comments with pre-joined status |
| Identity | Handle resolution and DID document lookup |
| Activity | Cached Jetstream events and real-time WebSocket stream |
| Profiles & Backlinks | Social signals and Constellation backlinks counts |
| XRPC Proxy | Pass-through proxy to knots, PDS hosts, and Bluesky |
| Health | Liveness and readiness probes |
Pagination
List endpoints use limit and offset query
parameters. Defaults and maximums vary per endpoint — see each resource page
for details.