Xtb MCP Server

The XTBApiServer is an XTB trading API server based on the MCP protocol, providing functions such as account management, market data, and trading operations.

Finance Developer tools #Trading API #MCP Service #XTB Interface Remote .JavaScript

rating : 2.5 points

downloads : 10

update time : 2025-04-28

What is the XTB API MCP Server?

The XTB API MCP Server is a Node.js-based tool that allows you to interact with your XTB trading account via the Model Context Protocol (MCP). It provides a rich set of API interfaces, supporting functions such as market data query, account management, and trading operations.

How to use the XTB API MCP Server?

1. Install the necessary dependency environment (e.g., Node.js). 2. Configure your XTB account credentials. 3. Start the server and connect using an MCP client. 4. Use the provided APIs to perform the required operations.

Applicable Scenarios

Suitable for professional traders who wish to automate trading strategies, monitor market dynamics, or manage accounts in bulk.

Main Features

Account OperationsGet key indicators such as account information and margin levels.

Calculation OperationsEstimate commissions, margin requirements, and potential earnings.

Market Data OperationsGet real-time market quotes, historical charts, and trading hours.

News OperationsSubscribe to and receive the latest market news.

Server OperationsCheck the server status and version information.

Symbol OperationsQuery information about specific financial instruments.

Trading OperationsView, manage, and close orders.

Trading FunctionsExecute new orders or query the status of current orders.

Command ExecutionRun custom commands directly on the server.

Advantages and Limitations

Advantages

Supports MCP clients in multiple languages

Easy to integrate into existing systems

Provides detailed API documentation and examples

Open source and free to use

Limitations

Requires a certain level of programming knowledge

Only supports the XTB platform

May involve high trading risks

How to Use

Install Dependencies

Ensure that Node.js and npm are installed, then clone this repository and install the dependencies.

Configure Account Information

Create a `.env` file and fill in your XTB account credentials.

Start the Server

Build the project and run the server.

Connect the Client

Connect to the server using the MCP Inspector or other supported clients.

Usage Examples

Get Account DataGet the account balance and leverage information via the API.

Query a Specific SymbolQuery detailed information about a currency pair (e.g., 'EURUSD').

Execute a TradeSimulate a buy operation.

Frequently Asked Questions

Does it support real accounts?

How to securely store my API key?

Will the server be updated automatically?

Related Resources

XTB API Documentation

Official XTB API documentation

MCP Inspector

A tool for testing MCP servers

GitHub Repository

The open-source code repository for this project

🚀 XTBApiServer

This is an MCP server that exposes the XTB API using the @sharplygroup/xtb-api-js library. It allows you to interact with your XTB trading account via the Model Context Protocol.

🚀 Quick Start

✨ Features

Exposes XTB API through MCP server.
Allows interaction with XTB trading accounts.

📦 Installation

Prerequisites:
- Node.js (version 16 or higher)
- npm
- An XTB trading account
Clone the repository:
```
git clone [repository_url]
```
Navigate to the project directory:
```
cd xtb-mcp-server
```
Install dependencies:
```
npm install
```

⚙️ Configuration

Create a .env file in the project directory and add your XTB API credentials:
```
DEMO_ACCOUNT=true
USER_ID=your_user_id
PASSWORD=your_password
```
⚠️ Important Note

Replace your_user_id and your_password with your actual XTB API credentials. Set DEMO_ACCOUNT to false if you are using a real account.

▶️ Running the Server

Build the TypeScript code:
```
npm run build
```
Start the server:
```
node build/index.js
```

🔗 Connecting with an MCP Client

You can use any MCP client (e.g., MCP Inspector) to connect to this server.

Install MCP Inspector globally:

npm install -g @modelcontextprotocol/inspector

Run MCP Inspector with your server:

npx @modelcontextprotocol/inspector node build/index.js

In the MCP Inspector UI, select "stdio" as the transport type and click "Connect".

🛠️ Available Tools

This MCP server exposes the following tools:

Account Operations

getCurrentUserData: Returns information about the account currency and account leverage.
getMarginLevel: Returns various account metrics.

Calculation Operations

getCommissionDef: Calculates commission and exchange rates.
- Parameters: symbol (string), volume (number)
getMarginTrade: Returns the expected margin based on the given instrument and quantity.
- Parameters: symbol (string), volume (number)
getProfitCalculation: Calculates the estimated profit for the given trading data.
- Parameters: closePrice (number), cmd (number), openPrice (number), symbol (string), volume (number)

Market Data Operations

getCalendar: Returns the calendar and market events.
getChartLastRequest: Returns chart information from the start date to the current time.
- Parameters: info (any)
getChartRangeRequest: Returns chart data based on the given start and end dates.
- Parameters: info (any)
getSymbolInfoPrompt: Retrieves information about a specific instrument.

⚠️ Warning

This MCP server is provided as an example. Use it at your own risk. Make sure you understand the XTB API and its potential risks before using this server with a real account.