Returning.AIDocs
v1

Guides / Broker Integrations

.md

MetaTrader

We read trading activity from MetaTrader 5 or MetaTrader 4, so every deal can count towards coins, tiers and rewards. We only need read-only access.

What we read

DataWhat it powersWe'll confirm with you
User / accountMatching your customer IDs to MetaTrader logins and groupsCan we look up by login, by group, or both?
Deals / historyLots, symbols, close time, volume, PnL, commissionsWhich timestamp defines the reward window?
PositionsOpen exposure, active trader state, campaign eligibilityDo open positions count, or only closed deals?
Symbols / groupsAsset-class mapping, excluded symbols, book segmentationWhich groups and symbols are in the program?

How we connect

MetaTrader 5

We connect through the MT5 Web API or Manager API with read-only, manager-level access, with our IPs allowlisted on your server. We read each account's deals by time window.

MetaTrader 4

MT4 has no built-in web API, so we connect through whichever of these you already have:

  • Manager API access through a Windows service or a broker-hosted bridge
  • A scheduled export from your back office or reporting database
  • A broker API that already brings together MT4 logins and trading history
  • Our SQS feed or file upload

An investor password only opens a single account, so it can't power a loyalty program. We need broker-level read-only access or an export.

Light on your server

We don't run one large server-wide pull unless your server has been shown to handle it. We read in tiers instead:

  1. Hot accounts. Recently active logins, read often.
  2. Warm accounts. Known but quieter logins, read less often.
  3. Backfills. Historical jobs over bounded windows that can be safely re-run.
  4. Queue output. Activity is normalized and queued for processing, with duplicate protection.

What we'll ask you

  • Which platforms are in scope: MT4, MT5, or both?
  • What is your stable customer ID, and how does it map to trading logins?
  • Can you provide read-only server access, a reporting API, or scheduled exports?
  • Which account groups, books, symbols and jurisdictions are in or out?
  • Do bonuses, credit, rebates and real deposits have separate ledger fields?
  • Should rewards count closed deals only, or open positions too?