TickerAll API Docs

Connect a broker account. We authenticate and warm a live connection, then hand back an accountId — the handle for THIS broker connection. One API key can hold several broker accounts, so the id lives in this response (and in GET /v1/accounts), NOT in the key. Use it in every later /v1/accounts/:id call. Your password is held in memory only while the connection is live, never saved to disk.

{
  "accountId": "acc_8Kd3...",
  "isDemo": true,
  "status": "connected",
  "expiresAt": "2026-05-22T18:42:10.000Z"
}

• ▸On the Free tier, only demo broker accounts are accepted — a real-money login is rejected with FREE_TIER_LIVE_REJECTED.
• ▸The connection stays warm for a while (see expiresAt). If it cools, calls return BROKER_ACCOUNT_NOT_HOT — just POST /v1/sessions again to reconnect.

Disconnect a broker account and release its connection. Returns no body.

(empty body)

List every broker account attached to your API key, with connection state.

[
  {
    "id": "acc_8Kd3...",
    "broker": "mt5",
    "server": "Exness-MT5Trial14",
    "accountNumber": "****5678",
    "isDemo": true,
    "status": "CONNECTED",
    "hot": true,
    "lastHotAt": "2026-05-22T18:30:01.000Z",
    "createdAt": "2026-05-20T09:11:55.000Z"
  }
]

• ▸accountNumber is masked to the last 4 digits. hot=false means the connection cooled — POST /v1/sessions to re-warm it.

Live account info — balance, equity, margin, leverage — plus the current open positions.

{
  "id": "acc_8Kd3...",
  "broker": "mt5",
  "server": "Exness-MT5Trial14",
  "accountNumber": "****5678",
  "isDemo": true,
  "status": "online",
  "account": {
    "name": "Demo Account 12345678",
    "accountType": "demo",
    "leverage": 500,
    "balance": 9871.42,
    "currency": "USD",
    "equity": 9863.10,
    "margin": 142.50,
    "freeMargin": 9720.60,
    "marginLevel": 6921.5
  },
  "positions": [
    {
      "ticket": 4072808150,
      "symbol": "BTCUSD",
      "side": "BUY",
      "volume": 0.10,
      "entryPrice": 77512.73,
      "stopLoss": 71000,
      "takeProfit": 84000,
      "currentPrice": 77640.10,
      "profit": 12.74,
      "swap": 0,
      "commission": 0,
      "comment": "my-strategy",
      "magic": 0,
      "openTime": "2026-05-22T17:55:03.000Z"
    }
  ]
}

• ▸If the connection has cooled, you get status:"offline" with a hint instead of live data — POST /v1/sessions to reconnect.
• ▸Money fields (equity, margin, freeMargin, marginLevel) may be null on an MT4 account that has not yet pushed a balance frame — null is honest "not available yet", never a misleading 0.

Remove a broker account from your roster. We disconnect its live connection and drop it from your account list and from billing — this does NOT touch the broker account itself or any open positions. Reversible: reconnect the same login with POST /v1/sessions to re-add it.

{
  "id": "acc_8Kd3...",
  "status": "DISCONNECTED",
  "removed": true,
  "billableCount": 0
}

• ▸Idempotent — removing an already-removed account returns the same 200 shape.
• ▸If the account had always-hot enabled, that per-connection charge stops immediately; billableCount is your remaining always-hot connection count.

Switch which terminal type the account presents AS ("MOBILE" or "WEB"). Your open positions, pending orders and balance live on the broker account, not the connection, so they are preserved across the switch.

{
  "id": "acc_8Kd3...",
  "terminalType": "MOBILE",
  "status": "noop"
}

• ▸status is "noop" when the account is already on the requested transport.
• ▸Switching runs only when the account is idle (no in-flight trade — otherwise 409).
• ▸Both terminal types expose the full surface (account, quotes, positions, history).
• ▸The switch is zero-gap — the new transport is warmed before the old session is dropped — so open positions, orders and balance carry over untouched.

List tradeable symbols on the account, in the broker’s native names (pass-through, no normalization). symbols is the full catalog; watched is the subset that is actively streaming live ticks right now.

{
  "symbols": ["BTCUSD", "ETHUSD", "EURUSD", "GOLD", "USOILm", "..."],
  "watched": ["BTCUSD", "ETHUSD", "EURUSD"]
}

