Skip to main content

Base URL

Authentication

All requests require an API key prefixed with sk_. Pass it via header, bearer token, or query parameter (WebSocket only).
See the full Authentication guide for error handling, code examples, and WebSocket auth details.

Step 1: Register Your MT5 Account

Response
Credentials are encrypted at rest with AES-256-GCM. The password is not echoed by the account CRUD endpoints — only by the read-only GET /api/accounts/{id}/details, for credential-verification flows.

Step 2: Connect to the Broker

Response
You can skip this step. All endpoints auto-connect when needed. Sessions are health-checked every 30s with automatic reconnection.

Step 3: Place a Trade

Response
Supported order types: market, limit, stop, stop_limit.

Step 4: Stream Live Data

Connect via WebSocket and subscribe to real-time channels:
See the full WebSocket Guide for alerts, aggregate messages, unsubscribing, and multi-account streaming.

Response Format

Every API response uses this envelope:

Error Codes

Next Steps

REST API Reference

Browse all 55+ client endpoints with the interactive playground.

WebSocket Guide

Real-time streams, alerts, aggregate messages, and multi-account streaming.