Skip to documentation
DOCUMENTATIONAuthentication
BUILD AN INTEGRATION

Authentication

Use private account credentials from a server or trusted backend.

Three access modes

The local service defaults to anonymous loopback access at 127.0.0.1:8787, with 60 requests per remote address per rolling minute. MARKET_DATA_API_KEY enables optional single-key testing. Account-backed mode uses MARKET_DATA_DATABASE_URL, active account keys, plan quotas and usage diagnostics. Hosted ingress requires account-backed configuration.

Public /v1/plans, /openapi.json, /postman/collection.json, /healthz and /readyz do not require an API key when the runtime is configured. The reference business routes require bearer keys in account-backed mode. Browser cross-origin requests are not enabled; use your backend.

Key lifecycle

Keys are returned once; only SHA-256 hashes are stored. Keep keys out of browser code, URLs, screenshots, logs and repositories. pk_test_ and pk_live_ are operator labels: both read the same real source and share an account allowance.

To rotate, issue a replacement, update your server, verify a read, then revoke the old key. Revocation blocks subsequent admission; a previously admitted read can finish. Honor configured expiry. Owner-issued shop API keys are a separate credential product and grant no Market Data API access.

Workspace and receipt access

Workspace /api/v1 routes use a staff session or scoped shop key. Market account keys grant no shop-record access. Entitled POS market requests use a server-only database-bound reservation receipt; a browser never receives the relay secret. The optional x-market-lookup-id binds retries to the same reservation; without it the POS route creates a new lookup identity. An undispatched receipt may be renewed, but a dispatched receipt cannot be reused. Source results are not stored for replay. The relay protocol is internal and does not expand the public bearer API.

Explore the wire contract.

API reference