Match-Trade

Introduction

Integration Guide for CRM with Match-Trader Platform

Authentication

gRPC

LedgerServiceExternal

GroupServiceExternal

TradingEventsServiceExternal

OrderServiceExternal

QuotationsServiceExternal

AccountInfoServiceExternal

SymbolsServiceExternal

PositionsServiceExternal

Errors

Examples

Branches, Offers, Roles

Get Branches

Get Offers

Get Roles

Accounts

Get Accounts

Get Account by Email

Get Account by UUID

Get Account's Timeline Events

Create Account

Update Account Info

Change Account's Password

Add Note

Add Task

Trading Accounts

Payments

Get Payment Gateways

Get Deposits

Get Withdrawals

Manual Deposit

Manual Withdrawal

Credit In

Credit Out

Trading

Get Symbols

Open Position

Create Pending Order

Cancel Pending Order

Create Correction Order

Edit Position

Close Position

Close Position (Partially)

Close All Positions

Trading Data

Prop Trading

Prop gRPC

Configuration

Challenges

Targets

Evaluation Requests

Competitions

Add Ons

Admin Gateway

Broker API

v1.15

Sandbox

<p class="slate-p " >The Broker API is a versatile API platform designed for various integrations, enabling streamlined management and interaction with multiple services through a single access point. This API supports REST and gRPC protocols, providing flexibility in integration and ensuring compatibility with diverse client systems. It facilitates secure, efficient administrative operations and service management, making it an essential tool for clients looking to optimise their operational workflows.</p><p class="slate-p " >In our system, each broker has a unique <code class="slate-code">partnerID</code> assigned. Every operation via this API is performed within that particular partnerID. Since we encode your partnerID in your Authorization token, you don&apos;t have to consider this parameter when sending requests, but you will see this parameter across multiple different endpoints. For the Sandbox environment, <code class="slate-code">partnerID</code> = 0 and is shared between every account in the system. It means you will have access to test data added by other integrations.</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 " >Server time is GMT (UTC+0). </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 " >All time-related fields accept and return values according to the RFC 3339 standard. For example <code class="slate-code">2024-01-13T09:20:04.651Z</code>.</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 " >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><p class="slate-p " ></p><p class="slate-p " ></p>

The Broker API is a versatile API platform designed for various integrations, enabling streamlined management and interaction with multiple services through a single access point. This API supports REST and gRPC protocols, providing flexibility in integration and ensuring compatibility with diverse client systems. It facilitates secure, efficient administrative operations and service management, making it an essential tool for clients looking to optimise their operational workflows.

 assigned. Every operation via this API is performed within that particular partnerID. Since we encode your partnerID in your Authorization token, you don't have to consider this parameter when sending requests, but you will see this parameter across multiple different endpoints. For the Sandbox environment, 

 = 0 and is shared between every account in the system. It means you will have access to test data added by other integrations.

<p class="slate-p slate-indent-0" style="0px">Our system implements a security mechanism that utilizes token-based authorization to ensure secure resource access. The authentication process involves using an <code class="slate-code">Authorization</code> header, following the token scheme. This section outlines the steps required for obtaining and using the authentication token to access protected resources.</p><h2 class="slate-h2 " >Security Best Practices</h2><p class="slate-p slate-indent-0" style="0px">To ensure the highest security standards, all communication with our services should be performed over encrypted channels (for example, using SSL/TLS protocols). Unencrypted or insecure connections are not recommended and may be rejected by the server. In particular, please make sure to always connect to the secure port (e.g., 443) assigned for encrypted traffic.</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 " ><strong class="slate-bold">Note</strong>: Attempting to establish unencrypted connections or using insecure credentials may cause authentication or connection failures. Always utilize encrypted methods and secure credentials.</p></div></div><h2 class="slate-h2 " >Obtaining the Token</h2><p class="slate-p " >The authentication token is obtained from our Customer Relationship Management (CRM) system. You must first authenticate yourself within the CRM to receive a token. This token acts as a digital key, granting access to the system&apos;s resources for the duration of the token&apos;s validity. Tokens are valid until revoked.</p><h2 class="slate-h2 " >Using the Token for Access</h2><p class="slate-p " >Once the token is obtained, it must be included in the request to access secured resources within our system. The token is added to the HTTP request&apos;s header as follows:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language- keep-markup drop-tokens"><div class="slate-code_line">Authorization: Bearer &lt;Your_Token_Here&gt;</div></code></pre></div><h2 class="slate-h2 " >Incorporating Authorization in gRPC Requests</h2><p class="slate-p " >In gRPC, the traditional concept of HTTP headers is abstracted through metadata, allowing for the transmission of key-value pairs alongside RPC calls. To secure gRPC services with token-based authentication, the Authorization metadata (with the <code class="slate-code">Bearer</code> prefix) must be included with each call. This process is similar to using the Authorization header in HTTP requests but is adapted to fit the gRPC framework.</p><h3 class="slate-h3 " >Adding the Authorization Metadata</h3><p class="slate-p " >To include an authentication token in a gRPC request, the token must be added as metadata using the &apos;Authorization&apos; key, followed by the <code class="slate-code">Bearer</code> token value. This ensures that the server side of the gRPC service can authenticate the request by validating the token.</p><h3 class="slate-h3 " >Code Example (Python)</h3><p class="slate-p " >Below is a generic example of how to add the Authorization metadata in a gRPC client application. The implementation may vary depending on the programming language and gRPC library used.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-python keep-markup drop-tokens"><div class="slate-code_line">import grpc

