API documentation
Getting started
Platform overview
Obermind Platform combines branded web and mobile apps, a multi-tab trading terminal, portfolio and risk tooling, and admin back-office on one platform. API docs on this site describe how your integration connects to those surfaces — not a separate product.
Environments
Use the development environment while building and testing integrations. Production credentials and base URLs are issued when your deployment goes live. Code samples default to the development API host unless your firm configures another endpoint.
Authentication
The REST API supports two credential styles. End users create a personal access token in the signed-in app under Developers, then send it as Authorization Bearer om_pat_…. Firm and partner integrations may instead use application credentials — App Token and Secret Key — issued by Obermind operations for your deployment (Admin → External apps). Application credentials are not shown to end users in the app. Store every secret securely; never embed them in client-side code shipped to browsers. Use the Try It panel on each endpoint to test with credentials from this browser session only.
User interfaces
Traders interact through the Terminal, Instrument pages, and mobile apps. Your integration typically runs server-to-server against the REST API, while WebSocket feeds power live quotes and portfolio updates inside those UIs.
