Skip to main content
The hosted PolyOrderbooks API (api.polyorderbooks.com) authenticates data requests with API keys. Keys are tied to your account plan and usage limits.

​
Get an API key

  1. Create an account.
  2. Verify your email (required for password sign-ups).
  3. Open the dashboard → API keys → Create key.
  4. Copy the secret when shown — you will not see it again.
Keys are prefixed with pob_. Store them in a secrets manager or environment variable — never in client-side code or public repositories.

​
Send your key

Recommended header:
Alternative (same key format):
Dashboard JWTs are not API keys. Session tokens from login/signup work only for dashboard routes (/v1/auth/me, /v1/account/*). They are rejected on /v1/markets, history endpoints, and /v1/usage.

​
Example request

​
Protected routes

All /v1 discovery and history endpoints require a valid API key. Send X-API-Key: pob_… or Authorization: Bearer pob_… on every data request.

​
Security requirements

​
Error responses

Application validation errors use error + message — see Error handling.

​
Interactive playground

On endpoint Try panels in this documentation:
  1. Select the Production server (https://api.polyorderbooks.com).
  2. Add header X-API-Key with your pob_… secret.
  3. Mintlify stores the key in your browser session only — it is not sent to our servers.

​
Local development

When running the API locally with auth disabled, data routes are open without a key. Production behavior described here applies to the hosted API only.