Work with trading accounts

information about instruments available for account type

Error while loading OpenAPI operation — Invalid OpenAPI document

Example value of responce:

{
  "instruments": [
    {
      "symbol": "string",                  //the name of the symbol           
      "symbol_group": "string",            //the name of symbol group
      "digits": 0,                         //the number of decimal places in the price of the symbol.
      "contract_size": 0,                  //the contract size of the symbol  
      "stops_level": 0,                    //the price band, within which placing stop orders is not allowed
      "calc_mode": 0,                      //the mode of margin and profit calculation
      "trade_mode": 0,                     //the symbol trading mode
      "volume_min": 0,                     //the minimum volume of trade operations for the symbol.
      "volume_max": 0,                     //the maximum volume of trade operations for the symbol
      "volume_step": 0,                    //the volume change step for trade operations for the symbol.
      "hedged_margin": 0,                  //the value of the hedged margin
      "maintenance_margin": 0,             //the size of the maintenance margin
      "initial_margin_rate_buy": 0,        //the initial margin rate for orders of the specified type (buy)
      "initial_margin_rate_sell": 0,       //the initial margin rate for orders of the specified type (sell)
      "maintenance_margin_rate_buy": 0,    //the maintenance margin rate for orders of the specified type (buy)
      "maintenance_margin_rate_sell": 0,   //the maintenance margin rate for orders of the specified type (sell)
      "tick_size": 0,                      //the size of one tick of the symbol
      "tick_value": 0,                     //the price of one tick of the symbol
      "swap_mode": 0,                      //the swap calculation mode for the symbol
      "swap_long": 0,                      //the swap size for long positions
      "swap_short": 0,                     //the swap size for short positions
      "swap_3day": 0,                      //the triple swap day
      "sessions": {
        "additionalProp1": {
          "trade": [
            {
              "open": "00:00",
              "close": "24:00"
            }
          ],
          "quote": [
            {
              "open": "00:00",
              "close": "24:00"
            }
          ]
        },
        "additionalProp2": {
          "trade": [
            {
              "open": "00:00",
              "close": "24:00"
            }
          ],
          "quote": [
            {
              "open": "00:00",
              "close": "24:00"
            }
          ]
        },
        "additionalProp3": {
          "trade": [
            {
              "open": "00:00",
              "close": "24:00"
            }
          ],
          "quote": [
            {
              "open": "00:00",
              "close": "24:00"
            }
          ]
        }
      }
    }
  ]
}

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Create accounts with different types

create an account

post

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

leverageintegerOptional

leverage for the trading account

Example: 100

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

Responses

200

an account was successfully created

application/json

400

bad arguments in the request, account is not available for creation

500

method is not able to make new account

post

/accounts/demo

HTTPcURLJavaScriptPython

POST /api/v2/fxtr/accounts/demo?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "leverage": 100,
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!"
}

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "accountid": "1234"
}

create an account

post

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

leverageintegerOptional

leverage for the trading account

Example: 100

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

Responses

200

an account was successfully created

application/json

400

bad arguments in the request, account is not available for creation

500

method is not able to make new account

post

/accounts/default

HTTPcURLJavaScriptPython

POST /api/v2/fxtr/accounts/default?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "leverage": 100,
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!"
}

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "accountid": "1234"
}

create an account

post

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

leverageintegerOptional

leverage for the trading account

Example: 100

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

min_depositnumberRequired

minimum amount of trading balance to start copy strategy, default 1000

Example: 1000

min_copy_rationumberRequired

min copy ratio available for the strategy, default 1

Example: 1

max_copy_rationumberRequired

max copy ratio available for the strategy, default 10

Example: 10

commissionnumberRequired

commission charged from successful sessions, default 10%

Example: 10

Responses

200

an account was successfully created

application/json

400

bad arguments in the request, account is not available for creation

500

method is not able to make new account

post

/accounts/master

HTTPcURLJavaScriptPython

