How it works
Your trader signs in to your app, your server creates a Connect link for them, your page opens hosted Connect with it, and the trader connects an account or opens your white-label paper. From then on your server reads that trader’s accounts and routes their orders, with your API key and your own id for the trader. Every credential the trader types goes from hosted Connect straight to trdrs, where it’s kept encrypted, and your API key stays on your server.The words
The journey
- Get your API key. Create your app and an API key for your backend. A new app starts in the sandbox, where it’s free. Connect quickstart
- Add your website. Register the exact origin of the page that opens Connect. Connect quickstart
- Create a Connect link. When a signed-in trader asks to connect, your server creates a Connect link for them. Connect SDK
- Open hosted Connect. Your page opens Connect with the link. The trader picks a venue’s or a provider’s tile and connects an account, or opens your white-label paper and holds a Demo. Connect SDK and Tiles and white-label paper
- Read and route. Your server reads that trader’s accounts, account data and market data, and routes the orders they place, with your API key and their id. Route your traders’ orders
- Pass conformance and open production. A graded run in the sandbox checks the whole journey, and a passed run earns a Connect pass. With the Connect terms accepted and a card saved, an owner opens your app’s production with the pass: production API keys, and websites that apply at once. Pass conformance and Billing
- Pay per active trader. Connect is billed at $2 for each active trader each month, charged to your card in production, from the month an owner accepts the terms. The sandbox is free. Active traders
What your traders see
Hosted Connect opens straight on your tiles: your white-label paper first while you offer it, then the venues and providers you switched on, in your app’s order. The trader picks a venue’s or a provider’s tile, and the login style of the provider it opens decides what comes next.
Providers lists each provider’s login style. The accounts a trader connects belong to
them as your trader, apart from any trdrs account the same person holds and from every other app’s
traders.
Follow three rules
- Keep the API key on your server. It reads and routes for every one of your traders. Don’t put it in browser code, a mobile app or a public repository.
- Name the trader from your own sign-in. Your server vouches for the trader when it creates a Connect link and when it routes their orders, so never take the id from the browser.
- Route only what the trader asks for. Every order is the trader’s own: they place it on your screen, on their own account, and your backend carries it to trdrs.
Sandbox and production
Your app starts in the sandbox, where Connect is free and your API keys starttrdrs_ck_sandbox_. A
passed conformance run earns your app’s Connect pass, and with its billing set up, an owner opens
your app’s production with the pass. Production API keys start trdrs_ck_production_, and each
month’s invoice charges your card $2 for each active trader.
Pre-registration and evaluation accounts belong to venues. A prop firm or brokerage pre-registers an
account in Connect for a trader who signs in to trdrs, and runs evaluation accounts with groups,
stages and risk policies, as Prop firms covers. Your traders sign in to
your app, so your app uses neither.
The API
Your backend calls the Connect API with your app’s API key, and your team runs everything else from the Connect dashboard. These are the routes, the header and the key format each step uses:
Your API key reaches the Connect link routes and the trader routes, for your own traders.
Next steps
Connect quickstart
Get an API key and route a test trader’s first order, end to end in the sandbox.
Connect SDK
Open hosted Connect on your page, and hear how it ends.
Route your traders' orders
Read a trader’s accounts and route the orders they place in your interface.
Pass conformance
Run your app’s whole journey through the graded sandbox check.