Read API reference
Overview
Source:
hypersnap-docs-web/src/reference/reads/index.mdLast synced: May 20, 2026Read API reference #
Every endpoint in this section is public: no auth, no signed headers, no API key. Responses are served from local indexes over the data the Hypersnap node has ingested.
Conventions #
- Base URL: all paths are relative to the Hypersnap HTTP listener. Examples use
https://haatz.quilibrium.comas a placeholder. - Content type: responses are always
application/json. - Pagination: cursor-based; see Pagination & cursors.
- Errors: see Errors. All errors return
{ "message": "..." }.
Endpoint groups #
- Users — lookup by FID, username, address, custody address, X/Twitter username, location; bulk; search; interactions; best friends; storage; FID listing; verifications.
- Casts — lookup by hash or URL; bulk; search; conversation threads; quotes; metrics.
- Feeds — default, following, trending, for-you, channel, parent-url, topic, user-casts, popular, replies-and-recasts.
- Channels — lookup, list, bulk, search, trending, members, followers, active-for-user, invites.
- Reactions — generic lookup, by-cast, by-user (with spec-compat aliases).
- Follows — followers, following, reciprocal (mutual), suggested (friends-of-friends), relevant.
- User notifications — mentions/replies/reactions/follows for a FID, filterable by channel or parent URL.
- Usernames & proofs — fname availability, username proofs.
- Signers & on-chain events — signer key registry, ID registry history.
- Blocks, mutes, bans — block/mute lists from link messages.
- Batch reads — POST-body hydration for a list of FIDs (follows, reactions, signers, id-registrations, interactions).
Mirrored from hypersnap-docs-web. Edit the source to update this page.
Edit on GitHub