Concepts & data model
Organizations, traders, account types, rule sets, credits — the words this API uses and what they mean here.
Six words do most of the work in this API. They are worth five minutes if you are new to the platform, because two of them do not mean what they might elsewhere.
Organization
Your firm — the tenant. It owns its branding, its account types, its rule sets, its traders and its accounts. Every API key belongs to exactly one, and can never see another. You are our customer; your traders are not.
Trader
A record, not a login. A name and an email you create so an account and its credentials have somewhere to hang. A trader has no account with us, no password, no dashboard and no way in — creating one sends no email and grants nothing.
Everything real about your traders — finding them, vetting them, charging them, paying them out — happens in your systems, not ours.
Account type
The challenge you sell: a name, a starting balance, an informational price, and the rule set it points at. “$10K Standard” is an account type. You provision trading accounts against one.
Rule set & version
The criteria an account is judged by — daily drawdown, maximum drawdown, profit target, minimum trading days, plus whatever else you build in the rule builder. Several account types can share one rule set.
Versions are frozen, and that is load-bearing
Editing a rule set creates a new version; it never changes an existing one. A trading account freezes the version current at the moment it was created and is judged by that version for the rest of its life.
So tightening your rules today cannot retroactively breach an account somebody bought last month — which is exactly what you want, and worth knowing before you go looking for an endpoint to change an existing account’s rules. There isn’t one.
Trading account
One simulated account. Provisioned against an account type, frozen to a rule set version, identified by an 8-digit number, and unassigned by default — most firms provision a batch and hand them out as traders arrive. Its trader can be changed later; its number and server cannot.
| status | Means |
|---|---|
active | Trading, within its rules. |
breached | A rule was violated. status_reason says which, with the numbers. |
passed | Hit its profit target and satisfied every other objective. |
archived | Taken out of circulation by you. History stays readable. |
Account credits
A permanent pool. Your plan grants a number of them, packs and upgrades add more, and nothing expires. Creating a trading account spends one forever — breaching or archiving it returns nothing.
remaining = granted − used. See limits for what happens at zero.
Executor credentials
The Account Number, Server and Password a trader types into the terminal — the same three fields any trading platform asks for. You generate them, you hand them over, and you rotate the password when an account changes hands. Details.