# Create a secure gRPC channel (recommended)
channel = grpc.secure_channel(&apos;your_grpc_service_endpoint:443&apos;, grpc.ssl_channel_credentials())

# Prepare metadata with the Authorization token
metadata = [(&apos;Authorization&apos;, &apos;Bearer &lt;Your_Token_Here&gt;&apos;)]

# Create a stub (client)
stub = YourServiceStub(channel)

# Make a call with the Authorization metadata
response = stub.YourRpcMethod(request, metadata=metadata)</div></code></pre></div><p class="slate-p " >Replace <code class="slate-code">&lt;Your_Token_Here&gt; </code>with the actual token obtained from your CRM system, and adjust <code class="slate-code">YourServiceStub</code> and <code class="slate-code">YourRpcMethod</code> to match your gRPC service definition.</p><p class="slate-p " ></p>

Our system implements a security mechanism that utilizes token-based authorization to ensure secure resource access. The authentication process involves using an 

 header, following the token scheme. This section outlines the steps required for obtaining and using the authentication token to access protected resources.

To ensure the highest security standards, all communication with our services should be performed over encrypted channels (for example, using SSL/TLS protocols). Unencrypted or insecure connections are not recommended and may be rejected by the server. In particular, please make sure to always connect to the secure port (e.g., 443) assigned for encrypted traffic.

The authentication token is obtained from our Customer Relationship Management (CRM) system. You must first authenticate yourself within the CRM to receive a token. This token acts as a digital key, granting access to the system's resources for the duration of the token's validity. Tokens are valid until revoked.

Once the token is obtained, it must be included in the request to access secured resources within our system. The token is added to the HTTP request's header as follows:

Incorporating Authorization in gRPC Requests

In gRPC, the traditional concept of HTTP headers is abstracted through metadata, allowing for the transmission of key-value pairs alongside RPC calls. To secure gRPC services with token-based authentication, the Authorization metadata (with the 

 prefix) must be included with each call. This process is similar to using the Authorization header in HTTP requests but is adapted to fit the gRPC framework.

To include an authentication token in a gRPC request, the token must be added as metadata using the 'Authorization' key, followed by the 

 token value. This ensures that the server side of the gRPC service can authenticate the request by validating the token.

Below is a generic example of how to add the Authorization metadata in a gRPC client application. The implementation may vary depending on the programming language and gRPC library used.

with the actual token obtained from your CRM system, and adjust 

<p class="slate-p " >This gRPC model defines several services within a package designed for the Broker API, focusing on positions, ledgers, trading events, and related data. Below is the complete documentation for all services and their methods.</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 address to connect to the gRPC stream is: grpc-broker-api-demo.match-trader.com.</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 " >A separate gRPC ping stream sends pings every 50 seconds (configurable) to maintain an active connection.</p></div></div><div class="code-block-wrapper"  style="width:100%" ><div class="code-block-header">Protocol Buffers</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-protobuf keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">syntax = &apos;proto3&apos;;
import &quot;google/protobuf/empty.proto&quot;;
option java_multiple_files = true;
option java_package = &apos;com.matchtrade.broker_api.grpc&apos;;

package com.matchtrade.broker_api.grpc;

service PositionsServiceExternal {
  rpc getClientPositionsStream (PBClientPositionRequestExternal) returns (stream PBPositionStreamResponseExternal) {
  }
}

service LedgerServiceExternal {
  rpc getLedgersStreamByLogin(PBLedgerRequestByLoginExternal) returns (stream PBLedgerStreamResponseExternal) {
  }

  rpc getLedgersStreamByGroupsOrLogins(PBLedgersRequestByGroupsOrLoginsExternal) returns (stream PBLedgersStreamResponseExternal) {
  }
}

service OrderServiceExternal {
  rpc getOrdersUpdateStreamByGroupsOrLogins(PBOrdersUpdateStreamRequestExternal) returns (stream PBOrdersUpdateStreamResponseExternal) {
  }
}

service QuotationsServiceExternal {
  rpc getQuotationsWithMarkupStream (PBQuotationsWithMarkupStreamRequestExternal) returns (stream PBQuotationSimpleExternal) {
  }
}

service GroupServiceExternal {
  rpc getGroupChangesStream(PBGroupChangeStreamRequestExternal) returns (stream PBGroupChangeStreamResponseExternal) {
  }
}

service TradingEventsServiceExternal {
  rpc getTradingEventsStream (PBTradingEventsStreamRequestExternal) returns (stream PBTradingEventsStreamResponseExternal) {
  }
}
service AccountInfoServiceExternal {
  rpc getAccountInfoChangedStream  (PBAccountInfoChangedRequestExternal) returns (stream PBAccountInfoChangedStreamResponseExternal) {
  }
}

service SymbolsServiceExternal{
  rpc getSymbolsChangedStream(PBSymbolChangedRequestExternal) returns (stream PBSymbolChangedStreamResponseExternal) {}
}

message PBOrdersUpdateStreamRequestExternal {
  string systemUuid = 1;
  repeated int64 logins = 2;
  repeated string groups = 3;
  bool includeBlocked = 4;
  bool includeLocked = 5;
}

message PBOrdersUpdateStreamResponseExternal {
  oneof msg {
    PBOrder order = 1;
    bool heartbeat = 2;
  }
}