POST /api/v2/fxtr/accounts/master?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "leverage": 100,
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!",
  "min_deposit": 1000,
  "min_copy_ratio": 1,
  "max_copy_ratio": 10,
  "commission": 10
}

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "accountid": "1234"
}

create an account

post

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

master_account_idstringRequired

master account id that strategy will be copied

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

copy_rationumberRequired

copy ratio to apply for deals from shared trading strategy, -1 means auto calculation from balances proportion

Example: -1

is_enablebooleanRequired

binary flag to activate copying for next session

Example: true

Responses

200

an account was successfully created

application/json

400

bad arguments in the request, account is not available for creation

500

method is not able to make new account

post

/accounts/investor

HTTPcURLJavaScriptPython

POST /api/v2/fxtr/accounts/investor?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!",
  "master_account_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "copy_ratio": -1,
  "is_enable": true
}

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "accountid": "1234"
}

Delete an account

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Update account parameters

update account parameters

patch

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

accountidstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

leverageintegerOptional

leverage for the trading account

Example: 100

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

Responses

200

an account was successfully updated

application/json

500

method is not able to update account

patch

/accounts/demo/{accountid}

HTTPcURLJavaScriptPython

PATCH /api/v2/fxtr/accounts/demo/{accountid}?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "leverage": 100,
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!"
}

{
  "accountid": "1234"
}

update account parameters

patch

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

accountidstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

leverageintegerOptional

leverage for the trading account

Example: 100

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

Responses

200

an account was successfully updated

application/json

500

method is not able to update account

patch

/accounts/default/{accountid}

HTTPcURLJavaScriptPython

PATCH /api/v2/fxtr/accounts/default/{accountid}?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 217

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "leverage": 100,
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!"
}

{
  "accountid": "1234"
}

update account parameters

patch

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

accountidstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

leverageintegerOptional

leverage for the trading account

Example: 100

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

min_depositnumberRequired

minimum amount of trading balance to start copy strategy, default 1000

Example: 1000

min_copy_rationumberRequired

min copy ratio available for the strategy, default 1

Example: 1

max_copy_rationumberRequired

max copy ratio available for the strategy, default 10

Example: 10

commissionnumberRequired

commission charged from successful sessions, default 10%

Example: 10

Responses

200

an account was successfully updated

application/json

500

method is not able to update account

patch

/accounts/master/{accountid}

HTTPcURLJavaScriptPython

PATCH /api/v2/fxtr/accounts/master/{accountid}?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 291

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "leverage": 100,
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!",
  "min_deposit": 1000,
  "min_copy_ratio": 1,
  "max_copy_ratio": 10,
  "commission": 10
}

{
  "accountid": "1234"
}

update account parameters

patch

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

accountidstringRequired

Query parameters

server_codestringRequired

Body

application/json

external_idstringRequired

external id reference for account

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

account_type_keystringOptional

name of the group

Example: demo\rockwest\rw502_rwstagedemo_usd

namestringOptional

name of the account

Example: demo account

trading_passstringOptional

password for MT to login as a trader

Example: !StrongTrader!

investor_passstringOptional

password for MT to login as an investor

Example: !StrongInvestor!

master_account_idstringRequired

master account id that strategy will be copied

Example: ec2930bb-c200-4a2d-9f1f-3e938e39de54

copy_rationumberRequired

copy ratio to apply for deals from shared trading strategy, -1 means auto calculation from balances proportion

Example: -1

is_enablebooleanRequired

binary flag to activate copying for next session

Example: true

Responses

200

an account was successfully updated

application/json

500

method is not able to update account

patch

/accounts/investor/{accountid}

HTTPcURLJavaScriptPython

PATCH /api/v2/fxtr/accounts/investor/{accountid}?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 294

{
  "external_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "account_type_key": "demo\\rockwest\\rw502_rwstagedemo_usd",
  "name": "demo account",
  "trading_pass": "!StrongTrader!",
  "investor_pass": "!StrongInvestor!",
  "master_account_id": "ec2930bb-c200-4a2d-9f1f-3e938e39de54",
  "copy_ratio": -1,
  "is_enable": true
}

