Step 1: Obtain the development API key
To start integrating with TradeLocker Brand API, you need to obtain a development API key and a unique server name (6-8 characters).
You can request it by submitting a ticket to our team here.
IMPORTANT: In the meantime, please fill out the Onboarding Sheet sent to you by the sales team. Send it to us by submitting a ticket titled “Your company name – Onboarding”. All onboarding conversations will be held via the Customer Support Portal.
Groups setup in the Onboarding sheet
Provide a list of desired user groups for the API setup.
- Groups should align with challenges/stages (e.g., with/without commission, swaps, 1-step, 2-step, challenge accounts, funded accounts etc.).
Note: If you would like to have the same challenge with a different configuration (e.g. with or without the commission), create multiple groups for one challenge step (e.g. with swaps, no-swaps, etc..)
- You can modify groups later as needed.
- Submit this to TradeLocker to receive:
- Development API key to develop integration between your CRM and our API.
- Note: If you are using some 3rd party CRM that is already integrated with TradeLocker you can skip directly to production (step 3).
- Server name needed for user login to TradeLocker.
- Development API key to develop integration between your CRM and our API.
After assessing your needs, we will issue your development API key to begin the development trial phase.
Step 2: Development phase
During development, we’ll set up default configurations with custom leverages, commissions, and swaps. We’ll also create custom user groups for testing account creation at different challenge phases.
The main goal of this stage is for you to test the integration between your CRM and TradeLocker API, focusing on user creation, account management, funding, data retrieval, and similar processes.
- Funded accountDepending on your setup for funded challenges, you’ll use demo.tradelocker.com by default. If you want funded accounts on live.tradelocker.com, you’ll need two clusters with different setups. Both can be managed through one API key but will have separate back offices.
Development
Review all TradeLocker API documentation here.
Environments
TradeLocker has multiple environments:
- DEV → used during initial integration to test the API.
- PRODUCTION → used when you get the production API key
Clusters
- DEMO → used mostly for prop and demo accounts.
- LIVE → used for accounts with real funds.
- Some props with real capital have their funded accounts on LIVE, though most use DEMO for easier configuration and maintenance.
All requests to the Brand API need to have brand-api-key in the header with the provided API token.
Note: Tokens for development and production will be different!
During development:
- Use the api-dev.tradelocker.com API endpoint.
- All endpoints support only LIVE as the type.
In production:
- You will switch to api.tradelocker.com.
- Use DEMO or LIVE as the type depending on the account type you support.
Use DEMO for prop accounts and LIVE for funded accounts (optionally).
Minimal flow
- Step 1: Create User
- Endpoint: Create user.
- Generate user credentials (email and password).
- Step 2: Create Account
- Endpoint: Create account.
- One user can have multiple accounts. Assign accounts to user groups to inherit group rules (leverage, commissions, swaps, etc.).
- Each Account ID will have a prefix
D#
orL#
depending on if the account is DEMO or LIVE.
- Implement account creation with
Idempotency-key
to prevent duplicate accounts.
- Step 3: Deposit funds to account
- Deposit funds in the account’s currency.
- Also use
Idempotency-key
- Step 4: Test trading access
- URL:
https://stg.tradelocker.com
- Log in using the credentials from Step 1.
- URL:
- Step 5: Track equity changes
- Endpoint: Account statement report.
- Fetch balance, equity, and P&L data for all your accounts.
- At midnight, save values so you can compare them with other values throughout the day to determine if somebody breached the account
- Step 6: How to handle breached (failed) accounts
-
- Suspend or restrict accounts upon breach.
- Close all positions and cancel active orders:
-
Step 3: Launching to production
Before going to production the desired setup should be configured on the back office.
- You can request access to the back office to manage the setup.
- Make sure to check the following values across user groups before launching.
- Leverage plans
- Commission plans
- Spread
- Swap
- Instrument Lot size
- You can check all these values by right-clicking on an instrument within the TradeLocker platform and selecting View details.
Switch to Production
- API Endpoint:
https://api.tradelocker.com
. - Account Types:
- DEMO: For prop accounts.
- LIVE: For funded accounts.
Good to know
Raising emergencies
TradeLocker offers 24/7 on-call support. To reach them on the ticketing portal, select critical ticket type. That type of ticket will trigger our on-call. Misuse of this option for non-critical issues may result in a charge.
Important to know
- API requests are subject to rate limits.
Billing
⚠️ TradeLocker determines your monthly fees based on the number of active accounts.
An account is considered active if it meets any of the following criteria during the billing month:
- The account was created.
- A session was initiated (the account connected to the platform).
- The account had open positions.
- The account had active orders.
When your client fails a challenge you can either:
- Restrict account: This means the user will be able to log in and close any open positions or cancel orders. That might cause you to have to pay for those accounts next month if the user continues using the restricted account.
- Suspend account: The user won’t be able to log in and this account won’t be visible to them anymore, and you won’t get charged for that account next month.
Other than suspending the account, the following actions are crucial to ensure the account is marked as inactive after suspension, so it doesn’t get included in the next billing cycle:
Please note that billing will begin from the moment the production API key is sent.
Learn more about how to reduce monthly fees with the API.
Step 4: Promote the integration
Great job with completing the technical integration with TradeLocker.
Now, it’s time to let the world know the integration is ready.
- Add your challenges to TradeLocker Hub. It’s one of the largest online forex ecosystems and it attracts hundreds of thousands of traders each month. Here’s how to present your company there: How to manage your profile on TradeLocker Hub.
- Forward the link to this page to the marketing team, it’s time for the last step: Announce and promote your partnership with TradeLocker.
If you have any questions or require assistance at any point, please don’t hesitate to reach out to our team. We’re here to help you every step of the way.