• ▸Use a name from symbols when placing orders; subscribe to a name to start it ticking on the WebSocket.

Per-symbol trading specs for the account: the volume constraints (min / max / step) for validating an order size before placing it, plus the base, profit (quote) and margin currency for each instrument. MT5 only; an MT4 account returns an empty list.

{
  "specs": [
    {
      "name": "EURUSD",
      "volumeMin": 0.01,
      "volumeMax": 200.0,
      "volumeStep": 0.01,
      "specSource": "broker",
      "baseCurrency": "EUR",
      "profitCurrency": "USD",
      "marginCurrency": "EUR"
    }
  ]
}

• ▸volumeStep is the lot increment — round an order size down to it before placing; volumeMin / volumeMax bound the size.
• ▸profitCurrency is the quote currency (the currency P&L accrues in). Use it — not the account currency — to denote an instrument.
• ▸specSource is "broker" (authoritative) or "derived" (a best-effort fallback when the broker did not supply the spec). Currency fields are absent when unknown.

Fetch historical OHLC bars from your connected broker, for any symbol the broker streams on this account. Two modes: a look-back window (hours) returns the most-recent N hours of bars, or a date range (from + to, ISO-8601) returns the exact [from, to] window. Coarser timeframes (H4, D1, W1, MN1) reach much further back — daily bars typically cover years of history. Every response reports how much of the requested window was actually served (coverage / truncated).

{
  "symbol": "BTCUSD",
  "hours": 17520,
  "timeframe": "D1",
  "candles": [
    { "timestamp": 1747699200, "open": 104200.10, "high": 107840.55, "low": 103520.00, "close": 106910.73, "bid": 106910.73 },
    { "timestamp": 1747785600, "open": 106910.73, "high": 108100.00, "low": 105480.20, "close": 107512.40, "bid": 107512.40 }
  ],
  "served": { "from": "2025-05-20T00:00:00.000Z", "to": "2025-05-21T00:00:00.000Z" },
  "count": 2,
  "coverage": "complete",
  "truncated": false,
  "stopReason": "floor"
}

• ▸Authed — needs your API key (same as the rest of the customer API). Works for any symbol your broker exposes on the connected account.
• ▸Two modes: pass hours for a look-back window, OR pass both from and to (ISO-8601) for an exact date range. When from and to are present, hours is ignored, and the response echoes from/to (the requested window) at the top level instead of hours. Supplying only one of from/to, an unparseable date, or from ≥ to returns 400 invalid_range with a message.
• ▸Each candle is { timestamp, open, high, low, close, bid, tickVolume, spread }. timestamp is the bar OPEN time in Unix seconds (UTC); bid mirrors close. tickVolume (tick count) and spread (price units) are present on recent bars; deep-history bars are bid-only and may omit them (null/absent) — don’t rely on a guaranteed volume.
• ▸Every response also reports completeness: served ({ from, to } actually returned in ISO-8601, or null when empty), count (number of candles), coverage ("complete" when the whole window was served, otherwise "floor"/"partial"), truncated (boolean — true when the whole requested window was NOT served; the authoritative completeness signal), and stopReason (why the walk stopped, e.g. "floor" = no deeper data exists, "deadline" = worth retrying, "unsupported", "error"). A note field is added when stopReason is "unsupported".
• ▸A range larger than the per-request cap (~5 years, or ~100,000 bars at the chosen timeframe) is rejected with 400 range_too_large ({ maxBars, estimatedBars, maxWindowDays }) — narrow the range or coarsen the timeframe.
• ▸Timeframes: M1, M5, M15, M30, H1, H4, D1, W1, MN1. Daily and coarser reach back years; intraday (M1–H4) covers recent months. One request returns as much history as fits in a few seconds. Deep look-backs are isolated onto a dedicated history connection — a big walk never disturbs your live tick stream.
• ▸If the broker returns no decodable bars for the symbol/range (e.g. an illiquid pair), the response is a 200 with an empty candles array (served null, truncated true) — never a 500.

Unauthenticated read of the always-on demo feed — powers the sparklines and chart on tickerall.com. Limited to TickerAll’s demo symbol list and only callable from tickerall.com (origin-gated). For arbitrary broker symbols from your own code, use GET /v1/accounts/:id/candles above.