{
  "accountid": "1234"
}

Get transactions

Get a list of transactions for the account

get a list of transaction for the account (trading and balance) in specified time interval GMT

get

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

accountidstringRequired

Query parameters

server_codestringRequired

fromintegerOptional

unix time in ms

tointegerOptional

unix time in ms

isAscbooleanOptional

sorting type

Responses

200

list of transactions

application/json

400

bad arguments in the request, {accounttype} or {accountid} is not available

get

/transactions/demo/{accountid}/info

HTTPcURLJavaScriptPython

GET /api/v2/fxtr/transactions/demo/{accountid}/info?server_code=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "transaction_list": []
}

In query parameter IsAsc can be false - descrease sort or true - increase sort.

When there are no transactions for account in requested time range (including case when there are no deals for account at all) response with empty transactions list will be returned.

Example of responce:

{
  "transaction_list": [
    {
            "time_from_mt": 1695217756531,         // time when the deal was received from MT
            "balance": 1000.040000,                // current balance of the trading account
            "equity": 995.780000,                  // current equity of the trading account
            "floating": -4.260000,                 // floating of the account (at the moment of the deal is got from server)
            "free_margin": 985.110000,             // margin of the trading account that can be used (at the moment of the deal is got from server)  
            "margin": 10.670000,                   // margin of the trading account
            "credit": 0.000000,                    // current credit of the trading account
            "leverage": 100,                       // leverage of user trading account
            "agent": 0,                            // agent account number  
            "account": "0000024545780030",         // account id
            "group_name": "demo\\Standard",        // group name of the account where the deal was opened
            "deal_id": 13941725,                   // deal ID     
            "order_id": 0,                         // order ID
            "position_id": 0,                      // position ID 
            "login": "87630",                      // Login of the account (who the deal was opened) 
            "time": 1692773281171,                 // Time of the deal opening (in seconds)
            "is_entry": false,                     // see description below
            "action": "balance",                   // see description below   
            "type": 2,                             // see description below 
            "symbol": "",                          // symbol of the deal
            "price": 0.000000,                     // price of the deal
            "tp": 0.000000,                        // take profit of the deal
            "sl": 0.000000,                        // stop loss of the deal
            "volume": 0.000000,                    // volume of the deal    
            "profit": 1000.000000,                 // profit of the deal
            "swap": 0.000000,                      // swap of the deal  
            "commission": 0.000000,                // commission of the deal
            "fee": 0.000000,                       // fee of the deal
            "profit_raw": 0.000000,                // raw profit of the deal
            "profit_rate": 0.000000,               // profit rate of the deal
            "margin_rate": 0.000000,               // margin rate of the deal
            "comment": "test",                     // comment of the deal
            "gateway": "",                         // gateway
            "reason": 2,                           // reason of the deal
            "dealer": 2124,                        // The login of a dealer, who has processed a deal.
            "time_sent_nats": 1695217756710,       // time when the deal was sent to NAT
    }
  ]
}

Description of parameters

Parameter	Type	Discription
is_entry	boolean	TRUE if and only then when a new position is opened by the user ( it means entering the market); in all other cases it is equal to FALSE. For example for MT5 is_entry = TRUE when parameter entry=ENTRY_IN in IMTDeal structure.
action	string	buy - buy transaction sell - sell trasnsaction bonus - bonus, if the word 'bonus' appears in the transaction comment credit - account credit operation (for MT5 if the Action=DEAL_CREDIT in the IMTDeal structure takes the value DEAL_CREDIT) negative_balance_compensation - operation related to compensation of a negative balance (for MT5 if the Action=DEAL_SO_COMPENSATION in IMTDeal structure) balance - operations to change the account balance (for MT5, if the Action field in the IMTDeal structure takes the following values DEAL_BALANCE, DEAL_CHARGE, DEAL_CORRECTION, DEAL_BONUS, DEAL_COMMISSION, DEAL_COMMISSION_DAILY, DEAL_COMMISSION_MONTHLY) In all other cases, for MT5, the string value of the Action field of the IMTDeal structure is passed.