message PBOrder {
  string orderId = 1;
  string symbol = 2;
  string alias = 3;
  string volume = 4;
  PBPendingTypeExternal type = 5;
  string creationTime = 6;
  string activationPrice = 7;
  PBOrderSideExternal side = 8;
  string stopLoss = 9;
  string takeProfit = 10;
  string comment = 11;
  PBRequestUpdateTypeExternal requestUpdateType = 12;
  string groupName = 13;
  int64 login = 14;
}

enum PBPendingTypeExternal {
  UNTYPE = 0;
  LIMIT = 1;
  STOP = 2;
}

message PBDailyStatisticsExternal {
  double change = 1;
  double high = 2;
  double low = 3;
}

message PBClientPositionRequestExternal {
  string systemUuid = 1;
  string login = 2;
}

message PBPositionStreamResponseExternal {
  oneof msg {
    PBPositions positionList = 1;
    bool heartbeat = 2;
  }
}

message PBPositions {
  repeated PBPosition positions = 1;
}

message PBPosition {
  string id = 1;
  string symbol = 2;
  double volume = 3;
  PBOrderSideExternal side = 4;
  string open_time = 5;
  double open_price = 6;
  double stop_loss = 7;
  double take_profit = 8;
  double swap = 9;
  double profit = 10;
  double net_profit = 11;
  double current_price = 12;
  double commission = 13;
  repeated PBPartialExternal partials = 14;
  string alias = 15;
  PBRequestUpdateTypeExternal request_update_type = 16;
}

enum PBRequestUpdateTypeExternal {
  NEW = 0;
  UPDATE = 1;
  CLOSED = 2;
  PROFIT_CHANGE = 3;
  PARTIALLY_CLOSED = 4;
}

message PBPartialExternal {
  string id = 1;
  double volume = 3;
  double old_partial_volume = 4;
  string open_time = 6;
  double open_price = 7;
  double swap = 8;
  double profit = 9;
  double net_profit = 10;
  double commission = 12;
}

enum PBOrderSideExternal {
  BUY = 0;
  SELL = 1;
}

enum PBHistoryOperationTypeExternal {
  DEPOSIT = 0;
  WITHDRAWAL = 1;
  CREDIT_IN = 2;
  CREDIT_OUT = 3;
  AGENT_COMMISSION = 4;
  COMMISSIONS = 5;
  SWAPS = 6;
  OTHER = 7;
  CLOSED_POSITION = 8;
}

message PBLedgerRequestByLoginExternal {
  string systemUuid = 1;
  string login = 2;
  repeated PBHistoryOperationTypeExternal historyOperationType = 3;
}

message PBLedgersRequestByGroupsOrLoginsExternal {
  string systemUuid = 1;
  repeated string logins = 2;
  repeated string groups = 3;
  repeated PBHistoryOperationTypeExternal historyOperationType = 4;
}

message PBLedgerStreamResponseExternal {
  oneof msg {
    PBLedger ledger = 1;
    bool heartbeat = 2;
  }
}

message PBLedger {
  string id = 1;
  PBHistoryOperationTypeExternal historyOperationType = 2;
  string time = 3;
  double profit = 4;
  string comment = 5;
  string group = 6;
  int64 login = 7;
}


message PBLedgersStreamResponseExternal {
  oneof msg {
    PBLedgers ledgers = 1;
    bool heartbeat = 2;
  }
}

message PBLedgers {
  repeated PBLedgerStreamResponseExternal ledgers = 1;
}

message PBQuotationsWithMarkupStreamRequestExternal {
  string systemUuid = 1;
  repeated string instruments = 2;
  optional string group = 3;
  optional int32 throttlingMs = 4;
  optional bool smartThrottling = 5;
}

message PBQuotationSimpleExternal {
  oneof msg {
    PBQuotation quotation = 1;
    bool heartbeat = 2;
  }
}

message PBQuotation {
  string symbol = 1;
  double bidPrice = 2;
  double askPrice = 3;
  int64 timestampInMillis = 4;
  optional PBDailyStatisticsExternal dailyStatistics = 5;
}

message PBGroupChangeStreamRequestExternal {
  string systemUuid = 1;
  repeated string groups = 2;
}

message PBGroupChangeStreamResponseExternal {
  oneof msg {
    PBGroupUpdated groupUpdated = 1;
    PBGroupDeleted groupDeleted = 2;
    bool heartbeat = 3;
  }
}

message PBGroupUpdated {
  string group = 1;
  string currency = 2;
  int32 currencyPrecision = 3;
  string groupOwner = 4;
  map&lt;string, PBGroupSymbol&gt; symbols = 5;
  PBMarginCalculationType marginCalculationType = 6;
  bool isManager = 7;
  bool isAdmin = 8;
  bool isBrokerManager = 9;
  int64 marginCall = 10;
  int32 depositCurrencyPrecision = 11;
  int64 swapCalculationTime = 12;
  PBStopoutAndMarginCallType stopoutAndMarginCallType = 13;
  bool commissionUpfront = 14;
  bool islamicSwap = 15;
  bool demoGroup = 16;
  PBHedgeMarginCalculationType hedgeMarginCalculationType = 17;
  int64 eodMode = 18;
  int64 eomMode = 19;
  int64 eodSnapshotTime = 20;
  bool defaultRetailEnabled = 21;
  bool coverageMode = 22;
  int64 orderProcessingDelay = 23;
  double stopoutLevel = 24;
  bool hedgingEnabled = 25;
  int64 pendingMultiplierPer1000 = 26;
  int64 defaultLeverageRatioPercent = 27;
  int64 commissionPerMillion = 28;
  int64 agentCommissionPerMillion = 29;
}

