Match-Trade

Introduction

Register

Login

Refresh token

Login with one time token

Get Platform Details

Market Watch

Get balance

Position

Get opened positions

Open position

Edit position

Partial Close

Close positions

Get closed positions

Order

Get active orders

Create pending order

Edit pending order

Cancel pending order

Errors

Default

Platform API

Sandbox

This API request is designed to create a new user account within the trading platform. By sending a POST request to the provided endpoint, you can register a user with specific credentials and associate them with a particular trading offer and partner.When executing this request, you must provide key details such as the <code class="slate-code">offerId</code> that your broker provided, which links the new account to a specific trading offer, the user&apos;s <code class="slate-code">email</code>, and the <code class="slate-code">password </code>for authentication. Additionally, the <code class="slate-code">partnerId</code> helps categorize the user under a specific partner, ensuring proper organization within the system is also taken from the broker.This endpoint is essential for onboarding new users, allowing them to quickly and efficiently access the trading platform under predefined conditions. Ensure that all required fields are accurately populated to avoid errors during the account creation process.

offerId

email

password

partnerId

name

country

parentTradingAccountUuid

surname

dateOfBirth

phone

city

postCode

address

state

Accept

Content-Type

This API request logs a user into the platform and returns authentication tokens.

Upon a successful login, the response JSON contains critical information for subsequent API requests. Below is a breakdown of the key elements and how to use them:Key Elements:

This parameter can be obtained directly from your broker.

brokerId

The Refresh Token request is used to renew an authentication <code class="slate-code">token</code> initially received from the Login with One-Time Token request. By sending a <code class="slate-code">POST</code> request with the current token as a query parameter, users can obtain a new token to maintain their session without needing to log in again. This ensures continued access to the platform without interruption, especially when the token is nearing expiration.

The Login with One-Time Token request allows users to log in using a <code class="slate-code">token</code> obtained from the Register request. Instead of traditional credentials, this method uses a single-use token for authentication. By sending a <code class="slate-code">POST</code> request with the token in the payload, users can securely log in to the platform. This method is typically used when a temporary or quick login process is required.

token

The endpoint returns details about the trading platform associated with the authenticated user.

Auth-trading-api

Cookie

The Market Watch request retrieves the latest price of a specific trading symbol by sending a GET request. The request requires the <code class="slate-code">systemUUID</code>, the <code class="slate-code">tradingApiToken</code>, and the <code class="slate-code">tradingAccountToken</code> (obtained from the login response) for secure access. By specifying the symbol in the query parameter, the API returns real-time market quotations for that symbol, allowing users to monitor current prices and make trading decisions.

Here you past which symbol would you like to get

symbols

This request retrieves the user&apos;s current account balance on the Match-Trader platform. By sending a GET request to the balance endpoint with the required <code class="slate-code">systemUUID</code>, <code class="slate-code">tradingApiToken</code>, and <code class="slate-code">tradingAccountToken</code>, the API provides real-time information about the user&apos;s available funds. The response includes details such as the total balance, equity, and any reserved margin, allowing users to monitor their account&apos;s financial status.

In the Position section, you will find comprehensive information about the various positions held within the system. This section allows you to view, manage, and interact with trading positions efficiently. Here, you can explore details of opened positions, modify them, and initiate actions such as closing or partially closing positions. It serves as a central hub for managing positions throughout their lifecycle, from creation to closure.A Position refers to a financial stake in a market instrument that a trader opens to speculate on price movements. Users can open positions based on their market analysis, and each position reflects the user’s exposure to an asset at a specific time.

This request retrieves all currently open trading positions, sends a <code class="slate-code">GET</code> request to the <code class="slate-code">open-positions</code> endpoint using the <code class="slate-code">systemUUID</code>, <code class="slate-code">tradingApiToken</code>, and <code class="slate-code">tradingAccountToken</code> for authentication. The response provides details of each open position, including the position ID, trading symbol (e.g., &quot;EURUSD&quot;), volume, side (BUY/SELL), open price, stop-loss, take-profit levels, current price, and profit/loss information. This is essential for monitoring active trades and managing open positions.

This request is used to open a new trading position. By sending a <code class="slate-code">POST</code> request with details such as the trading instrument (e.g., &quot;EURUSD&quot;), the order side (BUY or SELL), and the volume (lot size), the API places a new order. Optional parameters like stop-loss (<code class="slate-code">slPrice</code>) and take-profit (<code class="slate-code">tpPrice</code>) can also be set (for positions without SL or TP you need to provide 0 value for those fields). The request requires the <code class="slate-code">systemUUID</code>, <code class="slate-code">tradingApiToken</code>, and <code class="slate-code">tradingAccountToken</code> for authentication. Upon success, the response returns a status of <code class="slate-code">&quot;OK&quot;</code> and the <code class="slate-code">orderId</code> for the newly opened position.

instrument

orderSide

