mocop
Browse · Docs · Guide · Analyze

fxapis

API by fxapis · rest

fxapis is the MetaTrader 5 API. Connect an MT5 account once, then trade it, read its positions and its history over plain HTTP. Choose whether each account stays connected or comes online only when you need it. Conventions - Every successful response is { "data": … }; every failure is { "error": { "code", "message" } }. Match on code, which is stable. message is written for a human and may change. - Every response carries requestId. Quote it in a support request and the entire call can be found. - Times are RFC 3339 in UTC. Money and prices are never floats in a request body. Bringing an account online is not instant A broker login takes as long as the broker takes — usually seconds, occasionally much longer. POST /accounts/{id}/warm brings an account online and returns 202 with a pollUrl rather than holding the request open, so your client's timeout never becomes a question about someone else's network. Poll GET /accounts/{id}/status until state…

Endpoint: https://api.fxapis.com/

Verification: observed. Source: crawl.

Capabilities (123)

  • Liveness
  • Readiness
  • List connected accounts
  • Connect an MT5 account
  • Bring several accounts online at once
  • Fetch one account
  • Delete an account and its history
  • Margin required or profit at a price
  • Price history (candles) from the account's broker
  • Take an account offline
  • An account's full deal history
  • Disconnect and erase the credential
  • What happened to an account
  • Balance equity and margin
  • See how each instrument maps onto an account's broker
  • Change how eagerly the account stays connected
  • Place a market order
  • Place a limit stop or stop-limit order
  • Replace an account's password
  • Positions on an account
  • Close a position
  • Move a position's stop loss or take profit
  • Live prices from the account's broker
  • Confirm pending results with the broker now
  • Restart the connection
About · Contact · Privacy