Broker Controls
Provision users, assign groups, adjust leverage, and inspect exposure from a dedicated management plane.
Broker-grade MT4 management interface for users, groups, balances, instruments, and server-side administrative workflows.
Provision users, assign groups, adjust leverage, and inspect exposure from a dedicated management plane.
Run deposits, withdrawals, credits, and audit-friendly corrections from back-office automations.
Keep onboarding, KYC, and support tooling aligned with broker account state.
Use Manager credentials with narrowed operational scope, then create a dedicated service account for automation jobs.
For safety, segment provisioning, funding, and reporting flows into different workers and credentials.
curl -X POST https://api.metatraderapi.xyz/mt4/manager/users \
-H "Authorization: Bearer <manager-key>" \
-H "Content-Type: application/json" \
-d '{
"login": 910024,
"name": "Demo User",
"group": "demo-usd",
"leverage": 100
}'Create, update, disable, and inspect trading users, assign groups, and control read-only access for internal dashboards.
Manager endpoints are designed for deterministic back-office automation rather than low-latency trade execution.
Run deposits, withdrawals, corrections, and promotional credit adjustments with auditable comments and operator context.
Every balance operation should include your own reference id so accounting systems can reconcile results cleanly.
Read symbol settings, map users to group templates, and expose group-level configuration to your CRM or onboarding systems.
Use a dedicated manager credential with the minimum operational scope needed for the workflow you are automating.
Never share the same manager key across provisioning, finance, and reporting workers. Segmented credentials simplify audit and incident response.
| Header | Value | Use | Description |
|---|---|---|---|
| Authorization | Bearer <manager-key> | Required | Broker-grade management credential with scoped permissions. |
| x-operator-id | crm-sync-worker | Recommended | Operator or worker identifier for audit trails. |
| x-request-id | req_balance_0107 | Recommended | Idempotency key for balance or account lifecycle actions. |
| Content-Type | application/json | Write calls | JSON payload content type. |
| Method | Path | Purpose |
|---|---|---|
| POST | /users | Create a trading user and assign the initial group. |
| PATCH | /users/{login} | Update leverage, group, or user metadata. |
| GET | /users/{login} | Read the current account profile. |
| GET | /groups | List broker group templates and permissions. |
| Method | Path | Purpose |
|---|---|---|
| POST | /balances/deposit | Apply a deposit operation to a trading account. |
| POST | /balances/withdraw | Withdraw funds with audit metadata. |
| POST | /balances/credit | Add or adjust broker credit. |
| GET | /balances/history | Review prior funding operations. |
| Method | Path | Purpose |
|---|---|---|
| GET | /symbols | Read symbol settings and execution parameters. |
| GET | /reports/exposure | Inspect broker exposure by group or symbol. |
| GET | /reports/users | Export account inventory for CRM sync. |
| POST | /users/{login}/disable | Suspend an account without deleting history. |
Manager actions often mutate financial or compliance-sensitive state. Use a request id on every write and persist the resulting operation identifier.
Operational failures should be surfaced to humans when a workflow crosses compliance or balance thresholds instead of retried blindly.
| Code | Name | Meaning |
|---|---|---|
| 400 | ValidationError | The requested group, leverage, or balance payload is invalid. |
| 401 | Unauthorized | Manager credential is missing or does not have scope for the action. |
| 403 | PermissionDenied | The service account cannot perform the requested broker operation. |
| 409 | AlreadyApplied | The requested balance or account mutation was already applied. |
| 503 | ManagerOffline | The management plane is temporarily unavailable. |
Place manager workers behind a job queue so balance mutations, user lifecycle tasks, and report generation do not compete for the same credentials.
Mirror all successful writes into your internal audit system together with operator id, request id, and resulting MT4 login.