Farcaster website screenshot

Farcaster

Farcaster is a decentralised social protocol built on Snapchain, an append-only state machine that stores casts, reactions, follows, and user profile data. The protocol publishes a Hub / Snapchain reference implementation, the Mini Apps SDK (formerly Frames) for distributing interactive apps inside Farcaster feeds, Sign In with Farcaster (SIWF) for authentication, and AuthKit for React-based sign-in. The Warpcast client (now rebranded Farcaster app at farcaster.xyz) is the primary consumer surface. Indexer providers such as Neynar host scaled Hub APIs and value-added read / write / webhook APIs at api.neynar.com.

6 APIs 0 Features
SocialDecentralizedProtocolMini AppsFramesAuthenticationWeb3SDKs

APIs

Snapchain / Hub API

Query interface for Farcaster's Snapchain network - read casts, reactions, follows, user data, and verifications by FID; submit signed messages; and run a Snapchain node for ful...

Farcaster Mini Apps SDK

JavaScript SDK for building Mini Apps (the evolution of Frames) that run inside Farcaster feeds and clients. Provides host bridge, context, wallet actions, notifications, and an...

Sign In with Farcaster (SIWF)

Authentication flow that lets users sign in to third-party apps with their Farcaster identity, returning a verified FID and optional profile data. Backed by EIP-4361-style signe...

Farcaster AuthKit (React)

React toolkit wrapping Sign In with Farcaster - provides hooks and components for the QR-code / deep-link handoff to a Farcaster client and returns the verified user context to ...

Neynar Hosted Farcaster API

Third-party indexer providing hosted Hub access, indexed read APIs (users, casts, channels, feeds), write APIs (publish casts, reactions, follows), webhooks for real-time events...

Warpcast / Farcaster Client API

Client-side API exposed by the Warpcast / Farcaster app for client-specific surfaces (channels, mentions, direct casts, mini-app contexts) layered above the Snapchain protocol A...

Collections

Farcaster Snapchain Hub HTTP API

OPEN

GraphQL

Farcaster GraphQL Schema

title: Farcaster GraphQL Schema

GRAPHQL

Pricing Plans

Farcaster Plans Pricing

1 plans

PLANS

Rate Limits

Farcaster Rate Limits

2 limits

RATE LIMITS

FinOps

Farcaster Finops

FINOPS

Resources

🔗
Website
Website
🔗
Documentation
Documentation
🔗
Mini Apps
Mini Apps
🔗
Snapchain
Snapchain
👥
GitHub
GitHub
🔗
Neynar
Neynar

Sources

apis.yml Raw ↑ 
opencollection: 1.0.0
info:
  name: Farcaster Snapchain Hub HTTP API
  version: 1.0.0
items:
- info:
    name: Info
    type: folder
  items:
  - info:
      name: Get hub info
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/info
      params:
      - name: dbstats
        value: ''
        type: query
    docs: Get hub info
  - info:
      name: List FIDs known by the hub
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/fids
      params:
      - name: shard_id
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List FIDs known by the hub
- info:
    name: Casts
    type: folder
  items:
  - info:
      name: Get a cast by FID and hash
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/castById
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: hash
        value: ''
        type: query
    docs: Get a cast by FID and hash
  - info:
      name: List casts authored by a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/castsByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
      - name: startTimestamp
        value: ''
        type: query
      - name: stopTimestamp
        value: ''
        type: query
    docs: List casts authored by a FID
  - info:
      name: List casts that reply to a given parent
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/castsByParent
      params:
      - name: fid
        value: ''
        type: query
      - name: hash
        value: ''
        type: query
      - name: url
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List casts that reply to a given parent
  - info:
      name: List casts mentioning a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/castsByMention
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List casts mentioning a FID
- info:
    name: Reactions
    type: folder
  items:
  - info:
      name: Get a reaction by FID and target
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/reactionById
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: target_fid
        value: ''
        type: query
      - name: target_hash
        value: ''
        type: query
      - name: reaction_type
        value: ''
        type: query
    docs: Get a reaction by FID and target
  - info:
      name: List reactions authored by a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/reactionsByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: reaction_type
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List reactions authored by a FID
  - info:
      name: List reactions targeting a cast
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/reactionsByCast
      params:
      - name: target_fid
        value: ''
        type: query
      - name: target_hash
        value: ''
        type: query
      - name: reaction_type
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List reactions targeting a cast
  - info:
      name: List reactions targeting a URL
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/reactionsByTarget
      params:
      - name: url
        value: ''
        type: query
      - name: reaction_type
        value: ''
        type: query
    docs: List reactions targeting a URL
