{"info":{"_postman_id":"300d0da9-24e0-4c2c-b703-6675905875b1","name":"ActTrader trading API","description":"

api endpoints

\n
    \n
  1. Rest api - http://rest-api.sysfx.com:18001/
    2. \n
  2. Web socket messages streaming - ws://stream.sysfx.com:18002/
    3. \n
\n

all dates are in Eastern Time (EST/EDT)

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3505164","collectionId":"300d0da9-24e0-4c2c-b703-6675905875b1","publishedId":"SVtYTnGT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-12-31T10:51:17.000Z"},"item":[{"name":"account","item":[{"name":"accounts","id":"62dff3d4-8930-469b-8e9f-3bb0e1dbbfa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/account/accounts?token=YoC1Buiy","description":"

Get all accounts that you currently have.

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [\n        {\n            \"AccountID\": 100,\n            \"Balance\": 100000000,\n            \"TraderID\": 178,\n            \"Currency\": \"USD\",\n            \"UsedMargin\": 0,\n            \"Reserved\": 0\n        },\n        {\n            \"AccountID\": 1414,\n            \"TraderID\": 178,\n            \"Balance\": 100000000,\n            \"Currency\": \"USD\",\n            \"UsedMargin\": 0,\n            \"Reserved\": 0\n        },\n        {\n            \"AccountID\": 1415,\n            \"TraderID\": 178,\n            \"Balance\": 100000000,\n            \"Currency\": \"EUR\",\n            \"UsedMargin\": 0,\n            \"Reserved\": 0\n        },\n        {\n            \"AccountID\": 125,\n            \"TraderID\": 178,\n            \"Balance\": 100000000,\n            \"Currency\": \"USD\",\n            \"UsedMargin\": 0,\n            \"Reserved\": 0\n        }\n    ]\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","account","accounts"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"62dff3d4-8930-469b-8e9f-3bb0e1dbbfa5"},{"name":"changepassword","id":"6f2f7750-767d-453e-8383-dd5bd65e4048","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"realm","value":""},{"key":"nonce","value":""},{"key":"algorithm","value":""},{"key":"qop","value":""},{"key":"nonceCount","value":""},{"key":"clientNonce","value":""},{"key":"opaque","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://server-address:port/api/v2/account/changepassword?oldpassword=old&newpassword=new&token=aXiLklXq","urlObject":{"protocol":"http","port":"port","path":["api","v2","account","changepassword"],"host":["server-address"],"query":[{"description":{"content":"

old password

\n","type":"text/plain"},"key":"oldpassword","value":"old"},{"description":{"content":"

new password

\n","type":"text/plain"},"key":"newpassword","value":"new"},{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"aXiLklXq"}],"variable":[]}},"response":[],"_postman_id":"6f2f7750-767d-453e-8383-dd5bd65e4048"}],"id":"a92d4b77-59e0-47d5-9121-dfe39632c252","_postman_id":"a92d4b77-59e0-47d5-9121-dfe39632c252","description":""},{"name":"alert - deprecated","item":[{"name":"alerts","id":"09da749e-9357-43af-8046-be3bbad9c47e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/alert/alerts?token=YoC1Buiy","description":"

Get all active alerts

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [{\n        \"AlertID\": 111,\n        \"Symbol\": \"EUR/USD\",\n        \"Price\": 1.17,\n        \"Type\": \"BID\",\n        \"Commentary\": \"some text\"\n    }]\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","alert","alerts"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"09da749e-9357-43af-8046-be3bbad9c47e"},{"name":"create","id":"2586276b-f3c4-4059-9bbe-20d4770676e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/alert/create?token=YoC1Buiy&symbol =EUR/USD&price=1.1803&type=BID&commentary=some text","description":"

Create new alert

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"AlertID\": 111\n    }\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","alert","create"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"},{"description":{"content":"

symbol name

\n","type":"text/plain"},"key":"symbol ","value":"EUR/USD"},{"description":{"content":"

alert price

\n","type":"text/plain"},"key":"price","value":"1.1803"},{"description":{"content":"

BID or ASK

\n","type":"text/plain"},"key":"type","value":"BID"},{"description":{"content":"

alert commentary

\n","type":"text/plain"},"key":"commentary","value":"some text"}],"variable":[]}},"response":[],"_postman_id":"2586276b-f3c4-4059-9bbe-20d4770676e3"},{"name":"modify","id":"2a2da8ed-db27-46c7-b1de-361f4d2b99a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/alert/modify?token=YoC1Buiy&alert_id=123&price=1.1803&type=BID&commentary=some text","description":"

Update alert

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"AlertID\": 111\n    }\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","alert","modify"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

alert id

\n","type":"text/plain"},"key":"alert_id","value":"123"},{"description":{"content":"

alert price

\n","type":"text/plain"},"key":"price","value":"1.1803"},{"description":{"content":"

BID or ASK

\n","type":"text/plain"},"key":"type","value":"BID"},{"description":{"content":"

alert commentary

\n","type":"text/plain"},"key":"commentary","value":"some text"}],"variable":[]}},"response":[],"_postman_id":"2a2da8ed-db27-46c7-b1de-361f4d2b99a9"},{"name":"remove","id":"3404140d-dbfd-493f-ac8c-4a157b4a58c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/alert/remove?token=YoC1Buiy&alert_id=111","description":"

Remove particular alert.

\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","alert","remove"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"},{"key":"alert_id","value":"111"}],"variable":[]}},"response":[],"_postman_id":"3404140d-dbfd-493f-ac8c-4a157b4a58c9"},{"name":"triggered","id":"7488b7ef-3f74-45a2-8c2b-3c3866e75e41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/alert/triggered?token=YoC1Buiy&from=YYYYMMDDHH24MI&till=YYYYMMDDHH24MI","description":"

Get all triggered alerts

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [{\n        \"AlertID\": 113,\n        \"Symbol\": \"EUR/USD\",\n        \"Price\": 1.19,\n        \"Type\": \"BID\",\n        \"Triggered\": \"2021-09-15T08:37:24\",\n                \"Commentary\": \"some text\"\n    }]\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","alert","triggered"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"},{"description":{"content":"

from date

\n","type":"text/plain"},"key":"from","value":"YYYYMMDDHH24MI"},{"description":{"content":"

till date

\n","type":"text/plain"},"key":"till","value":"YYYYMMDDHH24MI"}],"variable":[]}},"response":[],"_postman_id":"7488b7ef-3f74-45a2-8c2b-3c3866e75e41"}],"id":"2e4e94e3-bf58-4ed8-bb46-da6ae8a7c9a6","_postman_id":"2e4e94e3-bf58-4ed8-bb46-da6ae8a7c9a6","description":""},{"name":"auth","item":[{"name":"token","id":"64b4f7be-7e02-49bf-83c1-3cac89c6230c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"digest","digest":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"realm","value":""},{"key":"nonce","value":""},{"key":"algorithm","value":""},{"key":"qop","value":""},{"key":"nonceCount","value":""},{"key":"clientNonce","value":""},{"key":"opaque","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"http://server-address:port/api/v2/auth/token?lifetime=20","description":"

Performing a simple GET request to this endpoint returns status code 401 Unauthorized with WWW-Authenticate header containing information to successfully authenticate subsequent requests. The WWW-Authenticate header must be processed to extract realm and nonce values to hash subsequent requests.

\n
{\n    \"success\": true,\n    \"message\": \"token\",\n    \"result\": \"cW6gzixF\"\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","auth","token"],"host":["server-address"],"query":[{"description":{"content":"

token life time in minutes

\n","type":"text/plain"},"key":"lifetime","value":"20"}],"variable":[]}},"response":[],"_postman_id":"64b4f7be-7e02-49bf-83c1-3cac89c6230c"},{"name":"logout","id":"91b18770-d8e2-4121-94ee-c8fefeca2402","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://server-address:port/api/v2/auth/logout?token=dad34wr","description":"

Revoke token

\n
{\n    \"success\": true\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","auth","logout"],"host":["server-address"],"query":[{"key":"token","value":"dad34wr"}],"variable":[]}},"response":[],"_postman_id":"91b18770-d8e2-4121-94ee-c8fefeca2402"},{"name":"reset","id":"941d0e08-31c6-40d5-b116-6d29f1172b64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"http://server-address:port/api/v2/auth/reset?login=user_login_id","description":"

Reset user password, and sent by email.

\n
{\n    \"success\": true\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","auth","reset"],"host":["server-address"],"query":[{"key":"login","value":"user_login_id"}],"variable":[]}},"response":[],"_postman_id":"941d0e08-31c6-40d5-b116-6d29f1172b64"}],"id":"f1fce098-b5f4-4b2f-abba-34c0e59489ca","_postman_id":"f1fce098-b5f4-4b2f-abba-34c0e59489ca","description":""},{"name":"market","item":[{"name":"instruments","id":"5debb88b-1ae8-4c35-9f11-127ba79218bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/market/instruments?token=YoC1Buiy&active=Y","description":"

Get the list of instruments (symbols) available to the user, inluding the unique instrument ID, name, type and status (active or inactive)

\n
\"success\": true,\n\"result\": [\n        {\n            \"id\": 161\n            \"Name\": \"EURUSD\",\n            \"Type\": \"FX\",\n            \"Active\": \"Y\",\n}]\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","market","instruments"],"host":["server-address"],"query":[{"description":{"content":"

user token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

Y or N

\n","type":"text/plain"},"key":"active","value":"Y"}],"variable":[]}},"response":[],"_postman_id":"5debb88b-1ae8-4c35-9f11-127ba79218bf"},{"name":"symbols","id":"eb795e75-78fe-4949-b2f6-f8d879938a5e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/market/symbols?token=YoC1Buiy","description":"

Used to get the available trading symbols at ActTrader along with other meta data

\n

responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [\n        {\n            \"Symbol\": \"EURUSD\",\n            \"BaseCurrency\": \"EUR\",\n            \"QuoteCurrency\": \"USD\",\n            \"Description\": \"\",\n            \"Active\": \"Y\",\n            \"MinTradeSize\": 100,\n            \"Precision\": 0.00001,\n            \"ContractSize\": 10000,\n            \"Buy\": 1.10778,\n            \"Sell\": 1.10775,\n            \"PriceDate\": \"2019-10-16T13:18:33.878000000\"\n            \"Group\": \"Forex Majors\"\n            \"Type\": \"FX\"\n        }]\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","market","symbols"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"eb795e75-78fe-4949-b2f6-f8d879938a5e"},{"name":"symbols2","id":"797e669c-2d58-4136-8d1d-70a248fa5bec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/market/symbols2?token=YoC1Buiy","description":"

Used to get the available trading symbols at ActTrader along with detailed symbol info.

\n

responce

\n
{\n    \"success\": true,\n    \"result\": [{\n        \"Pair label\": \"EURUSD\",\n        \"Description\": \"Euro vs US Dollar\",\n        \"Base currency\": \"EUR\",\n        \"Quote currency\": \"USD\",\n        \"Instrument type\": \"FX\",\n        \"Group name\": \"FX\",s\n        \"Contract size\": 100000,\n        \"Min volume\": 1000,\n        \"Max volume\": 2000000000,\n        \"Point size\": 0.0001,\n        \"Price format\": 0.00001,\n        \"Spread\": \"floating\",\n        \"Condition distance\": 5,\n        \"Buy Shift\": 5,\n        \"Sell Shift\": -5,\n        \"Margin settings\": {\n            \"Type\": \"%\",\n            \"Rate\": 0.5,\n            \"Discount coeff\": 1,\n            \"Lots limit 1\": 1000000,\n            \"Coeff 1\": 1,\n            \"Lots limit 2\": 10000000,\n            \"Coeff 2\": 1\n        },\n        \"Overnight rollover type\": \"$\",\n        \"Overnight rollover sell\": 0.6,\n        \"Overnight rollover buy\": -2.22,\n        \"Execution\": \"Market\",\n        \"GTC mode\": \"Good till canceled\",\n        \"Filling\": \"AON, All-or-None\",\n        \"Trading pause\": [{\n            \"Week day\": \"all days\",\n            \"Pause begin\": \"17:00\",\n            \"Pause end\": \"17:05\",\n            \"Timezone\": \"EST5EDT\"\n        }],\n        \"Commission\": {\n            \"Type\": \"fixed;USD\",\n            \"Value\": 1\n        }\n    }]\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","market","symbols2"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"797e669c-2d58-4136-8d1d-70a248fa5bec"},{"name":"shifts","id":"9cf420c7-9a44-4fcc-bf17-a4fe267e49c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/market/shifts?token=YoC1Buiy","description":"

Price Shifts allow modification of bid and ask instrument rates (and resulting spreads) for individual traders. Shifts are set up in pips and can be negative and positive: Bid shift is added to the Dealer's Bid prices and Ask Shift is added to the Dealer's Ask prices. They are set up individually per instrument/office/user and affect the market prices displayed to the user, as well as the execution prices.
Condition Distance is the minimum distance (in pips), at which Stop/Limit/Entry orders can be placed.

\n

responce

\n
{\n    \"success\": true,\n    \"result\": [{\n        \"Pair label\": \"EURUSD\",\n        \"Base currency\": \"EUR\",\n        \"Quote currency\": \"USD\",\n        \"Condition distance\": 2,\n        \"Buy Shift\": 10\n        \"Sell Shift\": 10   \n    }]\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","market","shifts"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"9cf420c7-9a44-4fcc-bf17-a4fe267e49c2"}],"id":"68581280-9b68-4fd3-9579-2ad868653ee7","_postman_id":"68581280-9b68-4fd3-9579-2ad868653ee7","description":""},{"name":"streaming","item":[{"name":"ws","id":"d28b0efc-d28a-431e-9b0c-cb2f5059db71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"ws://server-address:port/ws?token=YoC1Buiy","description":"

subscribe for markets command

\n
{\"m\": \"subscribe\", \"p\": [\"BTC-USD\", \"GBPUSD\", \"USDJPY\"]}\n\n
\n

unsubscribe from markets command

\n
{\"m\": \"unsubscribe\", \"p\": [\"BTC-USD\", \"GBPUSD\", \"USDJPY\"]}\n\n
\n

ticker message

\n
{\n    \"event\": \"ticker\",\n    \"payload\": [{\n        \"m\": \"BTC-USD\",\n        \"time\": \"2020-05-06T12:03:24.03071147Z\",\n        \"bid\": 9375.196,\n        \"ask\": 9379.384\n    }]\n}\n\n
\n

orderbook message

\n
{\n    \"event\": \"orderbook\",\n    \"payload\": [{\n        \"m\": \"BTC-USD\",\n        \"buy\": [{\n            \"Quantity\": \"0.17\",\n            \"Rate\": \"9351.939\"\n        }, {\n            \"Quantity\": \"1.4304\",\n            \"Rate\": \"9356.304\"\n        }],\n        \"sell\": [{\n            \"Quantity\": \"0.2\",\n            \"Rate\": \"9364.922\"\n        }, {\n            \"Quantity\": \"0.10678387\",\n            \"Rate\": \"9361.752\"\n        }]\n    }]\n}\n\n
\n

Order message example

\n
{\"event\":\"order\",\"payload\":{\"AccountID\":224,\"Action\":\"I\",\"OpenTime\":\"2019-10-16T07:10:10.933277000\",\"OrderID\":72785839,\"Pending\":\"N\",\"Price\":1.10277,\"Quantity\":100,\"Side\":0,\"Symbol\":\"EURUSD\",\"TradeID\":null,\"Type\":\"I\",\"Commentary\":\"some text\"}}\n\n
\n

order message format

\n
|parameter |type  |required|description                       |\n|----------|------|--------|----------------------------------|\n|event     |string|    +   |event name                        |\n|payload   |object|    +   |object structure                  |\n|AccountID |int   |    -   |account identifier                |\n|Action    |char  |    +   |I-insert, U-update, D-delete      |\n|OpenTime  |date  |    -   |order opening date                |\n|OrderId   |int   |    +   |order identifier                  |\n|Pending   |char  |    -   |is order already pending          |\n|Price     |double|    -   |order price                       |\n|Quantity  |double|    -   |order amount                      |   \n|Side      |int   |    -   |order side (0-sell, 1-buy)        |\n|Symbol    |string|    -   |instrument symbol name            |\n|ToClose   |int   |    -   |closing trade or order  identifier|   \n|Trail     |int   |    -   |trail stop (in pips)              |  \n|Commentary|string|    -   |order commentary                  |                                               \n|Type      |char  |    -   |I-initial, C-closing, EL/ES-entry limit/stop, S-stop, L-limit, M-margin call|\n\n

Account message example

\n
{\"event\":\"account\",\"payload\":{\"AccountID\":224,\"Action\":\"U\",\"Balance\":100004998.15,\"Income\":-0.02,\"TraderID\":178,\"Type\":\"FEE\",\"UsedMargin\":8}}\n\n
\n

account message format

\n
________________________________________________________\n|parameter |type  |required|description                 |\n|----------|------|--------|----------------------------|\n|event     |string|    +   |event name                  |\n|payload   |object|    +   |object structure            |\n|AccountID |int   |    +   |account identifier          |\n|Action    |char  |    +   |I-insert, U-update, D-delete|\n|Balance   |double|    -   |account balance value       |\n|Income    |double|    -   |balance change value        |\n|TraderID  |int   |    +   |trader identifier           |\n|Type      |string|    -   |balance transaction type    |\n|UsedMargin|double|    -   |account used margin         |\n________________________________________________________\n\n

trade message example

\n
{\"event\":\"trade\",\"payload\":{\"AccountID\":224,\"Action\":\"I\",\"OpenOrderID\":72785845,\"OpenTime\":\"2019-10-16T09:09:52.033833000\",\"Price\":1.10425,\"Quantity\":100,\"Side\":0,\"Symbol\":\"EURUSD\",\"TradeID\":72785846,\"Commentary\":\"some text\", \"OpenOrderType\":\"EL\"}}\n\n
\n

trade message format

\n
_____________________________________________________________\n|parameter     |type  |required|description                 |\n|--------------|------|--------|----------------------------|\n|event         |string|    +   |event name                  |\n|payload       |object|    +   |object structure            |\n|AccountID     |int   |    -   |account identifier          |\n|Action        |char  |    +   |I-insert, U-update, D-delete|\n|CloseOrderID  |int   |    -   |closing order identifier    |\n|CloseTime     |date  |    -   |closing date                |\n|OpenOrderID   |int   |    -   |opening order identifier    |\n|OpenTime      |date  |    -   |opening date                |\n|Price         |double|    +   |opening/closing price       |\n|ProfitLoss    |double|    -   |closed trade profit loss    |\n|Quantity      |double|    +   |opening/closing amount      |\n|Side          |int   |    -   |trade side (0-sell, 1-buy)  |    \n|Symbol        |string|    -   |instrument symbol name      |\n|TradeID       |int   |    +   |trade identifier            | \n|Commentary    |string|    -   |trade commentary            | \n|OpenOrderType |string|    -   |open order type             |                                              \n|CloseOrderType|string|    -   |close order type            | \n_____________________________________________________________\n\n

alert message example

\n
{\n    \"event\": \"alert\",\n    \"payload\": {\n        \"AccountID\":82109\n        \"AlertID\": 66,\n        \"Commentary\":\"text\"\n        \"Price\": 1.1842,\n        \"Symbol\": \"EUR/USD\",\n        \"Triggered\": \"2021-09-07T11:12:58\",\n        \"Type\": \"BID\"\n    }\n}\n\n
\n

account equity warning message example

\n
{\n    \"event\": \"equity_warning\",\n    \"payload\": {\n        \"AccountID\": 110,\n        \"Equity\": 5262.96,\n        \"EquityNotificationPercentLevel\": 125,\n        \"UsedMargin\": 5254.26\n    }\n}\n\n
\n

account equity warning message format

\n
_____________________________________________________________________________\n|parameter                     |type  |required|description                 |\n|------------------------------|------|--------|----------------------------|\n|event                         |string|    +   |event name                  |\n|payload                       |object|    +   |object structure            |\n|AccountID                     |int   |    +   |account identifier          |\n|Equity                        |double|    +   |account equity value        |\n|EquityNotificationPercentLevel|int   |    -   |equity notification level   |\n|UsedMargin                    |date  |    -   |account used margin value   |\n_____________________________________________________________________________\n\n
","urlObject":{"protocol":"ws","port":"port","path":["ws"],"host":["server-address"],"query":[{"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"d28b0efc-d28a-431e-9b0c-cb2f5059db71"}],"id":"c417616a-8556-4a9b-903a-a77608bc940c","_postman_id":"c417616a-8556-4a9b-903a-a77608bc940c","description":""},{"name":"trading","item":[{"name":"cancelorder","id":"ce398e68-c24d-4f9e-bb4e-439b97010465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/cancelorder?token=YoC1Buiy&order=247574778","description":"

Delete order.

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": \"\"\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","cancelorder"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

order number

\n","type":"text/plain"},"key":"order","value":"247574778"}],"variable":[]}},"response":[],"_postman_id":"ce398e68-c24d-4f9e-bb4e-439b97010465"},{"name":"closetrade","id":"6ae4c447-8ce8-4fb7-8762-de079e933037","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/closetrade?token=YoC1Buiy&trade=247568770&quantity=100&hedge=N","description":"

Close open trade responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247582631\n    }\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","closetrade"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

open position number

\n","type":"text/plain"},"key":"trade","value":"247568770"},{"description":{"content":"

closing amount

\n","type":"text/plain"},"key":"quantity","value":"100"},{"description":{"content":"

closing with hedge (Y/N), default N

\n","type":"text/plain"},"key":"hedge","value":"N"}],"variable":[]}},"response":[],"_postman_id":"6ae4c447-8ce8-4fb7-8762-de079e933037"},{"name":"hedgetrade","id":"74cf1532-e46a-4f11-948d-a32e570aa9b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/hedgetrade?token=YoC1Buiy&trade=247568770&quantity=100","description":"

Hedge opened position responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247582631\n    }\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","hedgetrade"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

open position number

\n","type":"text/plain"},"key":"trade","value":"247568770"},{"description":{"content":"

hedging amount

\n","type":"text/plain"},"key":"quantity","value":"100"}],"variable":[]}},"response":[],"_postman_id":"74cf1532-e46a-4f11-948d-a32e570aa9b0"},{"name":"modifyorder","id":"e414286d-dae3-46fb-9135-3dc409bf22bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/modifyorder?token=YoC1Buiy&order=247668792&price=1.008&quantity=10","description":"

Modify order.

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": \"\"\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","modifyorder"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

order number

\n","type":"text/plain"},"key":"order","value":"247668792"},{"description":{"content":"

order price

\n","type":"text/plain"},"key":"price","value":"1.008"},{"description":{"content":"

order amount

\n","type":"text/plain"},"key":"quantity","value":"10"}],"variable":[]}},"response":[],"_postman_id":"e414286d-dae3-46fb-9135-3dc409bf22bf"},{"name":"openorders","id":"8a33a586-8432-46b7-ac88-dce1ec416f9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/openorders?token=YoC1Buiy","description":"

Get all open orders.

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [\n        {\n            \"OrderID\": 247574778,\n            \"Symbol\": \"EURUSD\",\n            \"AccountID\": 100,\n            \"Quantity\": 100,\n            \"Price\": 1.0099,\n            \"Type\": \"ES\",\n            \"Pending\": \"N\",\n            \"Side\": 0,\n            \"ToClose\": null,\n            \"Trail\": null,\n            \"Commentary\": \"comment\",\n            \"OpenTime\": \"2019-10-07T13:28:42.544208000\"\n        }\n    ]\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","openorders"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"8a33a586-8432-46b7-ac88-dce1ec416f9e"},{"name":"opentrades","id":"55d7b9bd-72bb-489c-871e-0bf14961b318","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/opentrades?token=YoC1Buiy","description":"

Get all open trades.

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [\n        {\n            \"TradeID\": 247568770,\n            \"Symbol\": \"EURUSD\",\n            \"AccountID\": 100,\n            \"Quantity\": 100,\n            \"Price\": 1.001,\n            \"Side\": 0, \n            \"Commission\": -1.25, \n            \"Interest\": -1.34,\n            \"Commentary\": \"comment\",\n            \"OpenTime\": \"2019-10-07T13:26:59.949601000\"\n        }\n    ]\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","opentrades"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"}],"variable":[]}},"response":[],"_postman_id":"55d7b9bd-72bb-489c-871e-0bf14961b318"},{"name":"placemarket","id":"7b83b08b-fcb9-4f6c-b8ed-f15cbbe08619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/placemarket?token=YoC1Buiy&symbol=EURUSD&quantity=100&side=0&account=100&stop=1.1234&limit=1.234&trail=10&commentary=text","description":"

place market order responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247568743\n    }\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","placemarket"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

symbol name

\n","type":"text/plain"},"key":"symbol","value":"EURUSD"},{"description":{"content":"

order amount

\n","type":"text/plain"},"key":"quantity","value":"100"},{"description":{"content":"

order side (0-sell, 1- buy)

\n","type":"text/plain"},"key":"side","value":"0"},{"description":{"content":"

account identifier

\n","type":"text/plain"},"key":"account","value":"100"},{"description":{"content":"

pre-defined stop order price

\n","type":"text/plain"},"key":"stop","value":"1.1234"},{"description":{"content":"

pre-defined limit order price

\n","type":"text/plain"},"key":"limit","value":"1.234"},{"description":{"content":"

pre-defined trail size (in pips)

\n","type":"text/plain"},"key":"trail","value":"10"},{"description":{"content":"

text commentary

\n","type":"text/plain"},"key":"commentary","value":"text"}],"variable":[]}},"response":[],"_postman_id":"7b83b08b-fcb9-4f6c-b8ed-f15cbbe08619"},{"name":"placepending","id":"c67db724-8143-4e0e-a1ac-e72209da604c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/placepending?token=YoC1Buiy&symbol=EURUSD&quantity=100&side=0&account=100&price=1.0099&stop=1.123&limit=1.124&trail=10&commentary=text","description":"

Place pending order responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247574778\n    }\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","placepending"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

symbol name

\n","type":"text/plain"},"key":"symbol","value":"EURUSD"},{"description":{"content":"

order amount

\n","type":"text/plain"},"key":"quantity","value":"100"},{"description":{"content":"

order side (0-sell, 1-buy)

\n","type":"text/plain"},"key":"side","value":"0"},{"description":{"content":"

account identifier

\n","type":"text/plain"},"key":"account","value":"100"},{"description":{"content":"

order price

\n","type":"text/plain"},"key":"price","value":"1.0099"},{"description":{"content":"

pre-defined stop order price

\n","type":"text/plain"},"key":"stop","value":"1.123"},{"description":{"content":"

pre-defined limit order price

\n","type":"text/plain"},"key":"limit","value":"1.124"},{"description":{"content":"

pre-define trail (in pips)

\n","type":"text/plain"},"key":"trail","value":"10"},{"description":{"content":"

text commentary

\n","type":"text/plain"},"key":"commentary","value":"text"}],"variable":[]}},"response":[],"_postman_id":"c67db724-8143-4e0e-a1ac-e72209da604c"},{"name":"placelimit","id":"22991da6-37e3-4d72-a81a-8ed3147442c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/placelimit?token=YoC1Buiy&trade=23123&order=123321&price=1.0099&pips=50","description":"

Place limit order responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247574778\n    }\n}\n
\n

example to place limit order on trade
\nhttp://server-address:port/api/v2/trading/placelimit?token=YoC1Buiy&trade=123123&price=1.0099

\n

example to place limit order on pending order
\nhttp://server-address:port/api/v2/trading/placelimit?token=YoC1Buiy&order=122344&price=1.0099

\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","placelimit"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

Use TradeID when placing Stop on an existing open position

\n","type":"text/plain"},"key":"trade","value":"23123"},{"description":{"content":"

Use OrderID when placing Stop on a pending Entry order

\n","type":"text/plain"},"key":"order","value":"123321"},{"description":{"content":"

order price

\n","type":"text/plain"},"key":"price","value":"1.0099"},{"description":{"content":"

can be used instead of price

\n","type":"text/plain"},"key":"pips","value":"50"}],"variable":[]}},"response":[],"_postman_id":"22991da6-37e3-4d72-a81a-8ed3147442c0"},{"name":"placestop","id":"4e0bf251-8839-4ec2-87f5-6f8e8a636aad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/placestop?token=YoC1Buiy&trade=123123&order=122344&price=1.0099&pips=50","description":"

Place stop order response

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247574778\n    }\n}\n
\n

example to place stop order on trade
\nhttp://server-address:port/api/v2/trading/placestop?token=YoC1Buiy&trade=123123&price=1.0099

\n

example to place stop order on pending order
\nhttp://server-address:port/api/v2/trading/placestop?token=YoC1Buiy&order=122344&price=1.0099

\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","placestop"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

Use TradeID when placing Stop on an existing open position

\n","type":"text/plain"},"key":"trade","value":"123123"},{"description":{"content":"

Use OrderID when placing Stop on a pending Entry order

\n","type":"text/plain"},"key":"order","value":"122344"},{"description":{"content":"

order price

\n","type":"text/plain"},"key":"price","value":"1.0099"},{"description":{"content":"

can be used instead of price

\n","type":"text/plain"},"key":"pips","value":"50"}],"variable":[]}},"response":[],"_postman_id":"4e0bf251-8839-4ec2-87f5-6f8e8a636aad"},{"name":"placetrail","id":"9b3ef89b-100d-492d-a94f-28e3b83cb5ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/placetrail?token=YoC1Buiy&trade=123123&order=123211&trail=10","description":"

Place stop order responce

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": {\n        \"OrderID\": 247574778\n    }\n}\n
\n

example to place trail order on trade
\nhttp://server-address:port/api/v2/trading/placetrail?token=YoC1Buiy&trade=123123&trail=10

\n

example to place trail order on pending order
\nhttp://server-address:port/api/v2/trading/placetrail?token=YoC1Buiy&order=122344&trail=10

\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","placetrail"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

Use TradeID when placing Stop on an existing open position

\n","type":"text/plain"},"key":"trade","value":"123123"},{"description":{"content":"

Use OrderID when placing Stop on a pending Entry order

\n","type":"text/plain"},"key":"order","value":"123211"},{"description":{"content":"

trail size in pips

\n","type":"text/plain"},"key":"trail","value":"10"}],"variable":[]}},"response":[],"_postman_id":"9b3ef89b-100d-492d-a94f-28e3b83cb5ee"},{"name":"removedorders","id":"644aa591-2432-4953-83db-bb759ae5ec95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/removedorders?token=YoC1Buiy&from=2021-04-01T00:00&till=2021-07-01T00:00&order=1000&account=1001","description":"

Removed orders history

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [{\n        \"OrderID\": 6236951,\n        \"Symbol\": \"EUR/USD\",\n        \"AccountID\": 48,\n        \"Quantity\": 3000,\n        \"Side\": 0,\n        \"Type\": \"ES\",\n        \"RemoveTime\": \"2021-07-08T09:11:11.684358000\",\n        \"Commentary\": \"\",\n        \"RemovedBy\": \"dealer\"\n    }]\n}\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","removedorders"],"host":["server-address"],"query":[{"description":{"content":"

session token

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

from date

\n","type":"text/plain"},"key":"from","value":"2021-04-01T00:00"},{"description":{"content":"

till date

\n","type":"text/plain"},"key":"till","value":"2021-07-01T00:00"},{"description":{"content":"

order number

\n","type":"text/plain"},"key":"order","value":"1000"},{"description":{"content":"

account number

\n","type":"text/plain"},"key":"account","value":"1001"}],"variable":[]}},"response":[],"_postman_id":"644aa591-2432-4953-83db-bb759ae5ec95"},{"name":"tradehistory","id":"33de97f3-7b5c-43fc-a65f-813470e65b46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://server-address:port/api/v2/trading/tradehistory?token=YoC1Buiy&from=2021-04-01T00:00&till=2021-04-02T00:00&account=1231&tradeId=123123","description":"

Trading history

\n
{\n    \"success\": true,\n    \"message\": \"\",\n    \"result\": [\n        {\n            \"TradeID\": 247568770,\n            \"Symbol\": \"EURUSD\",\n            \"AccountID\": 100,\n            \"Quantity\": 100,\n            \"OpenPrice\": 1.001,\n            \"ClosePrice\": 1.09827,\n            \"ProfitLoss\": -9.73,\n            \"Side\": 0,\n            \"Commission\": -1.25, \n            \"Interest\": -1.34,\n            \"Commentary\": \"comment\",\n            \"OpenTime\": \"2019-10-07T13:26:59.949601000\",\n            \"CloseTime\": \"2019-10-07T13:31:04.578833000\"\n            \"OpenBalance\": 100,\n            \"OpenUsedMargn\": 100,\n            \"OpenEquity\": 200,\n            \"CloseBalance\": 200,\n            \"CloseUsedMargn\": 0,\n            \"CloseEquity\": 100,\n            \"CloseOrderType\": \"L\"\n        }\n    ]\n}\n\n
\n","urlObject":{"protocol":"http","port":"port","path":["api","v2","trading","tradehistory"],"host":["server-address"],"query":[{"description":{"content":"

session token (mandatory)

\n","type":"text/plain"},"key":"token","value":"YoC1Buiy"},{"description":{"content":"

from date

\n","type":"text/plain"},"key":"from","value":"2021-04-01T00:00"},{"description":{"content":"

till date

\n","type":"text/plain"},"key":"till","value":"2021-04-02T00:00"},{"description":{"content":"

account number

\n","type":"text/plain"},"key":"account","value":"1231"},{"description":{"content":"

closed trade number

\n","type":"text/plain"},"key":"tradeId","value":"123123"}],"variable":[]}},"response":[],"_postman_id":"33de97f3-7b5c-43fc-a65f-813470e65b46"}],"id":"d66f96e9-a4ba-4138-94bd-918ae4699bb5","_postman_id":"d66f96e9-a4ba-4138-94bd-918ae4699bb5","description":""}],"event":[{"listen":"prerequest","script":{"id":"77461c6a-60c6-4ab1-8af3-66456c1b0b6a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"93e26e9b-40cd-4c82-9119-fba69d534034","type":"text/javascript","exec":[""]}}]}