API Clients
API clients authenticate applications to a HappyView instance by including a client key in every XRPC request, even for unauthenticated queries.

HappyView builds an AT Protocol AppView generating schema-derived XRPC routes, storage, and indexing from uploaded lexicons.
happyview.devCrawled Nov 2, 2026
API clients authenticate applications to a HappyView instance by including a client key in every XRPC request, even for unauthenticated queries.
HappyView has two distinct authentication surfaces:
HappyView is configured via environment variables. A .env file in the project root is loaded automatically on startup. See Local Development for local setup, Docker for deploying from published images, or Production for the hardening checklist.
HappyView ships with a web dashboard that provides a visual interface for everything the admin API offers. It runs as a separate Next.js application alongside the Rust backend and authenticates via atproto OAuth.
Linked repos grant AppView durable write access to a specific atproto repository, allowing Lua scripts to interact with them as service accounts or partner repos.
An atproto service identity enables AppView to authenticate with other network services, as the user’s PDS verifies the destination by resolving the AppView’s DID.
HappyView indexes new records from a lexicon immediately via Jetstream, while backfill retrieves existing records by discovering repos through the relay and fetching them directly from users’ PDS.
Background jobs allow long-running Lua scripts to execute outside the request cycle, queued via `jobs.create()` and processed by a dedicated worker for tasks like data migrations or API syncs.
Project updates, release notes, and feature announcements.
HappyView uses lexicons—atproto schema definitions—to define data models and determine which records to index from the network and which XRPC endpoints to serve.
v2 consolidates HappyView, Tap, and AIP into a single binary. Real-time indexing, backfill, and OAuth are now built in — there are no companion services to deploy.
Statusphere is an example atproto application where users set their current status as a single emoji. It's a great way to learn how HappyView works because the data model is simple but the queries are interesting.