message PBGroupDeleted {
  string group = 1;
  GroupDeletedReason reason = 2;

  enum GroupDeletedReason {
    GROUP_DELETED_REASON_UNKNOWN = 0;
    GROUP_DELETED_REASON_DELETED = 1;
    GROUP_DELETED_REASON_RIGHTS_REVOKED = 2;
  }
}

message PBGroupSymbol {
  string symbol = 1;
  string bidMarkup = 2;
  string askMarkup = 3;
  double leverage = 4;
  string swapBuy = 5;
  string swapSell = 6;
  int64 freezeLevel = 7;
  int64 stopsLevel = 8;
  PBSwapType swapType = 9;
  string volumeMin = 10;
  string volumeMax = 11;
  string minCommission = 12;
  bool fixedLeverage = 13;
  int64 rawLeverage = 14;
  PBCommissionType commissionType = 15;
  int64 commissionPerMillion = 16;
}

enum PBMarginCalculationType {
  UNKNOWN_MARGIN_CALCULATION_TYPE = 0;
  UNREALIZED_LOSS_ONLY = 1;
  UNREALIZED_PROFIT_LOSS = 2;
}

enum PBSwapType {
  UNKNOWN_SWAP_TYPE = 0;
  PIPS_SWAP_TYPE = 1;
  PERCENTS = 2;
  NOT_DEFINED = 3;
}

enum PBCommissionType {
  UNDEFINED = 0;
  USD_PER_MILLION = 1;
  USD_PER_CONTRACT = 2;
  USD_PER_LOT = 3;
  PERCENTAGE = 4;
  PIPS_COMMISSION_TYPE = 5;
}

enum PBStopoutAndMarginCallType {
  STOPOUT_TYPE_UNDEFINED = 0;
  STOPOUT_TYPE_MARGIN_LEVEL_PERCENTAGE = 1;
  STOPOUT_TYPE_ABSOLUTE_EQUITY_USD = 2;
  STOPOUT_TYPE_OFF = 3;
}

enum PBHedgeMarginCalculationType {
  HEDGE_MARGIN_CALCULATION_TYPE_UNSPECIFIED = 0;
  HEDGE_MARGIN_CALCULATION_TYPE_NETTING = 1;
  HEDGE_MARGIN_CALCULATION_TYPE_LARGER_LEG = 2;
}

message PBTradingEventsStreamRequestExternal {
  string systemUuid = 1;
  repeated int64 logins = 2;
  repeated string groups = 3;
  bool includeBlocked = 4;
  bool includeLocked = 5;
}

message PBTradingEventsStreamResponseExternal {
  oneof msg {
    TradingEvents tradingEvents = 1;
    bool heartbeat = 2;
  }
}

message TradingEvents {
  repeated PBTradingEvent tradingEvents = 1;
}

message PBTradingEvent {
  oneof msg {
    PBMarginCallEvent marginCallEvent = 1;
    PBStopOutEvent stopOutEvent = 2;
    PBTakeProfitEvent takeProfitEvent = 3;
    PBStopLossEvent stopLossEvent = 4;
    PBOrderActivationEvent orderActivationEvent = 5;
  }
  int64 login = 6;
  string group = 7;
}

message PBMarginCallEvent {
  int64 login = 1;
  double marginLevel = 2;
}

message PBStopOutEvent {
  int64 login = 1;
  string orderId = 2;
  string instrument = 3;
  double volume = 4;
}

message PBTakeProfitEvent {
  int64 login = 1;
  string orderId = 2;
  string instrument = 3;
  PBOrderSideExternal side = 4;
  double volume = 5;
  double netProfit = 7;
  string walletCurrency = 8;
}

message PBStopLossEvent {
  int64 login = 1;
  string orderId = 2;
  string instrument = 3;
  PBOrderSideExternal side = 4;
  double volume = 5;
  double netProfit = 7;
  string walletCurrency = 8;
}

message PBOrderActivationEvent {
  int64 login = 1;
  string orderId = 2;
  string instrument = 3;
  PBOrderSideExternal side = 4;
  double volume = 5;
  double activationPrice = 7;
}

message PBAccountInfoChangedRequestExternal {
  string systemUuid = 1;
  repeated string groups = 2;
  bool includeBlocked = 3;
  bool includeLocked = 4;
}

message PBAccountInfoChangedStreamResponseExternal {
  oneof msg {
    PBAccountInfoUpdated userUpdated = 1;
    PBAccountInfoDeleted userDeleted = 2;
    bool heartbeat = 3;
  }
}

message PBAccountInfoUpdated {
  int64 login = 1;
  optional PBAccountInfoUpdatedDetails prev = 2;
  PBAccountInfoUpdatedDetails current = 3;
}

message PBAccountInfoDeleted  {
  int64 login = 1;
  string group = 2;
  AccountInfoDeletedReason reason = 3;

  enum AccountInfoDeletedReason {
    ACCOUNT_INFO_DELETED_REASON_UNKNOWN = 0;
    ACCOUNT_INFO_DELETED_REASON_ACCOUNT_DELETED = 1;
    ACCOUNT_INFO_DELETED_REASON_RIGHTS_REVOKED = 2;
    ACCOUNT_INFO_DELETED_REASON_ACCOUNT_INTERNAL_ERROR = 3;
  }
}

