Reference
API reference
Every endpoint across the Hyperscaled API — 89+ routes spanning auth, KYC, payments, payouts, trading, webhooks, admin, and the legacy partner-key surface. Search, copy a cURL, and run reads live.
Run reads without leaving the page
89 endpoints
Meta & health
Liveness, version, and the machine-readable OpenAPI spec.
OAuth
Exchange app client credentials for a bearer token.
Apps (tenant self-service)
Read and manage your own tenant app credentials.
Authentication (end users)
Sign up, verify, log in, reset passwords, and manage user MFA.
KYC / Identity
Verify a trader's identity with Sumsub or Stripe Identity.
Payments & accounts
Sell challenges with Stripe and provision funded prop accounts.
Stripe Connect
Onboard payees via Stripe Express to receive payouts.
Payouts
Read what a trader has earned and what has been paid. Disbursement is platform-only.
API keys
Per-trader credentials for programmatic trading: X-Api-Key: <key_id>.<key_secret> authenticates the /v2/trading surface on its own.
Webhooks (outbound)
Register endpoints to receive signed, real-time events.
Webhooks (inbound receivers)
Provider-signed receivers the platform exposes for Stripe and Sumsub.
Agreements
Capture and audit trader agreement signatures.
Lifecycle
Sync funded-account status from the validator.
Notifications
Send transactional email and fan out webhook events.
Trading
Submit orders, manage positions, and read the live desk. Session (bearer + X-Session-Token) or a per-trader X-Api-Key both authenticate here.
Admin
Operator endpoints for managing tenant apps (admin auth + TOTP).
Legacy v1 (partner-key API)
The original partner-key surface. Uses static partner API keys and a Trader-ID header instead of OAuth + sessions. Prefer the v2 endpoints above for new integrations.