find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/farcaster-user-data-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Farcaster Snapchain Hub HTTP User Data API
  description: HTTP query interface for Farcaster's Snapchain network. Read casts, reactions, follows, user data, verifications and on-chain events by FID; submit signed protobuf messages; and stream hub events. The public reference endpoint is hosted at https://snapchain.farcaster.xyz, but operators typically run their own Snapchain node and bind the HTTP server to a local port (default 3381).
  version: 1.0.0
  contact:
    name: Farcaster
    url: https://snapchain.farcaster.xyz/
  license:
    name: MIT
servers:
- url: https://snapchain.farcaster.xyz
  description: Public Snapchain reference endpoint
- url: http://127.0.0.1:3381
  description: Default local Snapchain HTTP server
tags:
- name: User Data
paths:
  /v1/userDataByFid:
    get:
      tags:
      - User Data
      summary: List user data records for a FID
      parameters:
      - $ref: '#/components/parameters/Fid'
      - in: query
        name: user_data_type
        schema:
          type: string
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageToken'
      - $ref: '#/components/parameters/Reverse'
      responses:
        '200':
          description: Page of user data
      operationId: getV1UserDataByFid
      x-operation-id-source: derived
  /v1/storageLimitsByFid:
    get:
      tags:
      - User Data
      summary: Get storage limits for a FID
      parameters:
      - $ref: '#/components/parameters/Fid'
      responses:
        '200':
          description: Storage limit info
      operationId: getV1StorageLimitsByFid
      x-operation-id-source: derived
  /v1/userNameProofByName:
    get:
      tags:
      - User Data
      summary: Resolve a username proof by name
      parameters:
      - in: query
        name: name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Username proof
      operationId: getV1UserNameProofByName
      x-operation-id-source: derived
  /v1/userNameProofsByFid:
    get:
      tags:
      - User Data
      summary: List username proofs for a FID
      parameters:
      - $ref: '#/components/parameters/Fid'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/PageToken'
      - $ref: '#/components/parameters/Reverse'
      responses:
        '200':
          description: Page of username proofs
      operationId: getV1UserNameProofsByFid
      x-operation-id-source: derived
components:
  parameters:
    PageSize:
      in: query
      name: pageSize
      schema:
        type: integer
    Reverse:
      in: query
      name: reverse
      schema:
        type: boolean
    PageToken:
      in: query
      name: pageToken
      schema:
        type: string
    Fid:
      in: query
      name: fid
      required: true
      schema:
        type: integer
      description: Farcaster ID