message PBAccountInfoUpdatedDetails {
  optional string uuid = 1;
  optional string group = 2;
  optional int32 leverage = 3;
  optional bool isRetail = 4;
  optional bool isProView = 5;
  optional bool isBlocked = 6;
  optional bool isLocked = 7;
  optional string country = 8;
  optional string name = 9;
  optional string address = 10;
  optional string email = 11;
  optional string phone = 12;
  optional string province = 13;
  optional string zipCode = 14;
  optional string city = 15;
  optional string remarks = 16;
  optional string bankAccount = 17;
  optional string accountCurrency = 18;
  optional int32 accountCurrencyPrecision = 19;
  optional int64 registrationDate = 20;
  optional int64 agentId = 21;
  optional PBClientAccessRightsType accessRightsType = 22;
}

enum PBClientAccessRightsType {
  CLIENT_ACCESS_RIGHTS_TYPE_UNSPECIFIED = 0;
  CLIENT_ACCESS_RIGHTS_TYPE_FULL_ACCESS = 1;
  CLIENT_ACCESS_RIGHTS_TYPE_CLOSE_ONLY = 2;
}

message PBSymbolChangedRequestExternal{
  string systemUuid = 1;

}

message PBSymbolChangedStreamResponseExternal{
  oneof msg {
    PBSymbolUpdatedOrCreated symbolUpdated = 1;
    PBSymbolDeleted symbolDeleted = 2;
    PBSymbolUpdatedOrCreated symbolCreated = 3;
    bool heartbeat = 4;
  }
}

message PBSymbolUpdatedOrCreated{
  repeated TradeHoursDto tradingHours = 1;
  int32 volumePrecision = 2;
  string volumeMin = 3;
  string volumeStep = 4;
  double commission = 5;
  string sizeOfOnePoint = 6;
  string symbol = 7;
  string alias = 8;
  string baseCurrency = 9;
  string quoteCurrency = 10;
  int32 pricePrecision = 11;
  PBSymbolType type = 12;
  string swapBuy = 13;
  string swapSell = 14;
  string volumeMax = 15;
  string contractSize = 16;
  int64 multiplier = 17;
  int64 divider = 18;
  double leverage = 19;
  string description = 20;
  PBTerminationType terminationType = 21;
  string terminationDate = 22;
  repeated string tags = 23;
}

message PBSymbolDeleted{
  string symbol = 1;
}

message TradeHoursDto {
  int32 dayNumber = 1; // 0 - Sunday
  int32 openHours = 2;
  int32 openMinutes = 3;
  int32 openSeconds = 4;
  int32 closeHours = 5;
  int32 closeMinutes = 6;
  int32 closeSeconds = 7;
}

enum PBSymbolType {
  UNKNOWN_SYMBOL_TYPE = 0;
  FOREX = 1;
  CFD = 2;
  FOREXCFD = 3;
}

enum PBTerminationType {
  EXPIRATION = 0;
  ROLLOVER = 1;
}

</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p>

This gRPC model defines several services within a package designed for the Broker API, focusing on positions, ledgers, trading events, and related data. Below is the complete documentation for all services and their methods.

<p class="slate-p " >We use standard HTTP response codes to state the success or failure of API requests. It means that codes in the range</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">2xx indicate success and usually have response bodies,</div></li><li class="slate-li " ><div style="position:relative">4xx indicate errors with detailed answers to why a particular request failed,</div></li><li class="slate-li " ><div style="position:relative">5xx indicate errors on our servers.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

We use standard HTTP response codes to state the success or failure of API requests. It means that codes in the range

The request was performed successfully. You should receive a response with a body. 200 response bodies are listed in each endpoint's response section.

200 - OK

The request was performed successfully. You should receive a response without a body.

204 - No Content

Invalid request, usually due to missing some required parameter.

400 - Bad Request

Authorization information is missing or invalid.

401 - Unauthorized

Your API token does not have permission to perform the requested operation.

403 - Forbidden

Wrong HTTP method used, eg. POST instead of GET

405 - Method Not Allowed

The server understands the content type of the request entity, and the syntax is correct, but it was unable to process the request.

422 - Unprocessable Entity

Something went wrong on our end. You can contact our Product Support to check it.

500 - Internal Server Error

<p class="slate-p " >In our system, there is a distinction between multiple layers of account attributes. In general, the account operates within the frames of a given: Branch, Offer(s), and Role. Each section has an explanation of a particular layer.</p><p class="slate-p " >Via our API you cannot edit Branches, Offers, and Roles configuration (it can be done only by using our CRM), but it's important to know them since you will need them to efficiently manage accounts created in the system. That's why we share GET endpoints, where you can check Branches, Offers, and Roles available in your setup.</p><p class="slate-p " ></p><p class="slate-p " ></p>

In our system, there is a distinction between multiple layers of account attributes. In general, the account operates within the frames of a given: Branch, Offer(s), and Role. Each section has an explanation of a particular layer.

Via our API you cannot edit Branches, Offers, and Roles configuration (it can be done only by using our CRM), but it's important to know them since you will need them to efficiently manage accounts created in the system. That's why we share GET endpoints, where you can check Branches, Offers, and Roles available in your setup.

