Skip to content

Read API reference

Blocks, mutes, bans

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

Blocks, Mutes, Bans #

Block and mute state is expressed in the Farcaster protocol as LinkAdd messages with a non-follow link_type ("block" or "mute"). Hypersnap surfaces the current block/mute list for a given FID by querying the LinkStore directly.

Ban lists are app-level, not protocol-level — they do not exist in the Farcaster protocol and the corresponding endpoint returns an empty list.

Response shape for all list endpoints:

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

GET /v2/farcaster/block/list #

FIDs that fid has blocked.

Query parameters

Name Type Required
fid u64 yes
limit usize no

Backed by LinkStore::get_link_adds_by_fid(fid, "block", ...) — a direct index lookup, no scan.


GET /v2/farcaster/mute/list #

FIDs that fid has muted.

Query parameters

Name Type Required
fid u64 yes
limit usize no

Backed by LinkStore::get_link_adds_by_fid(fid, "mute", ...).


GET /v2/farcaster/ban/list #

Registered for SDK compatibility — bans are an app-level concept and not part of the Farcaster protocol.

Response

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

Write endpoints #

POST /v2/farcaster/block, DELETE /v2/farcaster/block, POST /v2/farcaster/mute, DELETE /v2/farcaster/mute, POST /v2/farcaster/ban, and DELETE /v2/farcaster/ban are registered but return 501 Not Implemented. Submit signed LinkAdd/LinkRemove messages with link_type = "block" or "mute" via gRPC SubmitMessage.


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

Edit on GitHub