Skip to main content

Habitat API

Welcome to the Habitat API reference! We are currently under development and our API may make breaking changes without notice. Stay tuned @habitat.network on Bluesky and habitat.leaflet.pub for future formal releases.

Endpoints

At the moment, all endpoints are served over HTTPS at:

https://pear.habitat.network/xrpc/

Authentication

Habitat authenticates apps with the standard AT Protocol OAuth flow — not static bearer tokens.

Your app OAuths with Habitat, and Habitat in turn acts as an OAuth client against the user's own PDS. Because a Habitat-resolved DID document names Habitat as the PDS, a standard atproto OAuth client discovers Habitat's /.well-known/oauth-protected-resource and authorizes against it with no Habitat-specific code.

See Getting started for a working client, and Identities & authentication for how identities, login methods, and service auth fit together.

View the full API reference →