Finmetrik

## Introduction

The MT5 Manager API, developed by Brokeret Solution, is a comprehensive and powerful interface designed to handle all managerial tasks related to MetaTrader 5 (MT5). This API serves as the cornerstone for building custom solutions tailored to the needs of Forex Brokers, Prop Firms, and various financial institutions operating in the trading industry.

### Key Features:

1. **Versatility**: Suitable for a wide range of financial entities, including Forex, Crypto, and Stock brokers, as well as hedge funds utilizing MetaTrader 5.
    
2. **Comprehensive Management**: Offers full control over MT5 operations, allowing for efficient management of accounts, trades, and risk.
    
3. **Custom Solution Development**: Enables the creation of bespoke applications and integrations, enhancing the capabilities of MT5 for specific business needs.
    
4. **Streamlined Operations**: Automates and simplifies complex managerial tasks, improving operational efficiency.
    
5. **Scalability**: Designed to handle the demands of both small brokers and large financial institutions.
    

### API Sections:

- Connection Management
    
- Authentication & Access Control
    
- Client Management
    
- User & Account Operations
    
- Group Management
    
- Risk Management
    
- Financial Operations
    
- Trading Operations
    
- Position & Order Handling
    
- Agent & IB Management
    
- Swap Management
    
- Reporting & Auditing
    

This API is the ideal solution for financial institutions looking to extend the functionality of MetaTrader 5, offering unparalleled flexibility and control in managing trading operations.

For detailed information on each endpoint and how to use them, please refer to the specific sections in this documentation.

## Benefits

Our MT5 Manager API offers numerous advantages:

1. Custom CRM Development: Build your own Customer Relationship Management system tailored to your specific needs.
    
2. Prop Firm Solutions: Develop custom solutions for proprietary trading firms.
    
3. Custom Broker Solutions: Create bespoke trading platforms and management tools.
    
4. Risk Management Systems: Implement advanced risk management and monitoring solutions.
    
5. Mobile Applications: Develop mobile apps for traders or administrators.
    
6. Cost-Effective: Eliminate the need for expensive monthly CRM subscriptions by building your own solutions.
    

By leveraging our API, you can create highly customized and efficient solutions that cater specifically to your brokerage's requirements, giving you a competitive edge in the market.

For any questions or additional information, please contact our support team or visit brokeret.com.

## Security Note

Keep your `SNC-X-API-KEY` confidential. Do not share it or expose it in client-side code.

## Free Trial

To test our APIs on your MetaTrader 5 server, you can request a 14-day free trial:

