Get account details
Retrieve account information for a specific user — balance, equity, leverage, status, and other profile details.
{ "user_id": "<Account No>", "pwd": "", "supervisor_id": "900003", "supervisor_pwd": "<your password>", "supervisor_type": "ADMIN" }
| Name | Type | Description | Required |
|---|---|---|---|
| user_id | string | The account number of the user. | Yes |
| pwd | string | Leave empty. | Yes |
| supervisor_id | string | ID of the supervising ADMIN. | Yes |
| supervisor_pwd | string | Password of the supervising ADMIN. | Yes |
| supervisor_type | string | Type of supervisor (e.g. ADMIN). | Yes |
Get transactions
Retrieve all deposit and withdrawal transactions for a user within a given date range, or filter to a specific transaction ID.
{ "from_dt": "YYYY-MM-DD HH:MM:SS", "to_dt": "YYYY-MM-DD HH:MM:SS", "user_id": "<Account No>", "trans_id": "", "comment": "test", "supervisor_id": "900003", "supervisor_pwd": "<your password>", "supervisor_type": "ADMIN" }
| Name | Type | Description | Required |
|---|---|---|---|
| from_dt | string | Start of search range (YYYY-MM-DD HH:MM:SS). | Yes |
| to_dt | string | End of search range (YYYY-MM-DD HH:MM:SS). | Yes |
| user_id | string | Account number of the user. | Yes |
| trans_id | string | Specific transaction ID; leave empty to return all in range. | Yes |
| comment | string | Free-form comment for the request. | Yes |
| supervisor_id | string | ID of the supervising ADMIN. | Yes |
| supervisor_pwd | string | Password of the supervising ADMIN. | Yes |
| supervisor_type | string | Type of supervisor (e.g. ADMIN). | Yes |
trans_id, type (deposit / withdrawal), amount, datetime, and status.Get open positions
Retrieve all open trading positions for a user, with optional filters by side, symbol, position ID, volume, and group.
{ "from_dt": "YYYY-MM-DD HH:MM:SS", "to_dt": "YYYY-MM-DD HH:MM:SS", "user_id": "<Account No>", "volume": 0.0, "side": "BUY | SELL | (empty for both)", "position_id": "", "symbol": "", "supervisor_id": "900003", "supervisor_pwd": "<your password>", "supervisor_type": "ADMIN", "group_id": "" }
| Name | Type | Description | Required |
|---|---|---|---|
| from_dt | string | Start of search range. | Yes |
| to_dt | string | End of search range. | Yes |
| user_id | string | Account number of the user. | Yes |
| volume | number | Filter by volume; 0.0 returns all. | Yes |
| side | string | BUY, SELL, or empty for both. | Yes |
| position_id | string | Specific position ID; empty for all. | Yes |
| symbol | string | Specific instrument; empty for all. | Yes |
| supervisor_id | string | ID of the supervising ADMIN. | Yes |
| supervisor_pwd | string | Password of the supervising ADMIN. | Yes |
| supervisor_type | string | Type of supervisor (e.g. ADMIN). | Yes |
| group_id | string | Filter by group; empty for all. | Yes |
position_id, symbol, side, volume, open price, current price, and floating P&L.Create account
Create a new user account on the platform. Returns the assigned account number plus the full profile.
{ "ADMIN_id": "900001", "group_id": "1000002", "api_pwd": "A%123456a", "pwd": "A%123456a", "investor_pwd": "investor@123", "balance": "0", "blocked": "0", "enableTrading": "1", "enableAlgoTrading": "1", "showRegularADMIN": 0, "includeServerReports": "0", "enableDailyReports": "1", "enableApiConnections": "1", "limitTotalValue": "0", "limitTotalOrders": "1000", "language": "en", "acct_mode": "1", "first_name": "Aman", "last_name": "Kumar", "type": "USER", "status": "Incomplete", "kyc_status": "Not Approved", "group": "RawSpread", "country": "India", "currency": "USD", "email": "[email protected]", "leverage": "500", "supervisor_id": "900003", "supervisor_pwd": "<your password>", "supervisor_type": "ADMIN" }
| Name | Type | Description | Required |
|---|---|---|---|
| ADMIN_id | string | ADMIN ID for the account. | Yes |
| group_id | string | Group the account belongs to. | Yes |
| api_pwd | string | API password. | Yes |
| pwd | string | Main account password. | Yes |
| investor_pwd | string | Investor (read-only) password. | Yes |
| balance | string | Initial balance. | Yes |
| blocked | string | 0 = active, 1 = blocked. | Yes |
| enableTrading | string | Enable trading (1/0). | Yes |
| enableAlgoTrading | string | Enable algo trading. | Yes |
| enableApiConnections | string | Allow API connections. | Yes |
| limitTotalOrders | string | Max concurrent open orders. | Yes |
| language | string | UI language (e.g. en). | Yes |
| acct_mode | string | 1 = real, 0 = demo. | Yes |
| first_name | string | First name. | Yes |
| last_name | string | Last name. | Yes |
| type | string | User type (e.g. USER). | Yes |
| status | string | Account status. | Yes |
| kyc_status | string | KYC status. | Yes |
| group | string | Group name (e.g. RawSpread). | Yes |
| country | string | Country. | Yes |
| currency | string | Account currency. | Yes |
| string | User email. | Yes | |
| leverage | string | Account leverage (e.g. 500). | Yes |
| address, city, state, zip_code, phone, company, middle_name, comment | string | Profile fields. | Optional |
| supervisor_id, supervisor_pwd, supervisor_type | string | Auth credentials for the call. | Yes |
Deposit or withdraw funds
Two endpoints with an identical body — /deposit credits funds, /withdraw debits them.
{ "uid": "<Account No>", "fund_amount": "<amount>", "dt": "YYYY-MM-DD HH:MM:SS", "group": "", "name": "", "supervisor_id": "900003", "supervisor_pwd": "<your password>", "supervisor_type": "ADMIN", "fund_type": "BALANCE" }
| Name | Type | Description | Required |
|---|---|---|---|
| uid | string | Account number of the user. | Yes |
| fund_amount | string | Amount to deposit or withdraw. | Yes |
| dt | string | Datetime of the transaction. | Yes |
| group | string | Reserved. | Optional |
| name | string | Reserved. | Optional |
| supervisor_id | string | ID of the supervising ADMIN. | Yes |
| supervisor_pwd | string | Password of the supervising ADMIN. | Yes |
| supervisor_type | string | Type of supervisor. | Yes |
| fund_type | string | Type of fund (e.g. BALANCE). | Yes |
Create a group
Create a new trading group with custom leverage, margin policy, allowed symbols, and risk-management rules.
{ "gname": "<GROUP NAME>", "server": "COMPANY NAME", "gtype": "2", "auth": "1", "otp": "0", "currency": "USD", "digits": 2, "leverage": 500, "margin_call_level": 90, "stop_out_level": 10, "max_orders": 0, "max_symbols": 100, "max_positions": 500, "min_password_length": 8, "available_history": 1, "interest_rate": 0, "enable_swaps": 0, "enable_hedge": 0, "enable_expert_Advisors": 0, "trading_signals": 1, "transfer_funds": 1, "push_notifications": "1", "daily_fixed_profit": "use unrealized profit/loss", "unrealized_profit": "use unrealized profit/loss", "level_in": "%", "admin_id": "100001", "ADMIN_id": "900003", "groupSuffix": "<SUFFIX>" }
| Name | Type | Description | Required |
|---|---|---|---|
| gname | string | Name of the new group. | Yes |
| server | string | Server / company name the group lives on. | Yes |
| gtype | string | Group type identifier. | Yes |
| auth, otp | string | Auth and OTP toggles. | Yes |
| currency | string | Default currency (e.g. USD). | Yes |
| digits | number | Price digits for symbols. | Yes |
| leverage | number | Group-wide leverage. | Yes |
| margin_call_level | number | Margin-call threshold (%). | Yes |
| stop_out_level | number | Stop-out threshold (%). | Yes |
| max_orders, max_symbols, max_positions | number | Per-account caps. | Yes |
| enable_swaps, enable_hedge, enable_expert_Advisors | number | Feature toggles (0 / 1). | Yes |
| compensate_negative_balance, stop_out_fully_hedged, virtual_credit | number | Risk-management toggles. | Yes |
| trading_signals, transfer_funds | number | Allow signals / transfers. | Yes |
| min_password_length, force_otp_usage | number | Security policy. | Yes |
| change_password_at_first_login | number | Force first-login password reset. | Yes |
| level_in | string | Level indicator unit (e.g. %). | Yes |
| admin_id, ADMIN_id | string | Owning admin / ADMIN. | Yes |
| groupSuffix | string | Symbol suffix appended for this group. | Yes |
| company, withdrawal_url, deposit_url, support_email, symbols, margin_risk_management, floating_leverage_profile, template_folder | string | Optional overrides. | Optional |
group_id and a status flag.