Atlaas API Reference

Atlaas is the orchestration control plane for MetaTrader 5 (MT5). It turns a Windows-only desktop terminal into a programmable, multi-tenant orchestration service you drive entirely over HTTP + WebSocket.

This document is the public REST/WebSocket reference. It covers every endpoint a customer can call with a service key, the exact request/response shapes, curl examples, and an honest list of what the API cannot do.

Admin / internal endpoints are intentionally excluded. Anything under /api/admin/*, the runner-facing /api/runner* and /api/runner-pairing/* endpoints, and the credential vault are operator/machine surfaces and are not part of the public API. See What you cannot do.

Official SDKs

• atlaas for npm (JavaScript/TypeScript): npm install atlaas. Usage is in sdks/node/README.md.
• Python: there is no Python SDK yet.

Without an SDK the API is plain JSON over HTTP. Use curl, fetch, requests, or any HTTP client. Every example below is copy-pasteable, and the SDK is a thin wrapper over exactly these endpoints.

Table of contents

• Base URL
• Authentication
• Identifiers (read this first)
• Request & response format
• Errors & status codes
• Idempotent order writes
• Credits, limits & rate limiting
• Trading preconditions
• Quick start
• Endpoints
  • Service keys
  • MT5 — Instance lifecycle
  • MT5 — Account
  • MT5 — Positions
  • MT5 — Orders
  • MT5 — Market data
  • MT5 — Real-time (subscriptions & WebSocket)
  • Webhooks
  • Strategy webhooks
  • Copy trading
  • Expert Advisors
  • Alerts & notifications
  • Health
• What you can do
• What you cannot do
• Appendix: enums & data models