SWAGGER STYLE

Trade Copier Explorer

Test copier rule creation, account assignment, sync monitoring, and latency analytics.

Base URLhttps://api.metatraderapi.xyz/copy
AuthBearer API key

How To Test This API

Test copier rules with a single source and a small target pool before widening rollout.

Use health and latency endpoints alongside write operations so you can confirm worker assignment and replication quality.

  1. Attach a source account and at least one destination account.
  2. Create a low-risk rule with explicit symbol mapping and risk multiplier.
  3. Inspect the rule inventory and latency timeline after activation.
  4. Review health and divergence endpoints before expanding the rollout.
HeaderValueNotes
AuthorizationBearer <api-key>Workspace API key.
x-workspace-idcore-prodOptional multi-workspace selector.
x-request-idreq_copy_demoRecommended for replay-safe mutations.

Sample Request

BASH
curl -X POST https://api.metatraderapi.xyz/copy/rules \
  -H "Authorization: Bearer <api-key>" \
  -d '{
    "name": "core-eurusd-follow",
    "sourceAccount": "src-01",
    "targets": ["dst-11", "dst-17"],
    "riskMultiplier": 1.0
  }'

Sample Response

JSON
{
  "ruleId": "copy_84x2",
  "status": "active",
  "sourceCount": 1,
  "targetCount": 2
}

Common Status Codes

CodeMeaningTypical Cause
200OKRead or health request completed successfully.
201CreatedRule or account attachment created.
409ConflictRule revision or account state conflict detected.
429BusyReplication queues are saturated or throttled.
503Worker UnavailableRequired copy workers are not healthy.