# Hypersnap

> Hypersnap is a decentralized social network — the evolution of Farcaster, built by a global community of contributors. No company, no VC. Same wire format and identities as Farcaster, but every node is run by someone different.

## About this index

This file is the LLM-friendly index of Hypersnap's documentation. Every page below mirrors a markdown file in the open repository at github.com/farcasterorg/hypersnap-docs-web. The single concatenated source is at /llms-full.txt.

Source repository: https://github.com/farcasterorg/hypersnap-docs-web
Last synced: 2026-05-20T05:16:55Z

## Getting Started

- [Introduction](https://hypersnap.org/docs/introduction): Getting Started reference.
- [Your first request](https://hypersnap.org/docs/getting-started): Getting Started reference.
- [API playground](https://hypersnap.org/docs/playground): Getting Started reference.

## Concepts

- [Overview](https://hypersnap.org/docs/concepts): Concepts reference.
- [Farcaster identity (FIDs)](https://hypersnap.org/docs/concepts/fids): Concepts reference.
- [Signed operations (EIP-712)](https://hypersnap.org/docs/concepts/authentication): Concepts reference.
- [JSON Farcaster Signatures (JFS)](https://hypersnap.org/docs/concepts/jfs): Concepts reference.
- [Pagination & cursors](https://hypersnap.org/docs/concepts/pagination): Concepts reference.
- [Rate limits](https://hypersnap.org/docs/concepts/rate-limits): Concepts reference.
- [Errors](https://hypersnap.org/docs/concepts/errors): Concepts reference.

## Read API reference

- [Overview](https://hypersnap.org/docs/reference/reads): Read API reference reference.
- [Users](https://hypersnap.org/docs/reference/reads/users): Read API reference reference.
- [Casts](https://hypersnap.org/docs/reference/reads/casts): Read API reference reference.
- [Feeds](https://hypersnap.org/docs/reference/reads/feeds): Read API reference reference.
- [Channels](https://hypersnap.org/docs/reference/reads/channels): Read API reference reference.
- [Reactions](https://hypersnap.org/docs/reference/reads/reactions): Read API reference reference.
- [Follows](https://hypersnap.org/docs/reference/reads/follows): Read API reference reference.
- [User notifications](https://hypersnap.org/docs/reference/reads/notifications): Read API reference reference.
- [Usernames & proofs](https://hypersnap.org/docs/reference/reads/usernames): Read API reference reference.
- [Signers & on-chain events](https://hypersnap.org/docs/reference/reads/signers): Read API reference reference.
- [Blocks, mutes, bans](https://hypersnap.org/docs/reference/reads/blocks-mutes): Read API reference reference.
- [Batch reads](https://hypersnap.org/docs/reference/reads/batch): Read API reference reference.

## Webhooks

- [Overview](https://hypersnap.org/docs/reference/webhooks): Webhooks reference.
- [Managing webhooks](https://hypersnap.org/docs/reference/webhooks/managing): Webhooks reference.
- [Subscription filters](https://hypersnap.org/docs/reference/webhooks/filters): Webhooks reference.
- [Delivery contract](https://hypersnap.org/docs/reference/webhooks/delivery): Webhooks reference.
- [Event schemas](https://hypersnap.org/docs/reference/webhooks/events): Webhooks reference.

## Mini-app notifications

- [Overview](https://hypersnap.org/docs/reference/miniapps): Mini-app notifications reference.
- [Registering a mini app](https://hypersnap.org/docs/reference/miniapps/registering): Mini-app notifications reference.
- [Client token webhook](https://hypersnap.org/docs/reference/miniapps/token-webhook): Mini-app notifications reference.
- [Sending notifications](https://hypersnap.org/docs/reference/miniapps/sending): Mini-app notifications reference.

## Guides

- [Build a Farcaster client](https://hypersnap.org/docs/guides/build-a-client): Guides reference.
- [Build an agent](https://hypersnap.org/docs/guides/build-an-agent): Guides reference.
- [Build a mini app](https://hypersnap.org/docs/guides/build-a-miniapp): Guides reference.
- [Receive webhooks](https://hypersnap.org/docs/guides/receive-webhooks): Guides reference.
- [Sign an EIP-712 request](https://hypersnap.org/docs/guides/sign-eip712): Guides reference.
- [Run the docs as a mini app](https://hypersnap.org/docs/guides/run-as-miniapp): Guides reference.

## For AI agents

- [Using these docs with an LLM](https://hypersnap.org/docs/agents): For AI agents reference.
- [Prompting Claude](https://hypersnap.org/docs/agents/claude): For AI agents reference.
- [Prompting ChatGPT](https://hypersnap.org/docs/agents/chatgpt): For AI agents reference.
- [Integration checklist](https://hypersnap.org/docs/agents/integration-checklist): For AI agents reference.
- [Full spec (single page)](https://hypersnap.org/docs/agents/full-spec): For AI agents reference.

## Appendix

- [Glossary](https://hypersnap.org/docs/appendix/glossary): Appendix reference.
- [Data retention](https://hypersnap.org/docs/appendix/retention): Appendix reference.

## Project surfaces

- [About Hypersnap](https://hypersnap.org/about): What it is, why it exists, who builds it.
- [Live network status](https://hypersnap.org/network): Public node, endpoints, shard data.
- [Run a node](https://hypersnap.org/run-a-node): Bootstrap, operator toolkit, doctor command, and runbook for node operators.
- [Install helper](https://hypersnap.org/install.sh): One-line installer for the open-source hypersnap operator CLI.
- [Operator toolkit](https://github.com/arcabotai/hypersnap): Source for hypersnap doctor/share/install helper.
- [Contribute](https://hypersnap.org/contribute): How to help build it.