<p class="slate-p " >In the Accounts section, you will find detailed information about user accounts within the system. With this, you can access and update account details and create new accounts. This section serves as a central hub for overseeing and administering user accounts within the system. You can also find a Trading Accounts sub-section within the section with all relevant endpoints to manage Trading Accounts.</p><p class="slate-p " >An Account represents the user, and a Trading Account is needed to perform trading actions. Under one Account, there might be more than one Trading Account. Some actions are performed only on Accounts, while others are on Trading Accounts.</p><p class="slate-p " >In our system, there is a distinction between Leads and Clients. They are both types of user accounts. The difference between Lead and Client is conversion (first deposit) - the user is a Lead by default and becomes a Client after the first successful deposit.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In the Accounts section, you will find detailed information about user accounts within the system. With this, you can access and update account details and create new accounts. This section serves as a central hub for overseeing and administering user accounts within the system. You can also find a Trading Accounts sub-section within the section with all relevant endpoints to manage Trading Accounts.

An Account represents the user, and a Trading Account is needed to perform trading actions. Under one Account, there might be more than one Trading Account. Some actions are performed only on Accounts, while others are on Trading Accounts.

In our system, there is a distinction between Leads and Clients. They are both types of user accounts. The difference between Lead and Client is conversion (first deposit) - the user is a Lead by default and becomes a Client after the first successful deposit.

<p class="slate-p " >In the Payments section you can find endpoints for:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Retrieving Payment Gateways list with details about each Payment Gateway,</div></li><li class="slate-li " ><div style="position:relative">Retrieving Deposits and Withdrawals,</div></li><li class="slate-li " ><div style="position:relative">Making Manual payments,</div></li><li class="slate-li " ><div style="position:relative">Credit in and out.</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In the Payments section you can find endpoints for:

<p class="slate-p " >The Trading section allows accessing and managing various trading functionalities within the system. With this section, you can place orders and monitor trading activity seamlessly. This section provides the necessary tools for users to efficiently execute trades and stay informed about market conditions.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

The Trading section allows accessing and managing various trading functionalities within the system. With this section, you can place orders and monitor trading activity seamlessly. This section provides the necessary tools for users to efficiently execute trades and stay informed about market conditions.

