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

<p class="slate-p " >The Platform API provides comprehensive access to the core functionalities of our trading platform, allowing users to execute and manage trades, access market data, and perform all actions on the platform directly through code. This API is designed to empower developers and traders by offering programmatic control over trading operations, enabling the automation of tasks, integration with other systems, and the development of custom trading solutions.</p><p class="slate-p " >
The API is RESTful and uses standard HTTP methods, making it straightforward to integrate into your existing workflows. Whether you’re automating trading strategies, building custom dashboards, or enhancing your trading systems, the Platform API provides the flexibility and power you need to achieve your goals efficiently.
</p><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >The request limit is 500 requests/minute.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Platform API provides comprehensive access to the core functionalities of our trading platform, allowing users to execute and manage trades, access market data, and perform all actions on the platform directly through code. This API is designed to empower developers and traders by offering programmatic control over trading operations, enabling the automation of tasks, integration with other systems, and the development of custom trading solutions.


The API is RESTful and uses standard HTTP methods, making it straightforward to integrate into your existing workflows. Whether you’re automating trading strategies, building custom dashboards, or enhancing your trading systems, the Platform API provides the flexibility and power you need to achieve your goals efficiently.


<p class="slate-p " >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.</p><p class="slate-p " >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.</p><p class="slate-p " >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.
</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

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 

 that your broker provided, which links the new account to a specific trading offer, the user's 

 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

token

<p class="slate-p " >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:</p><p class="slate-p " >Key Elements:</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><code class="slate-code"><strong class="slate-bold">tradingApiToken</strong></code>: This token is required to authenticate further actions with the trading API.
Use this token in the header <code class="slate-code">Auth-trading-api</code> for all subsequent trading-related API requests.</p></div></div><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " ><code class="slate-code"><strong class="slate-bold">token</strong></code>: This token is used as a cookie in subsequent requests to maintain the session state.
This token is passed as a <code class="slate-code">Cookie</code> in further API requests to maintain session authenticity.</p></div></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

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:

This parameter can be obtained directly from your broker.

brokerId

tradingAccounts

selectedTradingAccount

accountInfo

accessMode

tfaProperties

tfaConfig

<p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">Refresh Token</strong> request is used to renew an authentication <code class="slate-code">token</code> initially received from the <strong class="slate-bold">Login with One-Time Token</strong> 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.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

 request is used to renew an authentication 

 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.

<p class="slate-p" placeholder="Type / for widgets">The <strong class="slate-bold">Login with One-Time Token</strong> request allows users to log in using a <code class="slate-code">token</code> obtained from the <strong class="slate-bold">Register</strong> 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.
</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

 request. Instead of traditional credentials, this method uses a single-use token for authentication. By sending a 

 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.


accounts

<p class="slate-p " >The endpoint returns details about the trading platform associated with the authenticated user.
</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

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


platformUrl

brokerName

<p class="slate-p " >The <strong class="slate-bold">Market Watch</strong> 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.
</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

 request retrieves the latest price of a specific trading symbol by sending a GET request. The request requires the 

 (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.


Auth-trading-api

Cookie

Here you past which symbol would you like to get

symbols

<p class="slate-p " >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.
</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This request retrieves the user's current account balance on the Match-Trader platform. By sending a GET request to the balance endpoint with the required 

, the API provides real-time information about the user's available funds. The response includes details such as the total balance, equity, and any reserved margin, allowing users to monitor their account's financial status.


balance

equity

freeMargin

marginLevel

credit

currency

margin

profit

netProfit

currencyPrecision

<p class="slate-p" placeholder="Type / for widgets">In the <strong class="slate-bold">Position</strong> 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.</p><p class="slate-p" placeholder="Type / for widgets">A <strong class="slate-bold">Position</strong> 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.

</p><p class="slate-p" placeholder="Type / for widgets"></p>

 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.

 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.



<p class="slate-p " >In the <strong class="slate-bold">Order</strong> 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 <strong class="slate-bold">Order</strong> section acts as a centralized hub for handling all aspects of order activity.</p><p class="slate-p " >An <strong class="slate-bold">Order</strong> 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.</p><p class="slate-p " >

</p><p class="slate-p " ></p><p class="slate-p " ></p>

 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 

 section acts as a centralized hub for handling all aspects of order activity.

 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.

<p class="slate-p " >In this section, you can find examples of error responses for each status code. Successful responses are available in the relevant sections of this documentation.</p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In this section, you can find examples of error responses for each status code. Successful responses are available in the relevant sections of this documentation.

Sections