For MT4 plugin the parameter type can be:

OP_BUY	0
OP_SELL	1
OP_BUY_LIMIT	2
OP_SELL_LIMIT	3
OP_BUY_STOP	4
OP_SELL_STOP	5
OP_BALANCE	6
OP_CREDIT	7

For MT5 plugin the parameter type can be:

DEAL_BUY	0	A Buy deal
DEAL_SELL	1	A Sell deal
DEAL_BALANCE	2	A balance operation
DEAL_CREDIT	3	Credit operation
DEAL_CHARGE	4	Additional charges/withdrawals
DEAL_CORRECTION	5	Correcting operations
DEAL_BONUS	6	Operations of this type affect the credit assets of a client (IMTUser::Credit)
DEAL_COMMISSION	7	Commission
DEAL_COMMISSION_DAILY	8	Daily commission
DEAL_COMMISSION_MONTHLY	9	Monthly commission
DEAL_AGENT_DAILY	10	Daily agent commission
DEAL_AGENT_MONTHLY	11	Daily agent commission
DEAL_INTERESTRATE	12	Accrual of annual interest
DEAL_BUY_CANCELED	13	A canceled Buy deal. Using the IMTExecution::TE_DEAL_CANCEL trade execution, the Gateway API can notify the platform about the cancellation of a previously executed deal in the external trading system. In this case the type of the earlier executed Buy trade is replaced with this one. The profit/loss of a trade is cleared. Then the client's position is recalculated and the appropriate profit/loss is added/subtracted as a separate balance operation. Deal cancellation does not change the client's order history. Deal cancellation does not entail changes in client's orders history. A deal of the DEAL_BUY_CANCELED type is not included into the calculation of the financial state of account and is not taken into account in recalculated positions.
DEAL_SELL_CANCELED	14	A canceled Sell deal. Using the IMTExecution::TE_DEAL_CANCEL trade execution, the Gateway API can notify the platform about the cancellation of a previously executed deal in the external trading system. In this case the type of the earlier executed Buy trade is replaced with this one. The profit/loss of a trade is cleared. Then the client's position is recalculated and the appropriate profit/loss is added/subtracted as a separate balance operation. Deal cancellation does not change the client's order history. Deal cancellation does not entail changes in client's orders history. A deal of the DEAL_SELL_CANCELED type is not included into the calculation of the financial state of account and is not taken into account in recalculated positions.
DEAL_DIVIDEND	15	Dividend operations
DEAL_DIVIDEND_FRANKED	16	Franked (non-taxable) dividend operations (tax is paid by a company, not a client).
DEAL_TAX	17	Charging a tax
DEAL_AGENT	18	Charging an agent commission. Used during an instant commission charge to an agent (each time the agent's client performs a deal.
DEAL_SO_COMPENSATION	19	An operation connected with the compensation of a negative account after the Stop Out event (IMTConGroup::TRADEFLAGS_SO_COMPENSATION).

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Get detail information about specified transaction

Error while loading OpenAPI operation — Invalid OpenAPI document

Example of responce:

{
  "id": "21112"      //transaction's identifier
}

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Getting balance information

Error while loading OpenAPI operation — Invalid OpenAPI document

Example of responce:

{
  "name": "demo account",
  "group": "demo\\\\group\\\\for\\\\demo",
  "leverage": 100,                          // Leverage of the account 
  "type": "default",
  "login": "20069",                         // Login of the account 
  "balance": 0,                             // Balance of the account 
  "equity": 0,                              // Equity of the account 
  "margin": 0,                              // Margin of the account 
  "floating": 0,                            // Floating of the account 
  "swap": 0                                 // Swap of the deal
}

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Change balance

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

Error while loading OpenAPI operation — Invalid OpenAPI document

If method isn't enabled through environment variables, the request will be always http error code 404.