<p class="slate-p " >This gRPC model outlines a collection of interconnected services within the Broker API package, enabling seamless real‑time communication and data streaming. The following documentation provides detailed information on each service and its methods, ensuring developers have the guidance they need for efficient integration and interaction with the system.</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 " >A separate gRPC ping stream sends pings every 50 seconds (configurable) to maintain an active connection.</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 " >Following RPC methods do not require any input parameters.</p></div></div><h3 class="slate-h3 " >1. GetPropAccountsCreated</h3><p class="slate-p slate-indent-1" style="24px">Streams notifications of newly created prop accounts. Returns a stream of <code class="slate-code">PBPropAccountsCreatedResponseExternal</code> messages containing account details such as propAccountUuid, login, creation timestamp, and additional metadata.</p><p class="slate-p slate-indent-1" style="24px"></p><h3 class="slate-h3 " >2. GetPropAccountTargetsUpdates</h3><p class="slate-p slate-indent-1" style="24px">Streams updates of challenge parameters assigned to a prop account. These parameters include <strong class="slate-bold">max loss</strong>, <strong class="slate-bold">profit target</strong>, <strong class="slate-bold">max daily loss</strong>, <strong class="slate-bold">trading period</strong>, etc. Updates are triggered by events such as challenge edits, phase changes, or snapshots. Returns a stream of <code class="slate-code">PBPropAccountTargetsUpdateResponseExternal</code> messages containing the updated target values along with update timestamps.</p><p class="slate-p slate-indent-1" style="24px"></p><h3 class="slate-h3 " >3. GetPropAccountStatusUpdates</h3><p class="slate-p slate-indent-1" style="24px">Streams updates of account status for prop accounts, notifying transitions between statuses like<strong class="slate-bold"> Created not paid, Active, Active Funded, and Failed.</strong> Returns a stream of <code class="slate-code">PBPropAccountStatusUpdateResponseExternal</code> messages containing the new status and the timestamp of the change.</p><p class="slate-p slate-indent-1" style="24px"></p><h3 class="slate-h3 " >4. GetPropAccountMaxLossUpdates</h3><p class="slate-p slate-indent-1" style="24px">Streams updates of target parameters for prop accounts, such as <strong class="slate-bold">max loss</strong> and <strong class="slate-bold">max daily loss</strong>. Returns a stream of <code class="slate-code">PBPropAccountMaxLossUpdateResponseExternal</code> messages containing the updated max loss and max daily loss<strong class="slate-bold"> </strong>parameters along with the effective timestamp.</p><p class="slate-p slate-indent-1" style="24px"></p><h3 class="slate-h3 " >5. GetPropEvaluationRequests</h3><p class="slate-p slate-indent-1" style="24px">Streams requests for transitioning a prop account to the next evaluation phase. Returns a stream of <code class="slate-code">PBPropAccountEvaluationRequestCreatedResponseExternal</code> messages containing details of the phase transition request and related metadata.</p><p class="slate-p slate-indent-1" style="24px"></p><h3 class="slate-h3 " >6. GetPropAccountEvaluationStatusUpdates</h3><p class="slate-p slate-indent-1" style="24px">Streams updates of the evaluation status for prop accounts. Example statuses include <strong class="slate-bold">Loss Limit Reached, Profit Target Reached Open Trades, and Profit Target Reached No Open Trades</strong>. Returns a stream of <code class="slate-code">PBPropAccountEvaluationStatusUpdateResponseExternal</code> messages containing the updated evaluation status and the corresponding update timestamp.</p><p class="slate-p " ></p><div class="slate-code_line"></div><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">Plain text</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-protobuf keep-markup drop-tokens"><div class="slate-code_line">syntax = &quot;proto3&quot;;</div><div class="slate-code_line">option java_multiple_files = true;
option java_package = &apos;com.matchtrade.broker_api.prop_grpc&apos;;
import &quot;google/protobuf/timestamp.proto&quot;;
import &quot;google/protobuf/wrappers.proto&quot;;
import &quot;google/protobuf/empty.proto&quot;;</div><div class="slate-code_line">service PropAccountExternalStreamService {
rpc GetPropAccountsCreated(google.protobuf.Empty) returns (stream PropAccountCreatedResponseExternal) {}
rpc GetPropAccountTargetsUpdates(google.protobuf.Empty) returns (stream PropAccountTargetsUpdateResponseExternal) {}
rpc GetPropAccountStatusUpdates(google.protobuf.Empty) returns (stream PropAccountStatusUpdateResponseExternal) {}
rpc GetPropAccountMaxLossUpdates(google.protobuf.Empty) returns (stream PropAccountMaxLossUpdateResponseExternal) {}
}</div><div class="slate-code_line">service PropEvaluationExternalStreamService {
rpc GetPropEvaluationRequests(google.protobuf.Empty) returns (stream PropAccountEvaluationRequestCreatedResponseExternal) {}
rpc GetPropAccountEvaluationStatusUpdates(google.protobuf.Empty) returns (stream PropAccountEvaluationStatusUpdateResponseExternal) {}
}</div><div class="slate-code_line">enum AccountInChallengeStatus {
ACTIVE_PARTICIPATING_IN_CHALLENGE = 0;
ACTIVE_FUNDED = 1;
CREATED_NOT_YET_PAID_CHALLENGE_FEE = 2;
LOCKED_FAILED_CHALLENGE = 3;
AWAITING_COMPETITION_START = 4;
AWAITING_COMPETITION_FEE_NOT_PAID = 5;
ACTIVE_COMPETITION = 6;
LOCKED_FINISHED_COMPETITION = 7;
LOCKED_FAILED_COMPETITION = 8;
}</div><div class="slate-code_line">enum AccountEvaluationStatus {
MAX_LOSS_REACHED = 0;
MAX_DAILY_LOSS_REACHED = 1;
PROFIT_TARGET_REACHED_OPEN_TRADES = 2;
PROFIT_TARGET_REACHED_NO_OPEN_TRADES = 3;
}</div><div class="slate-code_line">enum ChallengeType {
DEFAULT = 0;
COMPETITION = 1;
}</div><div class="slate-code_line">message PropAccountCreatedResponseExternal {
oneof msg {
PropAccountCreated propAccountCreated = 1;
bool heartbeat = 2;
}
}</div><div class="slate-code_line">message PropAccountCreated {
int64 login = 1;
string propAccountUuid = 2;
string challengeUuid = 3;
int64 phaseStep = 4;
AccountInChallengeStatus status = 5;
google.protobuf.Timestamp created = 6;
}</div><div class="slate-code_line">message PropAccountTargetsUpdateResponseExternal {
oneof msg {
PropAccountTargetsUpdate propAccountTargetsUpdate = 1;
bool heartbeat = 2;
}
}</div><div class="slate-code_line">message PropAccountTargetsUpdate {
int64 login = 1;
string propAccountUuid = 2;
double maxLossEquityLevel = 3;
double maxDailyLossEquityLevel = 4;
double profitTargetEquityLevel = 5;
int64 tradingPeriod = 6;
int64 minimumTradingPeriod = 7;
}</div><div class="slate-code_line">message PropAccountStatusUpdateResponseExternal {
oneof msg {
PropAccountStatusUpdate propAccountStatusUpdate = 1;
bool heartbeat = 2;
}
}</div><div class="slate-code_line">message PropAccountStatusUpdate {
string propAccountUuid = 1;
AccountInChallengeStatus status = 2;
int64 login = 3;
}</div><div class="slate-code_line">message PropAccountEvaluationStatusUpdateResponseExternal {
oneof msg {
PropAccountEvaluationStatusUpdate propAccountEvaluationStatusUpdate = 1;
bool heartbeat = 2;
}
}</div><div class="slate-code_line">message PropAccountEvaluationStatusUpdate {
int64 login = 1;
string propAccountUuid = 2;
AccountEvaluationStatus status = 3;
}</div><div class="slate-code_line">message PropAccountEvaluationRequestCreatedResponseExternal {
oneof msg {
PropAccountEvaluationRequestCreated propAccountEvaluationRequestCreated = 1;
bool heartbeat = 2;
}
}</div><div class="slate-code_line">message PropAccountEvaluationRequestCreated {
int64 login = 1;
string propAccountUuid = 2;
}</div><div class="slate-code_line">message PropAccountMaxLossUpdateResponseExternal {
oneof msg {
PropAccountMaxLossUpdate propAccountMaxLossUpdate = 1;
bool heartbeat = 2;
}
}</div><div class="slate-code_line">message PropAccountMaxLossUpdate {
string propAccountUuid = 1;
double dailyMaxLoss = 2;
double maxLoss = 3;
int64 login = 4;
}</div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