volume

slPrice

tpPrice

isMobile

This request allows you to modify an existing trading position. By providing the <code class="slate-code">instrument</code> (e.g., &quot;EURUSD&quot;), <code class="slate-code">orderId</code>, and details such as the <code class="slate-code">orderSide</code>, <code class="slate-code">volume</code>, and new stop-loss (<code class="slate-code">slPrice</code>) and take-profit (<code class="slate-code">tpPrice</code>) values, you can adjust the parameters of an open position. Authentication is handled with the <code class="slate-code">tradingApiToken</code> and <code class="slate-code">tradingAccountToken</code>. A successful response indicates that the position was updated, with a status of <code class="slate-code">&quot;OK&quot;</code> and the updated <code class="slate-code">orderId</code>.

This request is used to partially close an existing trading position on the platform. By providing the <code class="slate-code">positionId</code>, the <code class="slate-code">volume </code>to close, and details like the instrument (e.g., &quot;EURUSD&quot;) and order side (BUY or SELL), you can reduce the size of an open position. Authentication is managed via the <code class="slate-code">systemUUID</code>, <code class="slate-code">tradingApiToken</code>, and <code class="slate-code">tradingAccountToken</code>.

positionId

This request is used to close an existing trading position on the platform. By providing the <code class="slate-code">positionId</code>, trading instrument (e.g., &quot;EURUSD&quot;), the order side (BUY or SELL), and the volume to close, the API will process the position closure. Authentication is handled via the <code class="slate-code">systemUUID</code>, <code class="slate-code">tradingApiToken</code>, and <code class="slate-code">tradingAccountToken</code>. A successful response will return a status of <code class="slate-code">&quot;OK&quot;</code>, confirming that the position has been closed successfully.

This request retrieves the user&apos;s closed positions for a specific data range on the platform. By sending a <code class="slate-code">POST</code> request to the <code class="slate-code">closed-positions</code> endpoint with the required <code class="slate-code">systemUUID</code>, data range <code class="slate-code">from</code> and <code class="slate-code">to</code> <code class="slate-code">tradingApiToken</code>, and <code class="slate-code">tradingAccountToken</code>, the API provides information about the user&apos;s closed positions. The response includes details such as the total time of opening position, open price, symbol, volume, time of closing position, profit, and more, allowing users to monitor their closed positions.

from

In the Order section, you will find detailed information and tools to manage various trading orders within the system. This section allows you to create, monitor, modify, and cancel pending orders, providing full control over your order management process. The Order section acts as a centralized hub for handling all aspects of order activity.An Order represents an instruction to buy or sell a financial asset at specific conditions, such as price and quantity. Users can place pending orders, which remain open until the market conditions are met or the order is manually canceled.

The Get Active Orders request retrieves all currently active orders on the platform. By sending a <code class="slate-code">GET</code> request, this API call returns a list of open orders that have not yet been executed. The request requires authentication via the <code class="slate-code">tradingApiToken</code> and <code class="slate-code">tradingAccountToken</code>, ensuring secure access to the user&apos;s trading data. This is useful for monitoring pending orders and managing trading strategies.

The Create Pending Order request allows users to set up a pending order on the Match-Trader platform for a specific instrument. By specifying parameters such as the trading instrument (e.g., &quot;EURUSD&quot;), the order side (BUY or SELL), the volume, and the desired price, the API creates a pending order that will execute once market conditions are met. Additional options like stop-loss (<code class="slate-code">slPrice</code>) and take-profit (<code class="slate-code">tpPrice</code>) can also be included. The request requires authentication via the <code class="slate-code">tradingApiToken</code> and <code class="slate-code">tradingAccountToken</code> for secure order placement.

price

type

The Edit Pending Order request allows users to modify the details of an existing pending order on the Match-Trader platform. By sending a <code class="slate-code">POST</code> request with the <code class="slate-code">orderId</code> and updated parameters such as the trading instrument (e.g., &quot;EURUSD&quot;), order side (BUY or SELL), volume, stop-loss (<code class="slate-code">slPrice</code>), take-profit (<code class="slate-code">tpPrice</code>), and order price, users can adjust their pending orders. Authentication is handled through the <code class="slate-code">tradingApiToken</code> and <code class="slate-code">tradingAccountToken</code> to ensure secure order management.

priceOrder

The Cancel Pending Order request cancels an existing pending order on the Match-Trader platform. By providing the order&apos;s unique ID (<code class="slate-code">id</code>), instrument (e.g., &quot;EURUSD&quot;), order side (BUY or SELL), and order type (e.g., &quot;LIMIT&quot;), users can cancel a pending order before it is executed. The request requires authentication via the <code class="slate-code">tradingApiToken</code> and <code class="slate-code">tradingAccountToken</code> to securely process the cancellation. This allows traders to manage and withdraw pending orders as needed.

Platform API changelog

Platform API changelog