1. Visit [https://brokeret.com/api-trial-request](https://brokeret.com/api-trial-request)
    
2. Fill out the request form
    
3. Our team will contact you with trial access details
    

## Custom Endpoints

If you require an endpoint that is not currently available, you can request custom development:

- Standard Custom Endpoint: We charge $250 for each custom endpoint development. These endpoints will be non-exclusive and may be made available to other clients in the future.
    
- Exclusive Custom Endpoint: For endpoints exclusive to your brokerage firm, please contact us for specific pricing based on your requirements.
    

Contact brokeret.com for more information on custom endpoint development.

## Disclaimer

> These APIs are designed to work with any MetaTrader 5 server, but they require a Secret API Key known as `SNC-X-API-KEY`. This key is only provided upon purchase of the API service. A dedicated deployment is required for each server to access these APIs. 
  
> Brokeret Solution is not responsible for any misuse or unauthorized access resulting from failure to protect your API key. Users are advised to implement proper security measures in their applications.

MT5 Manager API

The Connection module in the MT5 Manager API is fundamental to establishing and managing connections with the MetaTrader 5 server. It serves as the gateway for all other API operations, ensuring secure and stable communication between your application and the MT5 platform.

## Key Concepts:

- Connection establishment is the first step in interacting with the MT5 server.
    
- A successful connection is required before executing any other API operations.
    
- The connection status provides immediate feedback on the availability and responsiveness of the MT5 server.
    

## Importance of Connection Management in MT5:

1. Security: Ensures that only authorized applications can interact with the MT5 server.
    
2. Reliability: Verifies the stability and availability of the MT5 server before proceeding with operations.
    
3. Troubleshooting: Provides a quick way to diagnose connectivity issues.
    
4. Session Management: Establishes and maintains a session for subsequent API calls.
    

## Features:

1. Connection Verification: Check if a connection to the MT5 server can be established.
    
2. Authentication: Validate API credentials during the connection process.
    
3. Status Reporting: Receive detailed status information about the connection attempt.
    

## Available Endpoints:

- MT5Connection: Establish and verify a connection to the MT5 server.
    

## Best Practices:

1. Always establish a connection before attempting other API operations.
    
2. Implement proper error handling to manage connection failures gracefully.
    
3. Use the connection status to inform users about the system's availability.
    
4. Implement a reconnection strategy for handling temporary network issues.
    
5. Regularly check the connection status in long-running applications to ensure continued connectivity.
    

The Connection module is essential for ensuring reliable and secure communication with the MT5 server. It forms the foundation upon which all other API operations are built, making it a critical component of any integration with the MetaTrader 5 platform.

## Security Note:

Keep your `SNC-X-API-KEY` confidential. Do not share it or expose it in client-side code.

Connection

MT5Connection

The Auth & Access section of the MT5 Manager API provides essential endpoints for managing authentication and access control within your MetaTrader 5 environment. These APIs allow you to handle user rights, reset passwords, and monitor trading activity, ensuring secure and controlled access to your MT5 platform.

Key features of this section include:

1. User Rights Management: Assign and modify user permissions.
    
2. Password Reset: Securely reset passwords for master and investor accounts.
    
3. Login Verification: Authenticate and verify user logins.
    
4. Trading Activity Monitoring: Track and manage user trading activities.
    

Use these endpoints to maintain the security and integrity of your MT5 system while providing flexible access control for different user roles.

## Available Endpoints:

- User Rights
    
- Reset Master Password
    
- Reset Investor Password
    
- Find Login
    
- Trading Activity
    

Each endpoint is designed to handle specific aspects of authentication and access control, allowing for comprehensive management of your MT5 platform's security.

Auth & Access

User Rights

Reset Master Password

Reset Investor Password

Find Login

Trading Activity

The Clients section of the MT5 Manager API provides essential endpoints for managing the Client system, which is a crucial upper layer of MetaTrader 5's architecture. This system acts as a comprehensive profile management solution, allowing for efficient organization and control of User Accounts and Trading Accounts.

## Key Concepts:

- A Client represents a profile that can encompass multiple User Accounts and Trading Accounts.
    
- While it's possible to create user accounts and trading accounts directly based on account numbers, utilizing the Client system is the recommended approach for optimal management.
    
- The Client system enables streamlined operations across multiple trading accounts associated with a single client.
    

## Benefits of the Client System:

1. Centralized Management: Manage multiple trading accounts under a single client profile.
    
2. Improved Organization: Easily group and categorize accounts for better oversight.
    
3. Efficient Operations: Perform bulk actions or apply settings across all accounts linked to a client.
    
4. Enhanced Reporting: Generate comprehensive reports at the client level.
    

## Available Endpoints:

- Create Client: Establish a new client profile.
    
- Update Client: Modify existing client information.
    
- Link User: Associate user accounts with a client profile.
    
- Client Comment: Add or update comments for a client.
    

These endpoints provide a robust toolkit for implementing and managing the Client system within your MT5 environment, offering a more structured and efficient approach to account management.

Clients

Create Client

Update Client

Link User

Client Comment

The User & Accounts section of the MT5 Manager API provides essential endpoints for direct management of user accounts, also known as trading accounts in MetaTrader 5. While the Client system offers a higher-level approach to account management, these APIs allow for more granular control and operations at the individual account level.

## Key Concepts:

- These APIs enable direct interaction with user accounts via login numbers or account numbers.
    
- They provide an alternative to client-level management, allowing for more specific and targeted account operations.
    
- Useful for scenarios where individual account management is necessary or when working outside the Client system structure.
    

## Features:

1. Account Creation and Updates: Establish new user accounts or modify existing ones.
    
2. Account Retrieval: Fetch account details using various identifiers like login, group, or email.
    
3. Account Listing: Retrieve lists of user accounts based on different criteria.
    
4. Leverage Management: Adjust trading leverage for individual accounts.
    

## Available Endpoints:

- User Update: Modify existing user account details.
    
- User Create: Establish a new user account.
    
- User By Login: Retrieve user information using their login number.
    
- User List: Get a list of user accounts.
    
- User By Group: Fetch users belonging to a specific group.
    
- User By Email: Retrieve user information using their email address.
    
- User Leverage: Adjust the trading leverage for a user account.
    
- Account List: Obtain a list of trading accounts.
    

These endpoints provide direct control over user and trading accounts in your MT5 environment, offering flexibility for account management outside of the Client system when needed.

User & Accounts

User Update

User Create

User By Login

User List

User By Group

User By Email

User Leverage

Account List

The Groups section of the MT5 Manager API provides essential endpoints for managing and utilizing the powerful group functionality in MetaTrader 5. Groups are a fundamental tool for efficient trading account management, allowing brokers to apply settings and restrictions to multiple accounts simultaneously.

## Key Concepts:

- Groups in MT5 act as containers for trading accounts with shared characteristics or rules.
    
- They enable bulk management of trading parameters, risk settings, and access rights.
    
- Groups are crucial for scalable account administration in large trading environments.
    

## Importance of Groups in MT5:

1. Unified Settings Management: Apply trading conditions, leverage, margin requirements, and other parameters to multiple accounts at once.
    
2. Risk Management: Implement consistent risk controls across sets of accounts.
    
3. Commission Structures: Define and manage different commission schemes for various client segments.
    
4. Symbol Access Control: Restrict or grant access to specific trading instruments for different account types.
    
5. Reporting Efficiency: Generate aggregated reports and statistics for groups of accounts.
    
6. Regulatory Compliance: Easily enforce regulatory requirements across specific account categories.
    
7. Client Segmentation: Organize accounts based on client type, trading volume, or other criteria.
    

## Features:

1. Group Creation and Updates: Establish new groups or modify existing group settings.
    
2. Group Statistics: Retrieve aggregated data and performance metrics for accounts within a group.
    
3. Security Profiles: Define and manage security settings at the group level.
    
4. Trading Conditions: Set specific trading parameters for each group.
    

## Available Endpoints:

- Update Group: Modify existing group settings or create a new group.
    
- Group Statistics: Fetch aggregated statistical data for a specific group.
    

## Best Practices:

1. Create groups based on clear, logical criteria (e.g., account type, risk profile, geographical region).
    
2. Regularly review and update group settings to ensure they align with current business rules and market conditions.
    
3. Use groups in conjunction with individual account management for a balanced approach to account administration.
    
4. Leverage group statistics for performance analysis and decision-making.
    

These endpoints provide powerful tools for implementing and managing the group system within your MT5 environment, offering a more structured and efficient approach to account management at scale.

Groups

Update Group

Group Statistics

The Risk Management section of the MT5 Manager API provides essential endpoints for monitoring, assessing, and managing trading risks within the MetaTrader 5 platform. Effective risk management is crucial for maintaining the stability and profitability of trading operations, both for brokers and traders.

## Key Concepts:

- Risk management in MT5 involves quantifying and controlling the potential for losses in trading activities.
    
- It encompasses various time frames, from daily assessments to long-term risk evaluation.
    
- Proprietary trading firms (prop firms) have specific risk management needs addressed by these APIs.
    

## Importance of Risk Management in MT5:

1. Capital Preservation: Protect the broker's and traders' capital from excessive losses.
    
2. Regulatory Compliance: Meet financial regulations and reporting requirements.
    
3. Performance Optimization: Identify and mitigate inefficient or overly risky trading strategies.
    
4. Client Protection: Safeguard clients from taking on more risk than they can handle.
    
5. Operational Stability: Ensure the brokerage's overall financial health and sustainability.
    

## Features:

1. Risk Scoring: Calculate and monitor risk scores across different time frames.
    
2. Proprietary Trading Statistics: Generate and analyze stats specific to prop trading operations.
    
3. Real-time Monitoring: Assess current risk levels and respond promptly to changes.
    
4. Historical Analysis: Evaluate risk patterns over time for informed decision-making.
    

## Available Endpoints:

- Today Risk Score: Calculate and retrieve the risk score for the current day's trading activities.
    
- Week Risk Score: Assess the cumulative risk score for the past week.
    
- Total Risk Score: Evaluate the overall risk score across all available historical data.
    
- Prop Stats: Generate statistics tailored for proprietary trading firms.
    

## Best Practices:

1. Regularly monitor risk scores across all time frames to identify trends and anomalies.
    
2. Use risk scores in conjunction with other metrics for a comprehensive risk assessment.
    
3. Set up alerts for when risk scores exceed predetermined thresholds.
    
4. Tailor risk management strategies based on the specific needs of different trader groups or account types.
    
5. Continuously refine risk calculation models based on market conditions and trading patterns.
    

These endpoints provide powerful tools for implementing a robust risk management system within your MT5 environment, enabling proactive risk mitigation and informed decision-making.

Risk Management

Today Risk Score

Week Risk Score

Total Risk Score

Prop Stats

The Financial Operations section of the MT5 Manager API provides essential endpoints for managing various financial aspects of trading accounts within the MetaTrader 5 platform. These operations are crucial for maintaining accurate account balances, processing transactions, and managing the overall financial health of trading accounts.

## Key Concepts:

- Financial operations in MT5 encompass a wide range of transactions and account adjustments.
    
- These operations directly impact traders' account balances and the brokerage's financial records.
    
- Proper management of these operations is essential for regulatory compliance and client satisfaction.
    

## Importance of Financial Operations in MT5:

1. Account Management: Maintain accurate and up-to-date account balances for all traders.
    
2. Transaction Processing: Handle deposits, withdrawals, and inter-account transfers efficiently.
    
3. Reward Systems: Implement bonus and dividend programs to incentivize traders.
    
4. Fee Management: Process commissions and taxes accurately.
    
5. Error Correction: Ability to make adjustments to correct financial discrepancies.
    
6. Regulatory Compliance: Ensure all financial operations meet regulatory standards and reporting requirements.
    

## Features:

1. Balance Operations: View and modify account balances.
    
2. Credit Management: Apply or remove credit to trading accounts.
    
3. Bonus Systems: Implement and manage bonus programs for traders.
    
4. Dividend Processing: Distribute dividends to eligible accounts.
    
5. Commission Handling: Apply and manage various commission structures.
    
6. Tax Management: Calculate and apply taxes on trading activities or profits.
    
7. Fund Transfers: Facilitate the movement of funds between accounts.
    
8. Settlement Processing: Manage the settlement of trades and other financial obligations.
    

## Available Endpoints:

- Balance: Retrieve and update account balances.
    
- Credit: Apply or remove credit from accounts.
    
- Bonus: Manage bonus programs and apply bonuses to accounts.
    
- Dividend: Process and distribute dividends.
    
- Commission: Apply and manage commission charges.
    
- Correction: Make financial corrections to accounts.
    
- Tax: Calculate and apply taxes.
    
- Transfer Funds: Move funds between accounts.
    
- Settlement: Process settlements for trades and other financial activities.
    

## Best Practices:

1. Regularly reconcile account balances to ensure accuracy.
    
2. Implement strict validation checks for all financial operations to prevent errors.
    
3. Maintain detailed logs of all financial transactions for auditing purposes.
    
4. Ensure that all financial operations comply with relevant financial regulations.
    
5. Regularly review and update commission structures and bonus programs.
    
6. Implement secure protocols for handling sensitive financial data.
    
7. Provide clear and timely notifications to clients for all account transactions.
    

These endpoints provide a comprehensive toolkit for managing all aspects of financial operations within your MT5 environment, ensuring accurate, efficient, and compliant handling of funds and transactions.

Financial Operations

Balance

Credit

Bonus

Dividend

Commission

Correction

Transfer Funds

Settlement

The Trading Operations section of the MT5 Manager API provides essential endpoints for managing and executing trades within the MetaTrader 5 platform. These operations form the core functionality of the trading system, allowing for the opening, modification, and closing of positions.

## Key Concepts:

- Trading operations in MT5 encompass all activities related to entering and exiting market positions.
    
- These operations directly impact traders' portfolios and the overall market exposure of the brokerage.
    
- Efficient and accurate execution of trading operations is crucial for maintaining the integrity of the trading platform.
    

## Importance of Trading Operations in MT5:

1. Trade Execution: Enable traders to enter and exit market positions quickly and accurately.
    
2. Risk Management: Allow for immediate closure of trades to mitigate potential losses.
    
3. Strategy Implementation: Support various trading strategies through flexible order types and execution methods.
    
4. Regulatory Compliance: Ensure all trading activities adhere to regulatory standards and reporting requirements.
    
5. Performance Tracking: Facilitate the monitoring and analysis of trading performance.
    

## Features:

1. Open Trades: Execute new market or pending orders.
    
2. Close Trades: Terminate existing positions either partially or fully.
    
3. Modify Orders: Adjust parameters of existing orders (e.g., stop loss, take profit).
    
4. Bulk Operations: Perform actions on multiple trades simultaneously.
    
5. Trade Validation: Verify trade parameters before execution to prevent errors.
    

## Available Endpoints:

- Close Trade: Terminate an existing trade position.
    
- Open Trade: Execute a new trade or place a pending order.
    

## Best Practices:

1. Implement robust error handling to manage failed trade operations.
    
2. Ensure all trading operations are logged for audit and analysis purposes.
    
3. Regularly review and optimize the performance of trading operation executions.
    
4. Implement safeguards to prevent unauthorized or erroneous trades.
    
5. Provide clear and immediate feedback to users on the status of their trading operations.
    
6. Ensure that all trading operations comply with the account's trading limits and risk parameters.
    
7. Implement mechanisms to handle high-frequency trading scenarios efficiently.
    

These endpoints provide the core functionality for executing and managing trades within your MT5 environment, ensuring efficient, accurate, and compliant trading operations for all users of the platform.

Trading Operations

Close Trade

Open Trade

The Positions & Orders section of the MT5 Manager API provides essential endpoints for monitoring, analyzing, and managing open positions and orders within the MetaTrader 5 platform. These operations are crucial for maintaining an overview of current market exposure, assessing trading performance, and implementing risk management strategies.

## Key Concepts:

- Positions represent currently open trades in the market.
    
- Orders are instructions to open or close positions at specific price levels.
    
- Effective management of positions and orders is vital for successful trading operations and risk control.
    

## Importance of Positions & Orders Management in MT5:

1. Real-time Market Exposure: Monitor current positions across different instruments and client groups.
    
2. Risk Assessment: Evaluate potential risks associated with open positions and pending orders.
    
3. Performance Analysis: Analyze trading performance by examining position history and outcomes.
    
4. Compliance Monitoring: Ensure trading activities adhere to regulatory requirements and internal policies.
    
5. Client Portfolio Management: Review and manage client positions for better service and risk control.
    

## Features:

1. Position Retrieval: Fetch open positions filtered by various criteria (group, client, time).
    
2. Order Management: Access and analyze closed orders for historical performance review.
    
3. Summary Reports: Generate aggregated position data for clients or groups.
    
4. Time-based Analysis: Examine positions based on their duration or age.
    

## Available Endpoints:

- Positions By Group: Retrieve all open positions for a specific group.
    
- Summary Positions By Client: Get an overview of positions for a particular client.
    
- Summary Positions By Group: Obtain aggregated position data for a group.
    
- Positions By Days: Fetch positions that have been open for a specified number of days.
    
- Positions Older than Days: Retrieve positions that have been open longer than a specified period.
    
- Closed Orders: Access information about orders that have been closed.
    

## Best Practices:

1. Regularly monitor open positions to maintain an up-to-date risk profile.
    
2. Use summary endpoints for quick overviews of client or group exposures.
    
3. Implement automated alerts for positions exceeding certain age or risk thresholds.
    
4. Analyze closed orders to gain insights into trading patterns and strategy effectiveness.
    
5. Combine position data with other metrics (e.g., account balance, market conditions) for comprehensive risk assessment.
    
6. Ensure that position and order data is securely handled and accessed only by authorized personnel.
    
7. Use time-based position analysis to identify and manage stale or potentially problematic trades.
    

These endpoints provide powerful tools for maintaining a clear overview of trading activities, enabling effective risk management, and supporting informed decision-making within your MT5 environment.

Positions & Orders

Positions By Group

Summary Positions By Client

Summary Positions By Group

Positions By Days

Positions Older than Days

Closed Orders

The Agent & IB section of the MT5 Manager API provides endpoints for managing the basic Agent and Introducing Broker (IB) functionality within the MetaTrader 5 platform. This module focuses on the core agent operations native to MT5.

## Key Concepts:

- Agents and IBs are individuals or entities that bring new clients to the brokerage.
    
- This module handles the fundamental aspects of agent account management in MT5.
    
- It is distinct from more advanced IB systems that may be offered separately.
    

## Scope of the Base Agent Module:

1. Agent Account Management: Create, update, and manage basic agent accounts.
    
2. Commission Structure: Set up simple commission schemes for agents.
    
3. Client Association: Link clients to their respective agents.
    
4. Basic Reporting: Access fundamental data on agent performance.
    

## Available Endpoints:

- Update Agent Account: Modify existing agent account details or create new agent accounts.
    

## Important Notes:

- This module represents the standard Agent/IB functionality provided by MetaTrader 5.
    
- It is not connected to or part of any advanced IB Module offered by Brokeret under their CRM system.
    
- For more complex IB structures or advanced features, users should contact the Brokeret Team for information on their Multi IB Module.
    

## Best Practices:

1. Use this module for basic agent management within the MT5 environment.
    
2. Regularly update agent information to ensure accurate commission calculations.
    
3. Monitor agent performance using the available data to optimize your IB program.
    
4. For advanced IB hierarchies or more complex commission structures, consider exploring Brokeret's specialized Multi IB Module.
    

This base Agent Module provides essential tools for managing a straightforward IB program directly within your MT5 platform. It's suitable for brokers with basic IB needs or those just starting to implement an agent system.

For more advanced IB management features, multi-tier structures, or integration with a comprehensive CRM system, please contact the Brokeret Team for details on their enhanced Multi IB Module offerings.

Agent & IB

Update Agent Account

The Swap Manager module in the MT5 Manager API provides essential functionality for handling swap operations within the MetaTrader 5 platform. Swaps are a crucial aspect of forex and CFD trading, representing the interest rate differential between the two currencies involved in a forex pair or the cost of holding a position overnight in other financial instruments.

## Key Concepts:

- Swaps are charges or credits applied to positions held overnight.
    
- The Swap Manager allows brokers to define, calculate, and apply swap rates to open positions.
    
- Effective swap management is crucial for accurate profit/loss calculations and risk management.
    

## Importance of Swap Management in MT5:

1. Accurate Pricing: Ensure that the cost of holding positions is correctly reflected in traders' accounts.
    
2. Risk Management: Help brokers manage their exposure to interest rate differentials.
    
3. Regulatory Compliance: Maintain transparent and fair swap calculations as required by regulators.
    
4. Competitive Edge: Offer attractive swap rates to traders as part of your overall pricing strategy.
    

## Features:

1. Position Swap Calculation: Compute swap values for open positions based on defined rules.
    
2. Swap Rate Definition: Set and manage swap rates for different instruments and account types.
    
3. Automated Application: Automatically apply swaps to relevant positions at rollover time.
    
4. Flexible Rules: Define different swap calculations for various scenarios (e.g., weekends, holidays).
    

## Available Endpoints:

- Position Swap: Calculate and apply swaps to specific positions.
    

## Best Practices:

1. Regularly review and update swap rates to reflect current market conditions.
    
2. Ensure transparency in swap calculations and rates for traders.
    
3. Implement thorough testing when modifying swap calculation rules.
    
4. Consider the impact of swaps on different trading strategies and account types.
    
5. Provide clear documentation on how swaps are calculated and applied to your traders.
    

The Swap Manager module is a critical component for maintaining accurate and fair trading conditions in your MT5 environment. It allows for precise control over swap calculations and applications, ensuring that both the brokerage and its clients have a clear understanding of the costs associated with holding positions overnight.

Swap Manager

Position Swap

The Report & Audit module in the MT5 Manager API provides essential functionality for generating, accessing, and managing various reports within the MetaTrader 5 platform. This module is crucial for maintaining transparency, ensuring compliance, and deriving valuable insights from trading activities.

## Key Concepts:

- Reporting encompasses the generation and analysis of various trading-related data.
    
- Auditing involves the systematic review of trading operations, financial transactions, and system activities.
    
- This module facilitates both routine operational reporting and in-depth auditing processes.
    

## Importance of Reporting & Auditing in MT5:

1. Regulatory Compliance: Meet regulatory requirements for record-keeping and reporting.
    
2. Performance Analysis: Evaluate the performance of traders, agents, and overall business operations.
    
3. Risk Management: Identify and assess potential risks through comprehensive data analysis.
    
4. Business Intelligence: Gain insights to inform strategic decision-making and improve operations.
    
5. Transparency: Maintain clear and accurate records of all trading and financial activities.
    

## Features:

1. Agent Commission Reporting: Generate detailed reports on agent/IB commissions.
    
2. Balance Reporting: Access comprehensive balance reports for accounts or groups.
    
3. Customizable Reports: Ability to generate reports based on various parameters and time frames.
    
4. Data Export: Export report data in various formats for further analysis or integration with other systems.
    
5. Audit Trail: Maintain a detailed log of system activities and changes for auditing purposes.
    

## Available Endpoints:

- Agent Commission Report: Retrieve commission data for agents and introducing brokers.
    
- Balance Report: Generate reports on account balances and financial status.
    

## Best Practices:

1. Regularly schedule and review key reports to maintain ongoing awareness of your trading operations.
    
2. Use report data to identify trends, anomalies, or areas requiring attention in your business.
    
3. Ensure that all necessary stakeholders have appropriate access to relevant reports.
    
4. Implement a system for archiving reports to maintain historical records for compliance and analysis.
    
5. Regularly audit your reporting processes to ensure accuracy and completeness of data.
    
6. Use the insights gained from reports to continually refine and improve your trading operations and risk management strategies.
    

The Report & Audit module is a critical component for maintaining transparency, ensuring regulatory compliance, and driving data-informed decision-making in your MT5 environment. It provides the tools necessary to gain a comprehensive understanding of your trading operations, from individual agent performance to overall financial health.

Report & Audit

Agent Commision Report

Balance Report

Default

MT5 Manager API's - For Forex Brokers & Prop Firms

<p class="slate-p " ></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" ><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div></div><colgroup ><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-div"><h1 class="slate-h1 " >Introduction</h1></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(33, 33, 33)">The MT5 Manager API, developed by Brokeret Solution, is a comprehensive and powerful interface designed to handle all managerial tasks related to MetaTrader 5 (MT5). This API serves as the cornerstone for building custom solutions tailored to the needs of Forex Brokers, Prop Firms, and various financial institutions operating in the trading industry.</span></p></td></div></tr></tbody></table></div><h1 class="slate-h1 " >Key Features:</h1><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Versatility</strong>: Suitable for a wide range of financial entities, including Forex, Crypto, and Stock brokers, as well as hedge funds utilizing MetaTrader 5.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Comprehensive Management</strong>: Offers full control over MT5 operations, allowing for efficient management of accounts, trades, and risk.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Custom Solution Development</strong>: Enables the creation of bespoke applications and integrations, enhancing the capabilities of MT5 for specific business needs.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Streamlined Operations</strong>: Automates and simplifies complex managerial tasks, improving operational efficiency.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Scalability</strong>: Designed to handle the demands of both small brokers and large financial institutions.</div></li></ol><p class="slate-p " ></p><h1 class="slate-h1 " >API Sections:</h1><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Connection Management</div></li><li class="slate-li " ><div style="position:relative">Authentication &amp; Access Control</div></li><li class="slate-li " ><div style="position:relative">Client Management</div></li><li class="slate-li " ><div style="position:relative">User &amp; Account Operations</div></li><li class="slate-li " ><div style="position:relative">Group Management</div></li><li class="slate-li " ><div style="position:relative">Risk Management</div></li><li class="slate-li " ><div style="position:relative">Financial Operations</div></li><li class="slate-li " ><div style="position:relative">Trading Operations</div></li><li class="slate-li " ><div style="position:relative">Position &amp; Order Handling</div></li><li class="slate-li " ><div style="position:relative">Agent &amp; IB Management</div></li><li class="slate-li " ><div style="position:relative">Swap Management</div></li><li class="slate-li " ><div style="position:relative">Reporting &amp; Auditing</div></li></ul><p class="slate-p " >This API is the ideal solution for financial institutions looking to extend the functionality of MetaTrader 5, offering unparalleled flexibility and control in managing trading operations.</p><p class="slate-p " >For detailed information on each endpoint and how to use them, please refer to the specific sections in this documentation.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Benefits</h2><p class="slate-p " >Our MT5 Manager API offers numerous advantages:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Custom CRM Development: Build your own Customer Relationship Management system tailored to your specific needs.</div></li><li class="slate-li " ><div style="position:relative">Prop Firm Solutions: Develop custom solutions for proprietary trading firms.</div></li><li class="slate-li " ><div style="position:relative">Custom Broker Solutions: Create bespoke trading platforms and management tools.</div></li><li class="slate-li " ><div style="position:relative">Risk Management Systems: Implement advanced risk management and monitoring solutions.</div></li><li class="slate-li " ><div style="position:relative">Mobile Applications: Develop mobile apps for traders or administrators.</div></li><li class="slate-li " ><div style="position:relative">Cost-Effective: Eliminate the need for expensive monthly CRM subscriptions by building your own solutions.</div></li></ul><p class="slate-p " >By leveraging our API, you can create highly customized and efficient solutions that cater specifically to your brokerage&apos;s requirements, giving you a competitive edge in the market.</p><p class="slate-p " >For any questions or additional information, please contact our support team or visit brokeret.com.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Security Note</h2><p class="slate-p " ><span style="background-color:rgb(255, 255, 255);color:rgb(33, 33, 33)">Keep your </span><span style="background-color:rgb(242, 242, 242);color:rgb(33, 33, 33)"><code class="slate-code">SNC-X-API-KEY</code></span><span style="background-color:rgb(255, 255, 255);color:rgb(33, 33, 33)"> confidential. Do not share it or expose it in client-side code.</span></p><p class="slate-p " ></p><h2 class="slate-h2 " >Free Trial</h2><p class="slate-p " >To test our APIs on your MetaTrader 5 server, you can request a 14-day free trial:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Visit <a href="https://brokeret.com/api-trial-request" target="_blank">https://brokeret.com/api-trial-request</a></div></li><li class="slate-li " ><div style="position:relative">Fill out the request form</div></li><li class="slate-li " ><div style="position:relative">Our team will contact you with trial access details</div></li></ul><p class="slate-p " ></p><h2 class="slate-h2 " >Custom Endpoints</h2><p class="slate-p " >If you require an endpoint that is not currently available, you can request custom development:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Standard Custom Endpoint: We charge $250 for each custom endpoint development. These endpoints will be non-exclusive and may be made available to other clients in the future.</div></li><li class="slate-li " ><div style="position:relative">Exclusive Custom Endpoint: For endpoints exclusive to your brokerage firm, please contact us for specific pricing based on your requirements.</div></li></ul><p class="slate-p " >Contact brokeret.com for more information on custom endpoint development.</p><p class="slate-p " ></p><h2 class="slate-h2 " >Disclaimer</h2><div class="slate-div"><p class="slate-p " >These APIs are designed to work with any MetaTrader 5 server, but they require a Secret API Key known as <span style="background-color:rgb(242, 242, 242);"><code class="slate-code">SNC-X-API-KEY</code></span>. This key is only provided upon purchase of the API service. A dedicated deployment is required for each server to access these APIs. </p></div><div class="slate-div"><p class="slate-p " >Brokeret Solution is not responsible for any misuse or unauthorized access resulting from failure to protect your API key. Users are advised to implement proper security measures in their applications.</p></div><p class="slate-p " ></p>

Title

This API is the ideal solution for financial institutions looking to extend the functionality of MetaTrader 5, offering unparalleled flexibility and control in managing trading operations.

For detailed information on each endpoint and how to use them, please refer to the specific sections in this documentation.

Our MT5 Manager API offers numerous advantages:

By leveraging our API, you can create highly customized and efficient solutions that cater specifically to your brokerage's requirements, giving you a competitive edge in the market.

For any questions or additional information, please contact our support team or visit brokeret.com.

 confidential. Do not share it or expose it in client-side code.

To test our APIs on your MetaTrader 5 server, you can request a 14-day free trial:

If you require an endpoint that is not currently available, you can request custom development:

Contact brokeret.com for more information on custom endpoint development.

The Connection section of the MT5 Manager API is crucial for setting up and managing connections with the MetaTrader 5 server. By establishing a secure and stable communication link, users can initiate all other API operations and ensure a smooth interaction with the MT5 platform.

The User & Accounts section of the MT5 Manager API empowers users to perform detailed management tasks on individual trading accounts within MetaTrader 5. By offering direct interaction with account numbers or login numbers, this section enables granular control and specialized operations for enhanced account management capabilities.

<p class="slate-p " >The Groups section of the MT5 Manager API provides essential endpoints for managing and utilizing the powerful group functionality in MetaTrader 5. Groups are a fundamental tool for efficient trading account management, allowing brokers to apply settings and restrictions to multiple accounts simultaneously.</p><h2 class="slate-h2 " >Key Concepts:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Groups in MT5 act as containers for trading accounts with shared characteristics or rules.</div></li><li class="slate-li " ><div style="position:relative">They enable bulk management of trading parameters, risk settings, and access rights.</div></li><li class="slate-li " ><div style="position:relative">Groups are crucial for scalable account administration in large trading environments.</div></li></ul><h2 class="slate-h2 " >Importance of Groups in MT5:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Unified Settings Management: Apply trading conditions, leverage, margin requirements, and other parameters to multiple accounts at once.</div></li><li class="slate-li " ><div style="position:relative">Risk Management: Implement consistent risk controls across sets of accounts.</div></li><li class="slate-li " ><div style="position:relative">Commission Structures: Define and manage different commission schemes for various client segments.</div></li><li class="slate-li " ><div style="position:relative">Symbol Access Control: Restrict or grant access to specific trading instruments for different account types.</div></li><li class="slate-li " ><div style="position:relative">Reporting Efficiency: Generate aggregated reports and statistics for groups of accounts.</div></li><li class="slate-li " ><div style="position:relative">Regulatory Compliance: Easily enforce regulatory requirements across specific account categories.</div></li><li class="slate-li " ><div style="position:relative">Client Segmentation: Organize accounts based on client type, trading volume, or other criteria.</div></li></ol><h2 class="slate-h2 " >Features:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Group Creation and Updates: Establish new groups or modify existing group settings.</div></li><li class="slate-li " ><div style="position:relative">Group Statistics: Retrieve aggregated data and performance metrics for accounts within a group.</div></li><li class="slate-li " ><div style="position:relative">Security Profiles: Define and manage security settings at the group level.</div></li><li class="slate-li " ><div style="position:relative">Trading Conditions: Set specific trading parameters for each group.</div></li></ol><h2 class="slate-h2 " >Available Endpoints:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Update Group: Modify existing group settings or create a new group.</div></li><li class="slate-li " ><div style="position:relative">Group Statistics: Fetch aggregated statistical data for a specific group.</div></li></ul><h2 class="slate-h2 " >Best Practices:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Create groups based on clear, logical criteria (e.g., account type, risk profile, geographical region).</div></li><li class="slate-li " ><div style="position:relative">Regularly review and update group settings to ensure they align with current business rules and market conditions.</div></li><li class="slate-li " ><div style="position:relative">Use groups in conjunction with individual account management for a balanced approach to account administration.</div></li><li class="slate-li " ><div style="position:relative">Leverage group statistics for performance analysis and decision-making.</div></li></ol><p class="slate-p " >These endpoints provide powerful tools for implementing and managing the group system within your MT5 environment, offering a more structured and efficient approach to account management at scale.</p><p class="slate-p " ></p>

The Groups section of the MT5 Manager API provides essential endpoints for managing and utilizing the powerful group functionality in MetaTrader 5. Groups are a fundamental tool for efficient trading account management, allowing brokers to apply settings and restrictions to multiple accounts simultaneously.

These endpoints provide powerful tools for implementing and managing the group system within your MT5 environment, offering a more structured and efficient approach to account management at scale.

The Financial Operations section of the MT5 Manager API offers a comprehensive set of endpoints dedicated to handling financial transactions and account balance management within MetaTrader 5. Users can seamlessly process transactions, adjust account balances, and ensure the financial integrity of trading accounts through these essential functionalities.

The Trading Operations section of the MT5 Manager API enables users to manage and execute trades within the MetaTrader 5 platform. With essential endpoints for opening, modifying, and closing positions, this section facilitates core trading functionalities to effectively control market positions and optimize portfolios.

The Close Trade section of the MT5 Manager API allows users to efficiently close trades within their trading account. By utilizing this functionality, users can quickly manage their positions and optimize their trading strategies without manual intervention. This feature streamlines the process of closing trades, providing a seamless experience for traders using the API.

The ticket number associated with the trade.

ticket

SNC-X-API-KEY

The version of the MT5 Manager API being used.

version

The status code of the trade closure request.

statusCode

Any messages or notifications related to the trade closure.

messages

result

Pending Order Open Trade

Market Order 2

The result of the trade closing operation.

Market Order 3

The status code of the trade closing operation.

Any additional messages related to the trade closing process.

Open Trade Sell Limit

The "Open Trade" section of the MT5 Manager API allows users to initiate a new trade in the system. By providing relevant trade details such as symbol, volume, order price, and more, users can successfully open a new position in the market. This functionality enables users to actively manage their trading activities through the API.

Login

Symbol

Volume

OrderAction

OrderPrice

SLPrice

TPPrice

Any comments or notes related to the trade.

Comments

Any messages or notifications related to the trade.

<p class="slate-p " >The Positions &amp; Orders section of the MT5 Manager API provides essential endpoints for monitoring, analyzing, and managing open positions and orders within the MetaTrader 5 platform. These operations are crucial for maintaining an overview of current market exposure, assessing trading performance, and implementing risk management strategies.</p><h2 class="slate-h2 " >Key Concepts:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Positions represent currently open trades in the market.</div></li><li class="slate-li " ><div style="position:relative">Orders are instructions to open or close positions at specific price levels.</div></li><li class="slate-li " ><div style="position:relative">Effective management of positions and orders is vital for successful trading operations and risk control.</div></li></ul><h2 class="slate-h2 " >Importance of Positions &amp; Orders Management in MT5:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Real-time Market Exposure: Monitor current positions across different instruments and client groups.</div></li><li class="slate-li " ><div style="position:relative">Risk Assessment: Evaluate potential risks associated with open positions and pending orders.</div></li><li class="slate-li " ><div style="position:relative">Performance Analysis: Analyze trading performance by examining position history and outcomes.</div></li><li class="slate-li " ><div style="position:relative">Compliance Monitoring: Ensure trading activities adhere to regulatory requirements and internal policies.</div></li><li class="slate-li " ><div style="position:relative">Client Portfolio Management: Review and manage client positions for better service and risk control.</div></li></ol><h2 class="slate-h2 " >Features:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Position Retrieval: Fetch open positions filtered by various criteria (group, client, time).</div></li><li class="slate-li " ><div style="position:relative">Order Management: Access and analyze closed orders for historical performance review.</div></li><li class="slate-li " ><div style="position:relative">Summary Reports: Generate aggregated position data for clients or groups.</div></li><li class="slate-li " ><div style="position:relative">Time-based Analysis: Examine positions based on their duration or age.</div></li></ol><h2 class="slate-h2 " >Available Endpoints:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Positions By Group: Retrieve all open positions for a specific group.</div></li><li class="slate-li " ><div style="position:relative">Summary Positions By Client: Get an overview of positions for a particular client.</div></li><li class="slate-li " ><div style="position:relative">Summary Positions By Group: Obtain aggregated position data for a group.</div></li><li class="slate-li " ><div style="position:relative">Positions By Days: Fetch positions that have been open for a specified number of days.</div></li><li class="slate-li " ><div style="position:relative">Positions Older than Days: Retrieve positions that have been open longer than a specified period.</div></li><li class="slate-li " ><div style="position:relative">Closed Orders: Access information about orders that have been closed.</div></li></ul><h2 class="slate-h2 " >Best Practices:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Regularly monitor open positions to maintain an up-to-date risk profile.</div></li><li class="slate-li " ><div style="position:relative">Use summary endpoints for quick overviews of client or group exposures.</div></li><li class="slate-li " ><div style="position:relative">Implement automated alerts for positions exceeding certain age or risk thresholds.</div></li><li class="slate-li " ><div style="position:relative">Analyze closed orders to gain insights into trading patterns and strategy effectiveness.</div></li><li class="slate-li " ><div style="position:relative">Combine position data with other metrics (e.g., account balance, market conditions) for comprehensive risk assessment.</div></li><li class="slate-li " ><div style="position:relative">Ensure that position and order data is securely handled and accessed only by authorized personnel.</div></li><li class="slate-li " ><div style="position:relative">Use time-based position analysis to identify and manage stale or potentially problematic trades.</div></li></ol><p class="slate-p " >These endpoints provide powerful tools for maintaining a clear overview of trading activities, enabling effective risk management, and supporting informed decision-making within your MT5 environment.</p><p class="slate-p " ></p>

The Positions & Orders section of the MT5 Manager API provides essential endpoints for monitoring, analyzing, and managing open positions and orders within the MetaTrader 5 platform. These operations are crucial for maintaining an overview of current market exposure, assessing trading performance, and implementing risk management strategies.

Importance of Positions & Orders Management in MT5:

These endpoints provide powerful tools for maintaining a clear overview of trading activities, enabling effective risk management, and supporting informed decision-making within your MT5 environment.

<p class="slate-p " >The Report &amp; Audit module in the MT5 Manager API provides essential functionality for generating, accessing, and managing various reports within the MetaTrader 5 platform. This module is crucial for maintaining transparency, ensuring compliance, and deriving valuable insights from trading activities.</p><h2 class="slate-h2 " >Key Concepts:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Reporting encompasses the generation and analysis of various trading-related data.</div></li><li class="slate-li " ><div style="position:relative">Auditing involves the systematic review of trading operations, financial transactions, and system activities.</div></li><li class="slate-li " ><div style="position:relative">This module facilitates both routine operational reporting and in-depth auditing processes.</div></li></ul><h2 class="slate-h2 " >Importance of Reporting &amp; Auditing in MT5:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Regulatory Compliance: Meet regulatory requirements for record-keeping and reporting.</div></li><li class="slate-li " ><div style="position:relative">Performance Analysis: Evaluate the performance of traders, agents, and overall business operations.</div></li><li class="slate-li " ><div style="position:relative">Risk Management: Identify and assess potential risks through comprehensive data analysis.</div></li><li class="slate-li " ><div style="position:relative">Business Intelligence: Gain insights to inform strategic decision-making and improve operations.</div></li><li class="slate-li " ><div style="position:relative">Transparency: Maintain clear and accurate records of all trading and financial activities.</div></li></ol><h2 class="slate-h2 " >Features:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Agent Commission Reporting: Generate detailed reports on agent/IB commissions.</div></li><li class="slate-li " ><div style="position:relative">Balance Reporting: Access comprehensive balance reports for accounts or groups.</div></li><li class="slate-li " ><div style="position:relative">Customizable Reports: Ability to generate reports based on various parameters and time frames.</div></li><li class="slate-li " ><div style="position:relative">Data Export: Export report data in various formats for further analysis or integration with other systems.</div></li><li class="slate-li " ><div style="position:relative">Audit Trail: Maintain a detailed log of system activities and changes for auditing purposes.</div></li></ol><h2 class="slate-h2 " >Available Endpoints:</h2><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Agent Commission Report: Retrieve commission data for agents and introducing brokers.</div></li><li class="slate-li " ><div style="position:relative">Balance Report: Generate reports on account balances and financial status.</div></li></ul><h2 class="slate-h2 " >Best Practices:</h2><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">Regularly schedule and review key reports to maintain ongoing awareness of your trading operations.</div></li><li class="slate-li " ><div style="position:relative">Use report data to identify trends, anomalies, or areas requiring attention in your business.</div></li><li class="slate-li " ><div style="position:relative">Ensure that all necessary stakeholders have appropriate access to relevant reports.</div></li><li class="slate-li " ><div style="position:relative">Implement a system for archiving reports to maintain historical records for compliance and analysis.</div></li><li class="slate-li " ><div style="position:relative">Regularly audit your reporting processes to ensure accuracy and completeness of data.</div></li><li class="slate-li " ><div style="position:relative">Use the insights gained from reports to continually refine and improve your trading operations and risk management strategies.</div></li></ol><p class="slate-p " >The Report &amp; Audit module is a critical component for maintaining transparency, ensuring regulatory compliance, and driving data-informed decision-making in your MT5 environment. It provides the tools necessary to gain a comprehensive understanding of your trading operations, from individual agent performance to overall financial health.</p><p class="slate-p " ></p>

The Report & Audit module in the MT5 Manager API provides essential functionality for generating, accessing, and managing various reports within the MetaTrader 5 platform. This module is crucial for maintaining transparency, ensuring compliance, and deriving valuable insights from trading activities.

Importance of Reporting & Auditing in MT5:

The Report & Audit module is a critical component for maintaining transparency, ensuring regulatory compliance, and driving data-informed decision-making in your MT5 environment. It provides the tools necessary to gain a comprehensive understanding of your trading operations, from individual agent performance to overall financial health.