$PRIVY is live -

Skip to content
Docs

Developers

Authentication

Authenticate requests with an API key in the X-API-Key header.

Public endpoints (tokens, quotes and stats) work without a key. Account endpoints require one. Sending a key on a public request is optional and gives it the higher per-key rate limit.

Pass the key in the X-API-Key header. Keys in query strings are rejected, so they never end up in logs or browser history.

HTTP
GET /api/v1/me HTTP/1.1
Host: privy.ac
X-API-Key: pvy_live_...

Key format

Keys start with pvy_live_ followed by 43 random characters. Privy stores only a SHA-256 hash, so a lost key cannot be recovered; rotate it instead.

Scopes

ScopeGrants
read:publicTokens, quotes and platform stats.
read:accountYour account, holdings, positions, activity, points and trades.

Authentication errors

StatusCodeMeaning
401MISSING_API_KEYAn account endpoint was called without a key.
401INVALID_API_KEYThe key is malformed, unknown or revoked.
403INSUFFICIENT_SCOPEThe key lacks the scope the endpoint needs.