- info:
    name: Links
    type: folder
  items:
  - info:
      name: Get a link (follow) by FID and target
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/linkById
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: target_fid
        value: ''
        type: query
      - name: link_type
        value: ''
        type: query
    docs: Get a link (follow) by FID and target
  - info:
      name: List links authored by a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/linksByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: link_type
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List links authored by a FID
  - info:
      name: List links targeting a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/linksByTargetFid
      params:
      - name: target_fid
        value: ''
        type: query
      - name: link_type
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List links targeting a FID
- info:
    name: UserData
    type: folder
  items:
  - info:
      name: List user data records for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/userDataByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: user_data_type
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List user data records for a FID
  - info:
      name: Get storage limits for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/storageLimitsByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
    docs: Get storage limits for a FID
  - info:
      name: Resolve a username proof by name
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/userNameProofByName
      params:
      - name: name
        value: ''
        type: query
    docs: Resolve a username proof by name
  - info:
      name: List username proofs for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/userNameProofsByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List username proofs for a FID
- info:
    name: Verifications
    type: folder
  items:
  - info:
      name: List verifications for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/verificationsByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: address
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List verifications for a FID
- info:
    name: OnChain
    type: folder
  items:
  - info:
      name: List on-chain signers for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/onChainSignersByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: signer
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List on-chain signers for a FID
  - info:
      name: List on-chain events for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/onChainEventsByFid
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: event_type
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: List on-chain events for a FID
  - info:
      name: Lookup the IdRegistry event for a wallet address
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/onChainIdRegistryEventByAddress
      params:
      - name: address
        value: ''
        type: query
    docs: Lookup the IdRegistry event for a wallet address
  - info:
      name: Get the address type for a FID
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/fidAddressType
      params:
      - name: fid
        value: ''
        type: query
        description: Farcaster ID
      - name: address
        value: ''
        type: query
    docs: Get the address type for a FID
- info:
    name: Events
    type: folder
  items:
  - info:
      name: Stream hub events
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/events
      params:
      - name: from_event_id
        value: ''
        type: query
      - name: shard_index
        value: ''
        type: query
      - name: stop_id
        value: ''
        type: query
      - name: pageSize
        value: ''
        type: query
      - name: pageToken
        value: ''
        type: query
      - name: reverse
        value: ''
        type: query
    docs: Stream hub events
  - info:
      name: Get a hub event by id
      type: http
    http:
      method: GET
      url: https://snapchain.farcaster.xyz/v1/eventById
      params:
      - name: event_id
        value: ''
        type: query
      - name: shard_index
        value: ''
        type: query
    docs: Get a hub event by id
- info:
    name: Submit
    type: folder
  items:
  - info:
      name: Submit a signed protobuf message to the hub
      type: http
    http:
      method: POST
      url: https://snapchain.farcaster.xyz/v1/submitMessage
    docs: Submit a signed protobuf message to the hub
  - info:
      name: Submit a batch of signed protobuf messages
      type: http
    http:
      method: POST
      url: https://snapchain.farcaster.xyz/v1/submitBulkMessages
    docs: Submit a batch of signed protobuf messages
  - info:
      name: Validate a signed protobuf message without writing
      type: http
    http:
      method: POST
      url: https://snapchain.farcaster.xyz/v1/validateMessage
    docs: Validate a signed protobuf message without writing
bundled: true