{
  "symbol": "BTCUSD",
  "hours": 17520,
  "timeframe": "D1",
  "candles": [
    { "timestamp": 1747699200, "open": 104200.10, "high": 107840.55, "low": 103520.00, "close": 106910.73, "bid": 106910.73 },
    { "timestamp": 1747785600, "open": 106910.73, "high": 108100.00, "low": 105480.20, "close": 107512.40, "bid": 107512.40 }
  ]
}

• ▸No API key needed, but origin-gated: this endpoint accepts requests from tickerall.com only and exists to drive the public demo widgets. For programmatic access from your own code use GET /v1/accounts/:id/candles instead — it works on any symbol your broker exposes.
• ▸Each candle is { timestamp, open, high, low, close, bid }. timestamp is the bar OPEN time in Unix seconds (UTC); bid mirrors close.
• ▸Only the demo feed’s symbol list is available here. For any other symbol, connect a broker account and call GET /v1/accounts/:id/candles instead.

Place a market order (fills immediately) or a pending limit/stop order (rests until price is hit).

{
  "ticket": 4072808150,
  "symbol": "BTCUSD",
  "side": "BUY",
  "type": "market",
  "volume": 0.10,
  "price": null,
  "stopLoss": 71000,
  "takeProfit": 84000,
  "comment": "my-strategy",
  "status": "open",
  "timestamp": "2026-05-22T17:55:03.000Z"
}

• ▸Requires an Idempotency-Key header (see Conventions). Re-sending the same key returns the original response without placing a second order.
• ▸Pending orders are expressed as two separate fields, not one combined name: a buy-stop is type:"stop" + side:"BUY"; a sell-limit is type:"limit" + side:"SELL". The write API does NOT accept MetaTrader-style combined names (BUY_STOP, SELL_LIMIT, …) — passing type:"BUY_STOP" is a 400 VALIDATION_ERROR. GET /v1/accounts/:id/orders reports that combined name in its own type field for readability, but that is a read-only convenience: do not echo it back here — use its orderType (LIMIT/STOP) lowercased as type, plus side.
• ▸status is "open" for market orders and "pending" for limit/stop orders.
• ▸A broker rejection (bad volume, market closed, stop-level too tight, insufficient margin) comes back as 422 BROKER_REJECTED with the broker’s reason in message.

List the account’s working pending orders — LIMIT and STOP orders resting until their trigger price is hit. A market order is never pending: it becomes an open position immediately (see GET /v1/accounts/:id/positions). Returns an empty list when nothing is resting.

{
  "orders": [
    {
      "ticket": "4072809988",
      "symbol": "BTCUSD",
      "type": "BUY_LIMIT",
      "side": "BUY",
      "orderType": "LIMIT",
      "volume": 0.10,
      "price": 68000,
      "limitPrice": null,
      "stopLoss": 66000,
      "takeProfit": 72000,
      "setTime": "2026-08-14T09:12:44.000Z",
      "expirationTime": null
    }
  ]
}

• ▸Working (pending) orders only. When a pending order triggers it leaves this list and becomes an open position — find it under GET /v1/accounts/:id/positions.
• ▸type is one of BUY_LIMIT, SELL_LIMIT, BUY_STOP, SELL_STOP, BUY_STOP_LIMIT, SELL_STOP_LIMIT; orderType collapses that to LIMIT / STOP / STOP_LIMIT and side to BUY / SELL. ticket is a string; price is the trigger (activation) level; limitPrice is set only on STOP_LIMIT variants; expirationTime is null for good-till-cancelled.
• ▸This combined type (e.g. BUY_STOP) is READ-ONLY. To place or modify an order, use the split form — type (market/limit/stop) + side (BUY/SELL) — from POST /v1/accounts/:id/orders; the write API does not accept BUY_STOP-style names.
• ▸For live updates instead of polling, subscribe to the orders channel over the WebSocket (see the WebSocket section) — it pushes the full pending-order list on subscribe and on every change.
• ▸Optional ?waitMs=<0–10000> adds a settle window for a just-warmed connection’s first pending snapshot; omit for an immediate read.
• ▸Also reachable at the alias GET /v1/accounts/:id/orders/pending.

Cancel a resting pending order (LIMIT or STOP) by its ticket.

