Match-Trader API endpoints
17 documented Match-Trader API endpoints, grouped by what they do. Each has its method, path, parameters and the source it was read from.
Independent and unofficialNewest check
Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.
Authentication
- POST/manager/mtr-loginLog in with an email, a password and the broker's identifier and receive the tokens the other calls need, with the login's trading accounts.
- GET/manager/platform-detailsRead the details of the trading platform: the broker's identifier, the platform's address and the broker's name.
- POST/manager/refresh-tokenRenew the session token without logging in again. The reference says the refresh token travels as a cookie.
Data
- GET/mtr-api/{SYSTEM_UUID}/balanceRead the trading account's balance, equity, margin, free margin and profit.
- GET/mtr-api/{SYSTEM_UUID}/candlesDownload historical candles for a symbol at a chosen interval between two times: open, high, low, close and volume.
- GET/mtr-api/{SYSTEM_UUID}/effective-instrumentsList the instruments the logged in user can trade, each with its settings such as trading hours, price precision, volume limits, leverage and swap.
- GET/mtr-api/{SYSTEM_UUID}/quotationsRead the latest bid and ask for a symbol, with the day's change, high and low.
Order
- GET/mtr-api/{SYSTEM_UUID}/active-ordersList the pending orders on the trading account that have not yet been executed.
- POST/mtr-api/{SYSTEM_UUID}/pending-order/cancelCancel a pending order before it is executed, named by its id with its instrument, side and type.
- POST/mtr-api/{SYSTEM_UUID}/pending-order/createPlace a pending order that waits for a price, with a side, a volume, a type and an optional stop loss and take profit.
- POST/mtr-api/{SYSTEM_UUID}/pending-order/editChange a pending order: its price, volume, stop loss or take profit.
Position
- POST/mtr-api/{SYSTEM_UUID}/closed-positionsList the positions closed between two dates, each with its open and close price, volume, commission, swap and profit. The dates go in the body of a POST.
- GET/mtr-api/{SYSTEM_UUID}/open-positionsList every open position on the trading account, with its side, volume, open price, stop loss, take profit and running profit.
- POST/mtr-api/{SYSTEM_UUID}/position/closeClose an open position, named by its positionId with its instrument, side and volume.
- POST/mtr-api/{SYSTEM_UUID}/position/close-partiallyClose part of an open position by giving the volume to take off.
- POST/mtr-api/{SYSTEM_UUID}/position/editChange the stop loss and take profit of an open position.
- POST/mtr-api/{SYSTEM_UUID}/position/openOpen a position in an instrument, on the buy or the sell side, with a volume and an optional stop loss and take profit.