This gRPC model outlines a collection of interconnected services within the Broker API package, enabling seamless real‑time communication and data streaming. The following documentation provides detailed information on each service and its methods, ensuring developers have the guidance they need for efficient integration and interaction with the system.

Streams notifications of newly created prop accounts. Returns a stream of 

 messages containing account details such as propAccountUuid, login, creation timestamp, and additional metadata.

Streams updates of challenge parameters assigned to a prop account. These parameters include 

, etc. Updates are triggered by events such as challenge edits, phase changes, or snapshots. Returns a stream of 

PBPropAccountTargetsUpdateResponseExternal

 messages containing the updated target values along with update timestamps.

Streams updates of account status for prop accounts, notifying transitions between statuses like

 Created not paid, Active, Active Funded, and Failed.

PBPropAccountStatusUpdateResponseExternal

 messages containing the new status and the timestamp of the change.

Streams updates of target parameters for prop accounts, such as 

PBPropAccountMaxLossUpdateResponseExternal

 messages containing the updated max loss and max daily loss

parameters along with the effective timestamp.

Streams requests for transitioning a prop account to the next evaluation phase. Returns a stream of 

PBPropAccountEvaluationRequestCreatedResponseExternal

 messages containing details of the phase transition request and related metadata.

Streams updates of the evaluation status for prop accounts. Example statuses include 

Loss Limit Reached, Profit Target Reached Open Trades, and Profit Target Reached No Open Trades

PBPropAccountEvaluationStatusUpdateResponseExternal

 messages containing the updated evaluation status and the corresponding update timestamp.

<p class="slate-p " >In the challenges section, you will find endpoints that allow you to check prop trading configuration for all challenges:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Get general configuration</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In the challenges section, you will find endpoints that allow you to check prop trading configuration for all challenges:

In the challenges section, you will find endpoints that allow you to perform various operations on challenges:Get challengesCreate challengeUpdate challenge

<p class="slate-p " >In the challenges section, you will find endpoints that allow you to perform various operations on challenges:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Get challenges</div></li><li class="slate-li " ><div style="position:relative">Get challenge by Id</div></li><li class="slate-li " ><div style="position:relative">Create challenge</div></li><li class="slate-li " ><div style="position:relative">Update challenge</div></li><li class="slate-li " ><div style="position:relative">Get challenge statistics</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

In the challenges section, you will find endpoints that allow you to perform various operations on challenges:

<p class="slate-p " >In the Trading Accounts section you can find endpoints for:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Get trading accounts</div></li><li class="slate-li " ><div style="position:relative">Get trading account by Id</div></li><li class="slate-li " ><div style="position:relative">Create trading account</div></li><li class="slate-li " ><div style="position:relative">Update trading account</div></li><li class="slate-li " ><div style="position:relative">Force snapshot</div></li><li class="slate-li " ><div style="position:relative">Get failure snapshot</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

In the Trading Accounts section you can find endpoints for:

In the Trading Accounts section you can find endpoints for:Get trading accountsCreate trading accountUpdate trading accountForce snapshot

<p class="slate-p " ><p class="slate-p " >In the Trading Accounts section you can find endpoints for:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Get targets</div></li><li class="slate-li " ><div style="position:relative">Get targets by Id</div></li></ul></p><p class="slate-p " ></p>

<p class="slate-p " >In the Payments section you can find endpoints for:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Manual Withdrawal</div></li><li class="slate-li " ><div style="position:relative">Get max amount to withdrawal</div></li><li class="slate-li " ><div style="position:relative">Get amount to deposit</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p>

In the Payments section you can find endpoints for:Manual WithdrawalGet max amount to withdrawalGet amount to deposit

<p class="slate-p " >Using this endpoint, you can withdraw funds from a Trading Account. It&apos;s important to use this withdrawal endpoint for prop trading accounts to automatically calculate new max daily loss.</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>

Using this endpoint, you can withdraw funds from a Trading Account. It's important to use this withdrawal endpoint for prop trading accounts to automatically calculate new max daily loss.

paymentGatewayUuid

amount

comment

Authorization

accountId

uuid

created

status

transactionInfo

<p class="slate-p " >This endpoint retrieves the maximum amount that the user is eligible to withdraw from their challenge. This takes into consideration factors such as account balance, initial balance, and profit split. This endpoint is essential to understand current withdrawal capacity.</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 endpoint retrieves the maximum amount that the user is eligible to withdraw from their challenge. This takes into consideration factors such as account balance, initial balance, and profit split. This endpoint is essential to understand current withdrawal capacity.

Get Max Amount To Withdraw

The total profit made by the trader may be withdrawn. Does not include the profit split

maxAmount

profitSplit

<p class="slate-p " >This endpoint retrieves the required amount that the authenticated user should deposit into their trading account to activate the challenge.</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 endpoint retrieves the required amount that the authenticated user should deposit into their trading account to activate the challenge.

Get Amount For Deposit

<p class="slate-p " >In the Evaluation Requests section you can find endpoints for:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Get evaluation requests</div></li><li class="slate-li " ><div style="position:relative">Confirm evaluation</div></li><li class="slate-li " ><div style="position:relative">Reject evaluation</div></li></ul><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In the Evaluation Requests section you can find endpoints for:

In the Evaluation Requests section you can find endpoints for:Get evaluation requestsConfirm evaluationReject evaluation

<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 " >All time-related fields accept and return values according to the RFC 3339 standard, without fractions of seconds. For example <code class="slate-code">2024-01-13T09:20:04Z</code>.</p></div></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Sections