{
  "ticket": 4072809988,
  "symbol": "BTCUSD",
  "side": "BUY",
  "cancelled": true,
  "timestamp": "2026-08-14T09:12:44.000Z"
}

• ▸Requires an Idempotency-Key header.
• ▸ticket is the pending order’s ticket from GET /v1/accounts/:id/orders — not a position. If the order has already triggered it is now an open position; close it with DELETE /v1/accounts/:id/positions/:ticket instead.
• ▸If the ticket is not a resting pending order on this account you get 404 TICKET_NOT_FOUND.
• ▸Pending-order management is an MT5 feature; on an account that does not support it the call returns 400.

Modify a resting pending order’s trigger price, stop-loss or take-profit. Any field you omit is preserved at its current value.

{
  "ticket": 4072809988,
  "symbol": "BTCUSD",
  "side": "BUY",
  "price": 66000,
  "stopLoss": 64000,
  "takeProfit": 72000,
  "timestamp": "2026-08-14T09:12:44.000Z"
}

• ▸Requires an Idempotency-Key header.
• ▸Provide at least one of price, stopLoss or takeProfit — an empty body is a 400. Omitted fields keep their current value.
• ▸If the ticket is not a resting pending order on this account you get 404 TICKET_NOT_FOUND.

Close an open position. Omit volume for a full close, or pass a smaller volume for a partial close.

{
  "ticket": 4072808150,
  "symbol": "BTCUSD",
  "side": "BUY",
  "volume": 0.10,
  "closed": true,
  "timestamp": "2026-05-22T18:10:44.000Z"
}

• ▸Requires an Idempotency-Key header.
• ▸If the ticket is not an open position on this account you get 404 TICKET_NOT_FOUND.

Modify the stop-loss and/or take-profit of an open position. Provide at least one of stopLoss / takeProfit.

{
  "ticket": 4072808150,
  "symbol": "BTCUSD",
  "side": "BUY",
  "volume": 0.10,
  "stopLoss": 72000,
  "takeProfit": 85000,
  "timestamp": "2026-05-22T18:12:09.000Z"
}

• ▸Requires an Idempotency-Key header.
• ▸You must supply at least one of stopLoss or takeProfit; sending neither is a VALIDATION_ERROR.
• ▸Some brokers enforce a minimum stop distance (stop level). Too-tight values come back as 422 BROKER_REJECTED.

Closed-trade history for the account — executed trades paired into round-trips (entry + exit), the equivalent of MT5’s history_deals_get. Returns the recent window your broker provides on connect plus any trades closed live during the session. Filter by symbol and close-time range.

{
  "trades": [
    {
      "ticket": "4072808150",
      "symbol": "ETHUSD",
      "side": "BUY",
      "volume": 0.10,
      "openPrice": 2500.50,
      "closePrice": 2510.25,
      "openTime": "2026-05-20T10:00:00.000Z",
      "closeTime": "2026-05-20T12:30:00.000Z",
      "profit": 0.98,
      "swap": 0,
      "commission": 0,
      "stopLoss": 0,
      "takeProfit": 0,
      "closeTicket": "4072808151",
      "complete": true
    }
  ],
  "count": 1,
  "limit": 500
}

• ▸Returns the recent window your broker pushes on connect (typically the last few weeks) plus trades closed live during the current session. from/to filter those rows — they do not fetch further back than the broker’s window.
• ▸Each row is a round-trip: ticket is the open/position ticket; closeTicket is the closing deal (may be null for a trade closed live this session). profit is realised P/L in the account currency.
• ▸complete=true is a confirmed round-trip with trustworthy P/L. complete=false marks an incomplete/unmatched row, where profit is reported as null rather than a misleading 0.
• ▸swap and commission are reported as 0 (not carried in this data set).
• ▸A cheap read that never disturbs your live tick stream. On a connection that has cooled you get 409 BROKER_ACCOUNT_NOT_HOT — POST /v1/sessions to reconnect.

Place an order across many of your accounts in one request — one call fans out to every account you name, and each account’s outcome is reported separately. Requires a Pro or Enterprise plan.

