Skip to content

Getting Started

API playground

Source: hypersnap-docs-web/src/playground.mdLast synced: May 20, 2026

API playground #

Run real requests against a Hypersnap node without leaving this page. Every "Try it" panel in the docs uses the same machinery you see here — this page just collects one example per endpoint family in one place.

How it works #

  • Host. The panels default to https://haatz.quilibrium.com, the public node. Change the Host field on any panel and it's remembered for the rest of your session.
  • FID. Signed endpoints need to know which FID you're acting as. Set it once in the host bar and every signed panel picks it up.
  • Wallet. The Connect wallet button talks to any EIP-1193 provider: MetaMask, Frame, Rabby, a Ledger via Frame, or the wallet embedded in a Farcaster client if you've loaded this page as a mini app. Signed requests use eth_signTypedData_v4 — the library never sees your private key. Nothing is sent anywhere except directly to the node you configured.
  • Keccak-256. The requestHash field inside the EIP-712 payload is computed locally with a vendored pure-JS Keccak-256 (self-tested at load time). There is no external JS dependency loaded at runtime.

Everything happens in your browser. The docs are a static site. "Connect wallet" opens your wallet extension directly. "Run" issues a fetch from your browser to the configured Hypersnap host. The docs site is never in the middle and never sees your keys, signatures, or responses.

Public reads — no wallet needed #

User lookup #

Cast by hash #

Following feed #

Signed management — wallet required #

These are the endpoints your custody key signs for. Click Connect wallet once, set your FID in the host bar, and every panel below will sign + submit when you click Run.

Create a webhook #

List your webhooks #

Rotate a webhook signing secret #

Delete a webhook #

Register a mini app #

List your mini apps #

Rotate mini-app send secret #

Send a notification — per-app x-api-key #

This endpoint authenticates with your mini app's send_secret, not your custody key. Paste the secret directly into the x-api-key field below — nothing is persisted, nothing is sent anywhere except to the Hypersnap host you configured.

Be careful pasting production secrets into a web page. For development + testing it's fine; for production sends, call the endpoint from your own backend.

Running as a mini app #

The docs themselves can run inside a Farcaster client as a mini app. When loaded that way, Connect wallet talks to the client's embedded wallet via the Farcaster mini-app SDK, and your FID is already known. See Run as a mini app for the one-line manifest that makes this work.

Troubleshooting #

  • "No Ethereum provider found" — install a wallet extension (MetaMask / Frame / Rabby) or open the page inside a Farcaster client.
  • 401 signature mismatch — your FID's custody address on-chain doesn't match the key you just signed with. Check your wallet is on the right account.
  • 401 clock skew too large — your device clock is off. Fix the clock and retry.
  • 403 not the owner — you're trying to look up or mutate a webhook/app owned by a different FID. Set the FID that owns the resource, or create your own.
  • 429 — you hit the per-FID cap (default 25 webhooks / 25 mini apps). Delete something or ask your operator to raise the cap.
  • Browser CORS error — the host you configured either isn't CORS-enabled or isn't a Hypersnap node. haatz.quilibrium.com is CORS-open for all documented routes.

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

Edit on GitHub