Xtbapiserver Wgv

XTBApiServer is an XTB trading API server based on the MCP protocol, built with Node.js. It provides functions such as account management, market data, and trading operations, and supports interaction through MCP clients.

Finance Developer tools #Trading API #MCP service #XTB interface #Financial tools Remote .JavaScript

rating : 2 points

downloads : 7

update time : 2025-04-23

What is XTBApiServer?

XTBApiServer is a middleware server based on the Model Context Protocol (MCP). It encapsulates the API functions of the XTB trading platform into standardized MCP interfaces. Through this server, both developers and non - technical users can access XTB's trading functions in a unified way without directly dealing with complex API calls.

How to use XTBApiServer?

To use XTBApiServer, you need to configure XTB account information first, and then connect to the server through an MCP client (such as MCP Inspector). After connecting, you can execute trading operations, query market data, etc. by sending standardized commands.

Applicable scenarios

It is suitable for scenarios such as application development that requires integrating XTB trading functions, implementation of automated trading strategies, and market data analysis. It is especially suitable for developers who want to avoid dealing with the complexity of the XTB native API directly.

Main features

Account operationsProvide functions such as querying account information and viewing margin levels.

Market dataObtain real - time quotes, historical data, trading hours, etc.

Trading operationsExecute trades, query trade status, and get historical trade records.

Calculation toolsCalculate commissions, margins, and expected profits.

Advantages and limitations

Advantages

Standardized interface: Provide a unified access method through the MCP protocol.

Simplified development: Hide the complexity of the XTB API.

Flexibility: Support connections from multiple MCP clients.

Comprehensive functions: Cover the main functions of the XTB platform.

Limitations

Depend on the availability and limitations of the XTB API.

Require maintenance of the server operating environment.

Real - time performance is affected by network conditions.

How to use

Installation preparation

Ensure that Node.js (16+) and npm are installed, and clone the project repository.

Configure the account

Create a.env file in the project directory and fill in the XTB account information.

Start the server

Build and run the server.

Connect the client

Use a client such as MCP Inspector to connect to the server.

Usage examples

Query account balanceGet the basic account information, including balance and leverage, through the getCurrentUserData command.

Calculate trading costsUse getCommissionDef to calculate the commission cost for a specific trading symbol and volume.

Get real - time quotesGet the latest quotes for a specified trading symbol through getTickPrices.

Frequently Asked Questions

What is the difference between setting DEMO_ACCOUNT to true and false?

How to know if the server is running normally?

How to confirm the status after a trade is executed?

What is the timestamp format when getting historical data?

Related resources

XTB official API documentation

The official API documentation of the XTB trading platform.

MCP protocol specification

The official specification document of the Model Context Protocol.

MCP Inspector tool

A visualization tool for connecting and testing MCP servers.

Sample project repository

The source code and examples of XTBApiServer.

🚀 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

This MCP server exposes the XTB API, enabling interaction with XTB trading accounts using the Model Context Protocol. It provides a variety of tools for account operations, calculations, market data retrieval, and more.

📦 Installation

Prerequisites

Node.js (version 16 or higher)
npm
An XTB trading account

Steps

Clone this 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 live 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 connect to this server using any MCP client (e.g., MCP Inspector).

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

💻 Usage Examples

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 commissions 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 based on the given trading data.
- Parameters: closePrice (number), cmd (number), openPrice (number), symbol (string), volume (number)

Market Data Operations

getCalendar: Returns the market event calendar.
getChartLastRequest: Returns chart information from the start date to the current time.
- Parameters: info (any)
getChartRangeRequest: Returns chart information for a specified time period.
- Parameters: info (any)
getOHLCV: Retrieves the open, high, low, and close data for a given instrument.
- Parameters: symbol (string), start (number), end (number)