{
  "results": [
    { "accountId": "acc_8Kd3...", "status": "filled", "ticket": 4072808150, "price": 77512.73, "symbol": "BTCUSD" },
    { "accountId": "acc_9Lm4...", "status": "failed", "symbol": "BTCUSD", "code": "BROKER_REJECTED", "reason": "Not enough money" }
  ],
  "summary": { "total": 2, "filled": 1, "failed": 1 }
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403.
• ▸Requires an Idempotency-Key header (see Conventions). Re-sending the same key replays the original response without placing any order a second time.
• ▸Partial success — a mix of filled and failed accounts still returns 200. Read each account’s outcome in results: status is "filled" (with its ticket and fill price) or "failed" (with a code and human-readable reason). summary tallies total / filled / failed.
• ▸Demo accounts only for now — live-account bulk placement is coming soon. A live account included in the batch comes back failed rather than placing.

Close positions across many accounts in one request — either an explicit list of positions, or a per-account intent that flattens each account (optionally narrowed by its own broker-native symbol or side). Requires a Pro or Enterprise plan.

{
  "results": [
    { "accountId": "acc_8Kd3...", "ticket": 4072808150, "status": "ok", "symbol": "BTCUSD", "side": "BUY", "volume": 0.10, "closed": true },
    { "accountId": "acc_9Lm4...", "ticket": 4072809002, "status": "failed", "symbol": "BTCUSD", "side": "SELL", "volume": 0.20, "closed": false, "code": "TICKET_NOT_FOUND", "reason": "Position not open" }
  ],
  "summary": { "total": 2, "ok": 1, "failed": 1 }
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403.
• ▸Requires an Idempotency-Key header. Re-sending the same key replays the original response without closing anything twice.
• ▸Two modes: pass items for an explicit per-position list, OR targets for a per-account intent (each { accountId, symbol?, side? }, with its own broker-native symbol). Supplying neither is a 400.
• ▸Partial success — each position’s outcome is in results: status "ok" (closed true) or "failed" (with a code and reason). summary tallies total / ok / failed.

Modify the stop-loss and/or take-profit on positions across many accounts in one request. Requires a Pro or Enterprise plan.

{
  "results": [
    { "accountId": "acc_8Kd3...", "ticket": 4072808150, "status": "ok", "symbol": "BTCUSD", "side": "BUY", "modified": true },
    { "accountId": "acc_9Lm4...", "ticket": 4072809002, "status": "failed", "symbol": "BTCUSD", "side": "SELL", "modified": false, "code": "BROKER_REJECTED", "reason": "Invalid stops" }
  ],
  "summary": { "total": 2, "ok": 1, "failed": 1 }
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403.
• ▸Requires an Idempotency-Key header.
• ▸Each item must carry at least one of stopLoss / takeProfit; an omitted field is preserved at its current value.
• ▸Partial success — per-position outcome in results: status "ok" (modified true) or "failed" (with a code and reason). summary tallies total / ok / failed.

Cancel resting pending orders (LIMIT / STOP) across many accounts in one request — an explicit list, or a per-account intent that cancels the pending orders on each account (optionally narrowed by its own broker-native symbol). Requires a Pro or Enterprise plan.

{
  "results": [
    { "accountId": "acc_8Kd3...", "ticket": 4072809988, "status": "ok", "cancelled": true },
    { "accountId": "acc_9Lm4...", "ticket": 4072809991, "status": "failed", "cancelled": false, "code": "TICKET_NOT_FOUND", "reason": "Not a resting pending order" }
  ],
  "summary": { "total": 2, "ok": 1, "failed": 1 }
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403.
• ▸Requires an Idempotency-Key header.
• ▸Two modes: items for an explicit list, OR targets for a per-account intent (each { accountId, symbol? }, with its own broker-native symbol). Supplying neither is a 400.
• ▸Partial success — per-order outcome in results: status "ok" (cancelled true) or "failed" (with a code and reason). summary tallies total / ok / failed.
• ▸Pending-order management is an MT5 feature; an entry on an account that does not support it comes back failed.

Modify resting pending orders (trigger price, stop-loss, take-profit) across many accounts in one request. Requires a Pro or Enterprise plan.

{
  "results": [
    { "accountId": "acc_8Kd3...", "ticket": 4072809988, "status": "ok", "modified": true },
    { "accountId": "acc_9Lm4...", "ticket": 4072809991, "status": "failed", "modified": false, "code": "TICKET_NOT_FOUND", "reason": "Not a resting pending order" }
  ],
  "summary": { "total": 2, "ok": 1, "failed": 1 }
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403.
• ▸Requires an Idempotency-Key header.
• ▸Each item must carry at least one of price / stopLoss / takeProfit; an omitted field is preserved at its current value.
• ▸Partial success — per-order outcome in results: status "ok" (modified true) or "failed" (with a code and reason). summary tallies total / ok / failed.

Read live state for many accounts in one request — connection status, account financials and open positions for your whole roster (or a subset) in a single call. Requires a Pro or Enterprise plan.

{
  "accounts": [
    {
      "id": "acc_8Kd3...",
      "broker": "mt5",
      "server": "Exness-MT5Trial14",
      "accountNumber": "****5678",
      "externalRef": null,
      "isDemo": true,
      "hot": true,
      "poolId": "pool_3",
      "terminalType": "MOBILE",
      "alwaysHot": false,
      "lastHotAt": "2026-08-29T09:30:01.000Z",
      "createdAt": "2026-08-20T09:11:55.000Z",
      "status": "online",
      "account": { "balance": 9871.42, "currency": "USD", "equity": 9863.10, "margin": 142.50, "freeMargin": 9720.60, "marginLevel": 6921.5, "leverage": 500 },
      "positions": [
        { "ticket": 4072808150, "symbol": "BTCUSD", "side": "BUY", "volume": 0.10, "entryPrice": 77512.73, "currentPrice": 77640.10, "profit": 12.74 }
      ]
    },
    {
      "id": "acc_9Lm4...",
      "broker": "mt5",
      "server": "ICMarketsSC-Demo",
      "accountNumber": "****3311",
      "externalRef": null,
      "isDemo": true,
      "hot": false,
      "poolId": null,
      "terminalType": "WEB",
      "alwaysHot": false,
      "lastHotAt": "2026-08-29T08:05:44.000Z",
      "createdAt": "2026-08-21T14:02:10.000Z",
      "status": "offline"
    }
  ],
  "notFound": [],
  "summary": { "total": 2, "online": 1, "offline": 1 }
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403.
• ▸Not idempotent and takes no body — pass ids and include as query-string parameters.
• ▸One round-trip for your whole roster. Each account’s status is "online" (its account and positions blocks are present, per include) or "offline" (the connection has cooled — POST /v1/sessions to re-warm it; the account/positions blocks are omitted).
• ▸include controls the per-account payload: "account" adds the financials block, "positions" adds open positions; both are included by default. Drop one to make the response smaller.
• ▸Any ids you pass that are not on your key come back in notFound. summary tallies total / online / offline.

Create a copy set — one master account whose trades are mirrored to your follower accounts, each scaled and risk-clamped to its own size. All accounts are your own. Requires a Pro or Enterprise plan.

{
  "id": "cset_7Hb2...",
  "ownerId": "usr_9Kd3...",
  "name": "My desk",
  "masterAccountId": "acc_master",
  "enabled": false,
  "failurePolicy": "retry",
  "webhookUrl": null,
  "hasWebhookSecret": false,
  "createdAt": "2026-08-29T12:00:00.000Z",
  "updatedAt": "2026-08-29T12:00:00.000Z",
  "followers": [
    { "id": "cf_1", "followerAccountId": "acc_1", "sizingMethod": "proportional", "reverse": false, "enabled": true }
  ]
}

• ▸Requires a Pro or Enterprise plan — on the Free and Trader plans this call returns 403 (COPY_REQUIRES_PRO).
• ▸Self-copy only — the master and every follower must be your own accounts. A follower cannot also be the master.
• ▸A new set is created paused (enabled false). Arm it with PATCH /v1/copy/sets/:setId { "enabled": true } once you’re happy with the followers.
• ▸While live copying is being rolled out, mirrored trades run on demo followers; managing sets and reading stats works on all accounts.

List your copy sets, each with a follower count. Requires a Pro or Enterprise plan.

{
  "sets": [
    { "id": "cset_7Hb2...", "name": "My desk", "masterAccountId": "acc_master", "enabled": true, "failurePolicy": "retry", "_count": { "followers": 3 }, "createdAt": "2026-08-29T12:00:00.000Z", "updatedAt": "2026-08-29T12:00:00.000Z" }
  ]
}

• ▸Requires a Pro or Enterprise plan.

Get one copy set with its full follower list + config. Requires a Pro or Enterprise plan.

{
  "id": "cset_7Hb2...",
  "name": "My desk",
  "masterAccountId": "acc_master",
  "enabled": true,
  "failurePolicy": "retry",
  "followers": [
    { "id": "cf_1", "followerAccountId": "acc_1", "sizingMethod": "multiplier", "sizingValue": 0.5, "maxLot": 1, "reverse": false, "enabled": true }
  ]
}

• ▸Requires a Pro or Enterprise plan.
• ▸Returns 404 if the set is not yours.

Update a set — rename, change the failure policy, or arm / pause it. Requires a Pro or Enterprise plan.

{ "id": "cset_7Hb2...", "name": "My desk", "enabled": true, "failurePolicy": "retry", "followers": [ ... ] }

• ▸Requires a Pro or Enterprise plan.
• ▸Provide at least one field. Arming is just enabled: true.

Delete a copy set (and its followers, position map, and log). Requires a Pro or Enterprise plan.

204 No Content — empty body.

• ▸Requires a Pro or Enterprise plan.
• ▸Open follower positions are NOT closed — deleting a set only stops future mirroring.

Add a follower to a set. Requires a Pro or Enterprise plan.

{ "id": "cf_4", "copySetId": "cset_7Hb2...", "followerAccountId": "acc_4", "sizingMethod": "proportional", "reverse": true, "maxSlippagePips": 3, "enabled": true }

• ▸Requires a Pro or Enterprise plan.
• ▸The follower must be your own account, not the master, and not already in the set.

Update a follower’s config — only the fields you send change. Requires a Pro or Enterprise plan.

{ "id": "cf_4", "copySetId": "cset_7Hb2...", "followerAccountId": "acc_4", "sizingMethod": "fixed", "sizingValue": 0.02, "maxLot": 1 }

• ▸Requires a Pro or Enterprise plan.

Remove a follower from a set. Requires a Pro or Enterprise plan.

204 No Content — empty body.

• ▸Requires a Pro or Enterprise plan.
• ▸Open positions the follower already holds are NOT closed.

Dashboard stats for a set — totals, replication rate, and per-follower rollups. Requires a Pro or Enterprise plan.

{
  "set": { "id": "cset_7Hb2...", "name": "My desk", "enabled": true, "masterAccountId": "acc_master", "failurePolicy": "retry", "followerCount": 3 },
  "totals": { "ok": 128, "skipped": 4, "failed": 2, "replicationRate": 0.9846 },
  "byAction": { "open": 66, "close": 60, "modify": 8 },
  "followers": [
    { "followerAccountId": "acc_1", "enabled": true, "sizingMethod": "proportional", "ok": 44, "skipped": 1, "failed": 0, "openPositions": 2, "avgLatencyMs": 138 }
  ]
}

• ▸Requires a Pro or Enterprise plan.
• ▸Derived from the copy log: totals tally ok / skipped / failed; replicationRate is ok ÷ (ok + failed). Per follower: outcome counts, current open copied positions, and average fill latency.

The copy log for a set — every mirrored action and its outcome, newest first. Requires a Pro or Enterprise plan.

{
  "entries": [
    { "id": "clg_9", "followerAccountId": "acc_1", "action": "open", "masterTicket": "4072808150", "followerTicket": "5510022931", "symbol": "EURUSDm", "mappedSymbol": "EURUSD", "volume": 0.01, "result": "ok", "latencyMs": 132, "createdAt": "2026-08-29T12:34:56.000Z" },
    { "id": "clg_8", "followerAccountId": "acc_2", "action": "open", "symbol": "XAUUSDm", "volume": null, "result": "skipped", "reason": "XAUUSD is on the block list", "createdAt": "2026-08-29T12:34:56.000Z" }
  ],
  "nextBefore": "2026-08-29T12:34:56.000Z"
}

• ▸Requires a Pro or Enterprise plan.
• ▸Newest first. limit and before are query-string parameters; page by passing the previous response’s nextBefore back as before (null means the end).
• ▸result is "ok", "skipped" (with a reason — e.g. filtered by a rule), or "failed" (with a reason). action is open / close / partial_close / modify / pending_place / pending_cancel / pending_modify.