Skip to content

Read API reference

Channels

Source: hypersnap-docs-web/src/reference/reads/channels.mdLast synced: May 20, 2026

Channels #

Farcaster channels are parent-URL-scoped subcommunities. Hypersnap maintains a local channel registry and membership index.

Common Channel fields: id, parent_url, name, image_url, description, lead (the channel host's User), moderator_fids, follower_count, created_at.


GET /v2/farcaster/channel #

Look up a single channel.

Query parameters

Name Type Required Notes
id string yes Either the channel id (e.g. memes) or the parent URL.
type "id" | "parent_url" no Default "id".

Response

{ "channel": { "id": "memes", "..." : "..." } }

GET /v2/farcaster/channel/all #

List every channel the node knows about. Also reachable as GET /v2/farcaster/channel/list (spec-compat alias).

Query parameters

Name Type Required
limit usize no
cursor string no

GET /v2/farcaster/channel/bulk #

Batch channel lookup.

Query parameters

Name Type Required Notes
ids string yes Comma-separated channel ids.

GET /v2/farcaster/channel/search #

Prefix-style search against the channel name index.

Query parameters

Name Type Required
q string yes
limit usize no

GET /v2/farcaster/channel/trending #

Channels with the most engagement over a rolling window.

Query parameters

Name Type Required
limit usize no

GET /v2/farcaster/channel/members #

Members of a specific channel. Also reachable as /v2/farcaster/channel/member/list, /v2/farcaster/channel/followers, and /v2/farcaster/channel/followers/relevant — all three forward to the same member-list handler.

Query parameters

Name Type Required Notes
channel_id string yes The channel id.
limit usize no Default 10.
cursor string no Pagination cursor.

Response

{ "users": [ { /* User */ } ], "next": { "cursor": "..." } }

GET /v2/farcaster/channel/member/invite/list #

List open channel-member invites. The Farcaster protocol does not include an on-chain invite system — this endpoint is registered for SDK compatibility and returns an empty list.

Response

{ "members": [], "next": { "cursor": null } }

GET /v2/farcaster/channel/user-active #

Channels where a specific user has recently been active. Also reachable as GET /v2/farcaster/channel/user (spec-compat alias).

Query parameters

Name Type Required
fid u64 yes
limit usize no
cursor string no

Write endpoints #

POST /v2/farcaster/channel/follow, DELETE /v2/farcaster/channel/follow, POST /v2/farcaster/channel/member/invite, PUT /v2/farcaster/channel/member/invite, and DELETE /v2/farcaster/channel/member are registered but return 501 Not Implemented. Follow/unfollow is expressed through the protocol via signed LinkAdd/LinkRemove messages.


Mirrored from hypersnap-docs-web. Edit the source to update this page.

Edit on GitHub