Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

mt5-sdk

hamzaaslam-cs51MIT1.0.2

A Node.js SDK for interacting with the MetaTrader 5 Web API, enabling seamless integration of MetaTrader 5 trading features into your applications.

MetaTrader 5, MT5, Web API, SDK, trading, Node.js

readme

Metatrader5 SDK Example

This is a simple example of how to use the Metatrader5 SDK to interact with a MetaTrader 5 trading platform.

Installation

To use this example, you need to have Node.js installed on your system. If you haven't already, you can download it from nodejs.org.

Next, you can install the mt5-sdk package by running the following command in your project directory:

npm install mt5-sdk

Create an Instance

define metatrader instance

const Metatrader5 = require('mt5-sdk')
// ...
const mt5Instance = new Metatrader5('your.host.com', 443, {
    login: "API_USER_LOGIN",
    password: "API_USER_PASS",
    build: "VERSION",
    agent: "AGENT_NAME_FOR_TRACKING"
});
// ...

User Library Example

const mt5Instance = new MT5Request('your.host.com', 443, {
    login: "API_USER_LOGIN",
    password: "API_USER_PASS",
    build: "VERSION",
    agent: "AGENT_NAME_FOR_TRACKING"
});

async func(){
    await mt5Instance.user.get("USER_LOGIN")
}

Available API

Library Function Description Return
user get("USER_LOGIN") get user information Object
user checkPassword("USER_LOGIN", "USER_PASSWORD", "PASSWORD_TYPE") check users password Boolean
user changePassword("USER_LOGIN", "CURRENT_PASSWORD", "NEW_PASSWORD", "PASSWORD_TYPE") check users password Boolean