MT Streaming API Server Doc

API Conventions/General

Connecting/security

After websocket connect, before any other commands can be executed, a connect command must be sent by the client, passing the MT login password. Without a successful connect, all other commands are rejected.

Formats

Commands and responses can be JSON or XML. That is determined by the connect command that is sent by the client. If it is in JSON format, all communication that follows will be in JSON. If it is in XML format, all subsequent communication will be in XML.

All the timestamps will be in UTC. All date/times are in standard JSON format.

Any response message to a command sent will have the command name echoed in the response as the cmd parameter.

Any update message - that is, a message that is initiated by the API and is not a response to a command, will end in "Update". For example - L1Update, alertTriggerUpdate, balancesUpdate. The two exceptions are the scan messages, ScanNotify and APIScanResult.

Some updates require a subscription (see the subscribe command in the relevant section). Others are sent to every connected session with no subscription at all - heartbeat, closing, the streamer state/status updates, and the trading account state/status updates.

One special Update is APIKeyPressUpdate - for that, you set up a "Send Current Window Info to API" global Keyboard shortcut. When that key is pressed on any content window in Medved Trader, it will send the information from that window to the API. Different windows would send different information, though some will be the same across all windows.

Starting/Stopping streamers for market data and trading

Before a streamer can be used in subscribe or unsubscribe, it has to be started by startDataStreamer.

Before a trading account can be used to place trades or to monitor the account, it has to be started by startTradingAccount.

Matching responses to requests

Any command can have an optional reqID parameter. If it is sent, then any response that the server sends to that command will have the same reqID passed back.

In response to commands, the cmd parameter and reqID (if it was sent) will be echoed back. There will also be three other parameters.

News, Alerts, Halts and Scans streaming updates

NOTE: News streaming and alerts etc. - you still have to subscribe to news or alerts (see the subscribe / unsubscribe command) - but it is a yes/no subscription, not to specific symbols. If news are subscribed, any new news message that comes into MT, using whatever news source and subscription that was set up in MT, will be echoed to the streamer as a newsUpdate. If alerts are subscribed, any alert that is triggered will be sent in api as alertTriggerUpdate.

Halts (subscribe / unsubscribe) work the same yes/no way - each halt logged by the application is sent as a haltAlertUpdate.

Scans (subscribe / unsubscribe) are also passive, but the subscription is by region rather than yes/no. Scans running in MT send a ScanNotify when they start or stop and an APIScanResult per result.

Result Values Included in the Response for Every Command

Just not to repeat it everywhere, this document will not include the reqID, success and resultcode values in the Result Values for all the commands below. The Result Values will show what is included in the result return in the response record.

connect (has to be the first command)

The password here is the password you would use to log into Medved Trader.

{ "cmd": "connect", "pwd": "somepassword", "reqID": "1234" }

{
  "cmd": "connect", "success": "OK", "resultCode": 200, "reqID": "1234",
  "result": { "time": "2022-05-06T22:42:38.643", "ver": "1.1.9600.121", "reason": "connected" }
}

{
  "cmd": "connect", "success": "fail", "resultCode": 401, "reqID": "1234",
  "result": { "time": "2022-05-06T22:42:38.643", "ver": "1.1.9600.121", "reason": "bad password" }
}

heartbeat UPDATE

Once connected, the server sends a heartbeat message to every connected session every 20 seconds. It is not a response to any command and is not subscribed to - it starts automatically after a successful connect. Use it as a keep-alive and to detect a dead connection.

{
  "cmd": "heartbeat", "success": "OK", "resultcode": 200,
  "result": { "serverTime": "2022-05-06T22:42:38.643" }
}

closing UPDATE

As the application terminates (for example, if the user closes it), if at that time the API is connected, it sends a termination notification.

{ "cmd": "closing", "success": "OK", "resultcode": 200, "result": "Session closing Main Application closing" }

enumPorts

Lists all the portfolios in MT.

{ "cmd": "enumPorts", "reqID": "1234" }

{
  "cmd": "enumPorts", "success": "OK", "resultCode": 200, "reqID": "1234",
  "result": { "ports": [
    { "portID": "HWZD6UEQUO", "name": "Portfolio One" },
    { "portID": "JHKJD8DH8JH", "name": "Another Portfolio" }
  ]}
}

enumPortSymbols

Lists all the symbols in a portfolio in MT.

{ "result": ["AAPL", "MSFT", "FB"] }

{ "result": [
  { "sym": "INPX", "itemID": "VpYn9s9tMU" },
  { "sym": "MVIS", "itemID": "gKgKIDNlH0", "qty": 200, "paid": 1.23, "comm": 2.12, "note": "A note", "purchaseDate": "2021-06-09" }
]}

addToPort

Adds symbols to a portfolio in MT. Can create a portfolio as well.

{
  "cmd": "addToPort", "portID": "SKJDGH7E54D", "reqID": "1234",
  "items": [{ "sym": "AAPL", "qty": 3.0, "paid": 1245.0, "comm": 0.2, "note": "some note", "purchaseDate": "2020-08-29" }]
}

removeFromPort

Removes symbols from a portfolio in MT.

{ "cmd": "removeFromPort", "portID": "SKJDGH7E54D", "itemID": ["l966iQC0e0", "213QZ0E01"] }

addPortfolio

Creates a new, empty portfolio or watchlist. Use addToPort afterwards to add symbols to it.

{ "cmd": "addPortfolio", "name": "My Watchlist", "type": "watchlist", "reqID": "1234" }

{
  "cmd": "addPortfolio", "success": "OK", "resultCode": 200, "reqID": "1234",
  "result": { "portID": "HWZD6UEQUO", "name": "My Watchlist", "type": "watchlist" }
}

deletePortfolio

Deletes a portfolio (and everything in it) by ID. This cannot be undone.

{ "cmd": "deletePortfolio", "portID": "HWZD6UEQUO", "reqID": "1234" }

getLinkedSymbol

The colored-group linked symbols can be set and queried by the API. Gets the current linked symbol for a colored group.

{ "cmd": "getLinkedSymbol", "color": "Blue", "reqID": "1234" }

{ "cmd": "getLinkedSymbol", "success": "OK", "resultCode": 200, "result": { "sym": "AAPL" } }

setLinkedSymbol

Sets the current linked symbol for a colored group.

{ "cmd": "setLinkedSymbol", "color": "Blue", "sym": "AAPL", "reqID": "1234" }

getIntervar (also getIntervarString)

The API can set and read the intervars - that can also be set and read by paintbars and hotkeys in the application. SetInterVar() and GetInterVar() functions in paintbars/scans, and the intervar() function in Hotkeys.

Gets the specified intervar (or all intervars) for the specified symbol.

{ "cmd": "getIntervar", "sym": "AMD", "name": "CalcPrice", "reqID": "1234" }

{ "result": { "sym": "AMD", "name": "CalcPrice", "value": "120.4" } }

setIntervar (also setIntervarString)

Sets the intervar for a specified symbol and name.

{ "cmd": "setIntervar", "sym": "AMD", "name": "LULDUpper", "value": 125.4, "reqID": "1234" }

APIKeyPressUpdate UPDATE

In order to receive this message, you set up a "Send Current Window Info to API" global Keyboard shortcut in the application. When that key is pressed on any content window in Medved Trader, it will send the information from that window to the API. Different windows would send different information, though some will be the same across all windows. For example, chart windows will send a "priceAtMouse" field.

getSymbolSnapshot

Gives the current snapshot for the symbol's data stored in MT. NOTE: this is a snapshot of the current data in the MT symbol database. If it was not included in a running portfolio, it may be out of date, or it may be updated at some point but you would have to re-request to get the update.

{ "cmd": "getSymbolSnapshot", "sym": "AAPL", "reqID": "1234" }

getPortSnapshot

Gives the current snapshot for all the symbols in the specified portfolio. Same as getSymbolSnapshot - this is the symbols' data stored in MT. NOTE: this is a snapshot of the current data in the MT symbol database.

{ "cmd": "getPortSnapshot", "portID": "JKGH10D2", "reqID": "1234" }

enumDataStreamers

Lists all the available data streamers in MT. Note that in order for the API to use a data streamer, it has to be set up to work in MT - that is, if it requires name/password, it should be entered in MT. If it is not set up already, trying to activate it in API (by using the startDataStreamer command) will popup the logins in MT.

{ "result": [
  { "streamerID": "GAIN", "name": "GAIN Capital Futures" },
  { "streamerID": "BARCHART", "name": "Barchart Market Data", "isSet": true },
  { "streamerID": "IQFEED", "name": "IQFeed" }
]}

startDataStreamer

This will start up a data streamer for further use in the API. It will log in, if necessary, and connect to the streamer. Note that if in MT, when starting the streamer, a login dialog pops up, it will also do that for this API request. Also note that if in MT the streamer is already started and running, this command will immediately return with a "success": "OK" response.

This initiates the starting of the streamer. To monitor the streamer startup and check when it is done, check the dataStreamerStateUpdate and dataStreamerStatusUpdate messages. The streamer is ready to run when its state is "IdleOrStreaming".

{ "cmd": "startDataStreamer", "streamerID": "AMTD", "reqID": "1234" }

stopDataStreamer

This will deactivate a running streamer in the API and unsubscribe from all symbols it was running. Note that it will only deactivate the streamer for the API. If MT is running the streamer, it will continue to be active there.

{ "cmd": "stopDataStreamer", "streamerID": "AMTD", "reqID": "1234" }

dataStreamerStateUpdate UPDATE

Sent whenever a data streamer changes state - for example, while startDataStreamer is logging in and connecting. No subscription is needed. The streamer is ready to be used in subscribe when its state reaches "IdleOrStreaming". See streamer state / status enumerations for the possible values.

Note: for a streamer that is a trading account (one started with startTradingAccount), this message is sent as tradingAccountStateUpdate instead, and carries an additional accountKey.

{
  "cmd": "dataStreamerStateUpdate", "success": "OK", "resultcode": 200,
  "result": { "streamerID": "AMTD", "fromState": "Connecting", "state": "IdleOrStreaming" }
}

dataStreamerStatusUpdate UPDATE

Sent whenever a data streamer changes status - that is, whether it is running, paused or killed. No subscription is needed. See streamer state / status enumerations for the possible values.

Note: for a streamer that is a trading account, this message is sent as tradingAccountStatusUpdate instead, and carries an additional accountKey.

{
  "cmd": "dataStreamerStatusUpdate", "success": "OK", "resultcode": 200,
  "result": { "streamerID": "AMTD", "fromStatus": "PreStart", "status": "Started" }
}

subscribe / unsubscribe

Subscribes or unsubscribes to/from one of the streaming feeds - L1, L2. Once subscribed, the streaming data will be sent in L1Update and L2Update updates.

{ "cmd": "subscribe", "reqID": "1234", "sub": "L1", "streamerID": "AMTD", "sym": "MSFT, AAPL, FB" }

getSubscriptions

Returns the list of subscribed-to symbols for the streaming feed specified.

{ "result": { "subbed": ["AAPL", "MSFT", "INTC"] } }

L1Update UPDATE

Once the subscribe for a symbol is executed with a sub parameter of "L1", the API will start receiving the L1Update messages for each trade and bid/ask change.

{
  "cmd": "L1Update", "success": "OK", "resultCode": 200,
  "result": {
    "sym": "AAPL", "timeStamp": "2020-05-05T22:19:40.361",
    "price": 299.0, "size": 532.0, "volume": 36898854.0,
    "bid": 298.8, "ask": 299.14
  }
}

L2Update UPDATE

Once the subscribe for a symbol is executed with a sub parameter of "L2", the API will start receiving the L2Update messages. If the initial request had changes set to true, the first message for a symbol will be for a full book snapshot, while subsequent messages will be incremental updates. If it was set to false, every L2Update will contain the whole book.

Each bid/ask entry has an act field: "a" - add the item, "d" - delete the item with that MMID and price, "m" - modify the item with that MMID and price.

{
  "cmd": "L2Update", "type": "diff",
  "result": {
    "sym": "TQQQ",
    "bids": [{ "act": "a", "MMID": "NSDQ", "price": 68.55, "size": 30.0, "timeStamp": "2020-05-05T21:24:32.208Z", "numOrders": 1 }],
    "asks": [{ "act": "d", "MMID": "EDGX", "price": 68.58, "size": 900.0, "timeStamp": "2020-05-05T21:24:32.208Z", "numOrders": 1 }]
  }
}

subscribe / unsubscribe

The News and Alerts subscriptions in the API are passive. That means that the API passes through whatever news and alerts happen in the application. The API can also allow you to manage the alerts - see the Managing Alerts documentation section.

Subscribes or unsubscribes to/from News or Alerts. Once subscribed, new news will send a newsUpdate and a newly triggered alert will send an alertTriggerUpdate.

{ "cmd": "subscribe", "reqID": "1234", "sub": "news" }

getSubscriptions

Returns whether the News or Alerts are subscribed to.

{ "result": { "subbed": "yes" } }

newsUpdate UPDATE

Once subscribed to news, the API will start receiving one newsUpdate message for each new news item that comes in.

{
  "cmd": "newsUpdate", "success": "OK", "resultcode": 200,
  "result": {
    "syms": ["SEMR"],
    "title": "Should You Consider Investing in SEMrush (SEMR)?",
    "timeStamp": "2021-06-07T17:04:58.000",
    "received": "2021-06-14T01:32:28.000",
    "source": "Y! Insider Monkey",
    "URL": "https://finance.yahoo.com/news/consider-investing-semrush-semr-170458708.html"
  }
}

alertTriggerUpdate UPDATE

Once subscribed to alerts, the API will start receiving the alertTriggerUpdate message for each new alert that triggers. See Managing Alerts — alertTriggerUpdate for the full field listing and examples.

subscribe / unsubscribe

The Halts subscription is passive, like News and Alerts - the API passes through the trading halts as they are logged by the application. It is a yes/no subscription, not a subscription to specific symbols.

Subscribes or unsubscribes to/from trading halts. Once subscribed, each newly logged halt will send a haltAlertUpdate.

{ "cmd": "subscribe", "reqID": "1234", "sub": "halts" }

getSubscriptions

Returns whether Halts are subscribed to.

{ "result": { "sub": "halts", "subbed": "yes" } }

haltAlertUpdate UPDATE

Once subscribed to halts, the API will start receiving one haltAlertUpdate message for each new halt record added to the application's halt log. One message is sent per halt record.

{
  "cmd": "haltAlertUpdate", "success": "OK", "resultcode": 200,
  "result": {
    "sym": "AAPL",
    "received": "2022-05-06T14:32:28.000",
    "triggerValue": "LUDP",
    "desc": "Volatility Trading Pause"
  }
}

subscribe / unsubscribe

The Scan subscription is passive - the API passes through the results of scans that are running in the application (in Portfolio windows). The scans themselves are set up and started in MT, not through the API.

Once subscribed, the API sends a ScanNotify message when a scan starts or stops, and an APIScanResult message for each scan result. Immediately upon subscribing, the API also sends the current state: a ScanNotify for every scan already running, followed by an APIScanResult for every result already triggered.

A scan is assigned to a region by the suffix on its ID - an ID of "MYSCAN:CA" is in region CA. An ID with no suffix is in region "US". Only scans whose region is in the subscribed list are sent.

{ "cmd": "subscribe", "reqID": "1234", "sub": "scan:US,CA" }

{ "result": { "sub": "scan", "subbed": "US,CA" } }

getSubscriptions

Returns the regions that scans are subscribed to.

{ "result": { "sub": "scan", "subbed": "ALL" } }

ScanNotify UPDATE

Sent when a scan starts or stops in the application. On a Start, the message also describes the scan's result columns - use it to interpret the ColNum in the APIScanResult messages that follow.

Note that this message does not end in "Update" - it is an exception to the naming convention.

{
  "cmd": "ScanNotify", "success": "OK", "resultcode": 200,
  "result": {
    "Action": "Start",
    "ID": "KADI",
    "Timestamp": 1654555358,
    "Name": "Scan for Kadir",
    "Columns": [
      { "ColNum": 0, "Name": "<>SMA20" }
    ]
  }
}

{
  "cmd": "ScanNotify", "success": "OK", "resultcode": 200,
  "result": { "Action": "Stop", "ID": "KADI", "Timestamp": 1654555358 }
}

APIScanResult UPDATE

Sent for each scan result - that is, for one symbol in one column of one scan. The result carries exactly one of String, Numeric or Boolean, depending on what the scan produced.

Note that this message does not end in "Update" - it is an exception to the naming convention.

{
  "cmd": "APIScanResult", "success": "OK", "resultcode": 200,
  "result": {
    "ID": "KADI",
    "ColNum": 0,
    "Timestamp": 1654555358,
    "Sym": "ACET",
    "String": "above"
  }
}

backfill

Initiates a backfill (just like you would do in MT from, let's say, a chart window). Note that it does not return the backfilled data - it will only tell you when the backfill is finished. To get the data that was backfilled, use the getCandles or getTicks commands. In order to do both backfill and getCandles or getTicks together, use the backfillAndGetCandles or backfillAndGetTicks command.

{ "cmd": "backfill", "reqID": "1234", "type": "OHLC", "streamerID": "AMTD", "sym": "MSFT", "backfillType": "incremental" }

{ "result": { "action": "started", "type": "hist", "sym": "AAPL" } }
// ... followed later by:
{ "result": { "action": "finished", "type": "hist", "sym": "AAPL" } }

backfillAndGetCandles / backfillAndGetTicks

Initiates a backfill like a backfill command would but as soon as the backfill is finished, initiates the getCandles or getTicks command. Accepts all backfill parameters plus all getCandles/getTicks parameters. After the "finished" response, the candle or tick data follows immediately.

getCandles

Returns OHLC candles for the symbol - from the data that is available in MT.

{
  "result": {
    "sym": "MSFT", "candleSize": "1D",
    "data": [
      { "t": "2010-01-04T00:00:00", "o": 30.62, "h": 31.1, "l": 30.59, "c": 30.95, "v": 38414185 }
    ]
  }
}

getTicks

Returns tick data for the symbol - from the data that is available in MT. Accepts same parameters as getCandles (without candleSize), plus tradesOnly (bool - if true filters out bid/ask-only ticks). Each tick record: t (timestamp), b (bid), a (ask), p (price), s (size), bf (true if this is an OHLC backfill pseudo-tick).

getOptionChain

Requests an option chain for a symbol. Returns an immediate "started" response, then the full chain data when complete. MT caches option chains — use forceRefresh: true to bypass the cache.

{
  "result": {
    "sym": "MSFT",
    "expirations": [
      { "expiration": "2022-09-16", "strikes": [240.0, 250.0, 260.0, 270.0] }
    ]
  }
}

alertTriggerUpdate UPDATE

Once subscribed to alerts, the API will start receiving the alertTriggerUpdate message for each new alert that triggers.

alertUpdate UPDATE

Also requires the alerts subscription (see subscribe / unsubscribe). Where alertTriggerUpdate tells you that an alert fired, alertUpdate tells you that the alert definition itself changed - it was added, removed or modified. This happens whether the change was made in MT or through the API (addAlert, modifyAlert, deleteAlert, enableDisableAlert).

{
  "cmd": "alertUpdate", "success": "OK", "resultcode": 200,
  "result": {
    "alertID": "A0000001",
    "action": "changed",
    "alert": { "AlertType": "PriceUp", "Symbol": "MSFT", "Enabled": true }
  }
}

{
  "cmd": "alertUpdate", "success": "OK", "resultcode": 200,
  "result": { "alertID": "A0000001", "action": "removed" }
}

enumAlerts

Returns all user-defined alerts, optionally filtered by alertType or alertID.

{ "cmd": "enumAlerts", "alertType": "PriceUp", "reqID": "1234" }

enableDisableAlert

Enables or disables a specific alert.

{ "cmd": "enableDisableAlert", "alertID": "XJ23lK25", "enabled": true, "reqID": "1234" }

deleteAlert

Permanently deletes an alert.

{ "cmd": "deleteAlert", "alertID": "XJ23lK25", "reqID": "1234" }

modifyAlert

Modifies an existing alert. Include only the fields you want to change in the alert object. The alertID is required. Use enumAlerts first to inspect current field names and values.

{ "cmd": "modifyAlert", "alertID": "XJ23lK25", "alert": { "MainPrice": 21.0 }, "reqID": "1234" }

addAlert

Creates a new alert. Returns the generated alertID on success. The alert object structure varies by alertType. To find the required fields for a specific alert type, create a prototype alert in MT, then use enumAlerts to inspect its exact JSON structure and replicate it in the API.

{
  "cmd": "addAlert", "reqID": "1234",
  "alert": {
    "alertType": "PriceUp",
    "sym": "AAPL",
    "MainPrice": 180.0,
    "enabled": true
  }
}

{ "result": { "alertID": "XJ23lK25" } }

enableAlertSystem / disableAlertSystem / checkAlertSystemStatus

Controls or checks the global MT alert system. checkAlertSystemStatus returns whether it is currently enabled.

{ "cmd": "enableAlertSystem" }
// Response:
{ "result": { "enabled": true } }

enumTradingAccounts

Lists all trading accounts configured in MT.

{
  "result": { "accounts": [
    { "accountKey": "AMTD:5551212", "accountID": "5551212", "loginNick": "AMTD", "accountNick": "my account" },
    { "accountKey": "AMTD:5551313", "accountID": "5551313", "loginNick": "AMTD", "accountNick": "another account" }
  ]}
}

startTradingAccount

Logs into and activates a trading account for API use. If a brokerage login screen is needed, it will appear in MT. After a successful start, the API automatically sends balancesUpdate, positionsUpdate, transactionsUpdate, and tradingAccountSettings. The account is ready when its state is "IdleOrStreaming".

{ "cmd": "startTradingAccount", "accountKey": "AMTD:5551212", "reqID": "1234" }

stopTradingAccount

Stops a trading account in the API session. Disconnects the trading streamer and cancels all subscriptions. Does not affect MT's own account activity.

{ "cmd": "stopTradingAccount", "accountKey": "AMTD:5551212", "reqID": "1234" }

getTradingAccountSettings

Re-requests the tradingAccountSettings for an already-started account. Also sent automatically on startTradingAccount. See the tradingAccountSettings appendix for the full response structure.

{ "cmd": "getTradingAccountSettings", "accountKey": "AMTD:5551212", "reqID": "1234" }

tradingAccountStateUpdate UPDATE

The trading account equivalent of dataStreamerStateUpdate - sent whenever a started trading account changes state, for example while startTradingAccount is logging in and connecting. No subscription is needed. The account is ready to place trades and report data when its state reaches "IdleOrStreaming"; at that point the API also automatically sends the tradingAccountSettings message. See streamer state / status enumerations for the possible values.

{
  "cmd": "tradingAccountStateUpdate", "success": "OK", "resultcode": 200,
  "result": {
    "streamerID": "AMTD", "accountKey": "AMTD:5551212",
    "fromState": "Connecting", "state": "IdleOrStreaming"
  }
}

tradingAccountStatusUpdate UPDATE

The trading account equivalent of dataStreamerStatusUpdate - sent whenever a started trading account changes status. No subscription is needed. See streamer state / status enumerations for the possible values.

{
  "cmd": "tradingAccountStatusUpdate", "success": "OK", "resultcode": 200,
  "result": {
    "streamerID": "AMTD", "accountKey": "AMTD:5551212",
    "fromStatus": "PreStart", "status": "Started"
  }
}

getBalances / getPositions / getTransactions

Requests the latest account data. Responses arrive as the corresponding update message (balancesUpdate, positionsUpdate, transactionsUpdate).

subscribe (Trading)

Controls whether positions and transactions updates send full data or only deltas.

balancesUpdate UPDATE

Sent on startTradingAccount, when balances change, and in response to getBalances. Exact field names vary by brokerage — connect and inspect the live response for your account.

positionsUpdate UPDATE

Sent on account start, on position changes, and in response to getPositions. Fields vary by brokerage.

transactionsUpdate UPDATE

Sent on account start (full set), on order events (new/modified/filled/canceled), and in response to getTransactions. setOrChange is "set" for a complete snapshot or "change" for incremental. Each transaction record includes a New boolean (true if this is a brand new transaction).

{
  "cmd": "transactionsUpdate",
  "result": {
    "accountKey": "AMTD:5551212", "setOrChange": "change",
    "transactions": [{
      "OrderID": "1492551014", "Symbol": "BAC", "StatusID": "Open",
      "Action": "Buy", "OrderType": "Limit", "LimitPrice": 25.31,
      "QTY": 1.0, "TIF": "Day", "IsOpen": true, "New": false
    }]
  }
}

{
  "cmd": "transactionsUpdate",
  "result": {
    "accountKey": "AMTD:5551212", "setOrChange": "change",
    "transactions": [{
      "OrderID": "1489360600", "Symbol": "BOXL", "StatusID": "Filled",
      "FilledQTY": 600.0, "FilledPrice": 1.43998917,
      "Fills": [
        { "FillID": "17279254533", "QTY": 250.0, "Price": 1.4399 },
        { "FillID": "17279254535", "QTY": 300.0, "Price": 1.4399 },
        { "FillID": "17279254537", "QTY": 50.0,  "Price": 1.4398 }
      ], "New": true
    }]
  }
}

getTradeLog

Returns a snapshot of the trade activity log — order placements, fills, partial fills, cancels, rejections and other order-lifecycle events that MT has logged across your trading accounts. Read-only, and it does not require the account to be started (it reads whatever has been logged). All filters are optional; omit them all to get the whole log, or combine them to narrow it. To keep receiving new entries after the snapshot, use subscribe with sub="tradelog".

{ "cmd": "getTradeLog", "reqID": "1234", "sym": "AAPL,MSFT", "activity": "AllFills,OrderRejection" }

{
  "cmd": "getTradeLog", "success": "OK", "resultCode": 200, "reqID": "1234",
  "result": [
    { "logTime": "2026-07-30T14:32:05.120", "accountKey": "AMTD:5551212", "accountID": "5551212", "siteID": "AMTD", "orderID": "1492551014", "symbol": "AAPL", "activity": "OrderFill", "action": "Buy", "desc": "Filled 100 @ 212.34" }
  ]
}

subscribe / unsubscribe (Trade Log)

Subscribes or unsubscribes to/from the trade activity log. Once subscribed, each new log entry that matches the filters is sent as a tradeLogUpdate. Only entries added after the subscribe are streamed — call getTradeLog first for anything already in the log. The filters are the same as getTradeLog and are fixed for the life of the subscription; to change them, subscribe again.

{ "cmd": "subscribe", "reqID": "1234", "sub": "tradelog", "activity": "AllFills" }

{ "result": { "sub": "tradelog", "subbed": "yes" } }

tradeLogUpdate UPDATE

Once subscribed to the trade log, the API sends one tradeLogUpdate per new matching log entry. The result object has the same fields as a getTradeLog entry.

{
  "cmd": "tradeLogUpdate", "success": "OK", "resultcode": 200,
  "result": {
    "logTime": "2026-07-30T14:35:11.880", "accountKey": "AMTD:5551212", "siteID": "AMTD",
    "orderID": "1492551020", "symbol": "MSFT", "activity": "OrderRejection", "isError": true, "desc": "Rejected: insufficient buying power"
  }
}

tradeCommandUpdate UPDATE

Sent whenever a new order, modify, or cancel is submitted to a broker — from either the API or from MT directly. The action field is "NewOrder", "ModifyOrder", or "CancelOrder".

{
  "cmd": "tradeCommandUpdate",
  "result": {
    "accountKey": "AMTD:5551212", "action": "NewOrder",
    "order": {
      "ConditionalType": "None",
      "Legs": [{ "Symbol": "BAC", "Quantity": 1, "Action": "Buy", "OrderType": "Limit", "LimitPrice": 26.36, "TIF": "Day" }]
    }
  }
}

{
  "cmd": "tradeCommandUpdate",
  "result": {
    "accountKey": "AMTD:5551212", "action": "ModifyOrder",
    "order": {
      "OrderID": "1492551014",
      "Legs": [{ "Symbol": "BAC", "Quantity": 1, "LimitPrice": 26.41 }]
    }
  }
}

{
  "cmd": "tradeCommandUpdate",
  "result": { "accountKey": "AMTD:5551212", "action": "CancelOrder", "orderID": "1492551014" }
}

tradeCommandNew

Places a new order. Simple orders have one leg; conditional orders (OTO, OTOTA, etc.) have 2–3 legs. To determine valid parameters for your specific broker, monitor tradeCommandUpdate while placing a test order manually in MT.

{
  "cmd": "tradeCommandNew", "accountKey": "BRKR:ACCTNUM12345", "reqID": "1234",
  "order": {
    "ConditionalType": "None",
    "Legs": [{ "Symbol": "AAPL", "Quantity": 1, "Action": "Buy", "OrderType": "Limit", "LimitPrice": 444.33, "TIF": "Day" }]
  }
}

{
  "cmd": "tradeCommandNew", "accountKey": "AMTD:1234321", "reqID": "1234",
  "order": {
    "ConditionalType": "OTOTA",
    "Legs": [
      { "Symbol": "BAC", "Quantity": 1, "Action": "Buy",  "OrderType": "Limit",      "LimitPrice": 26.36, "TIF": "Day" },
      { "Symbol": "BAC", "Quantity": 1, "Action": "Sell", "OrderType": "StopMarket", "StopPrice": 26.27, "TIF": "Day" },
      { "Symbol": "BAC", "Quantity": 1, "Action": "Buy",  "OrderType": "Limit",      "LimitPrice": 26.23, "TIF": "Day" }
    ]
  }
}

tradeCommandFromHotkey

Executes an MT hotkey order via the API. The hotkey must specify a symbol and account, and contain only Order actions. To get the correct hotkeyJSON: in MT's hotkey list, right-click the hotkey and choose "Copy for Paste API". Paste the result as the hotkeyJSON value.

{
  "cmd": "tradeCommandFromHotkey",
  "hotkeyJSON": {
    "Command": {
      "Disabled": false,
      "Order": {
        "Account": "AMTD:5551212", "Symbol": "BAC",
        "Legs": [{ "OrderType": "Limit", "Quantity": "1", "Action": "Sell", "LimitPrice": "Ask+0.1" }]
      }
    }
  }
}

tradeCommandCancel

Cancels one or more open orders. Accepts a single orderID, a comma-separated string, or an array. The result echoes in tradeCommandUpdate.

{ "cmd": "tradeCommandCancel", "accountKey": "WEBULLPAPER:WB_PAPER1234567", "orderID": ["1781234", "8723681"] }

tradeCommandModify

Modifies an existing open order. Specify only the fields to change — unchanged fields are filled automatically from the existing order. Requires OrderID in the order object.

{
  "cmd": "tradeCommandModify", "accountKey": "BRKR:ACCTNUM12345", "reqID": "1234",
  "order": {
    "OrderID": "18723653",
    "Legs": [{ "LimitPrice": 444.33, "Quantity": 1 }]
  }
}

alertType Enumeration

Used in the alertType field of enumAlerts, addAlert, modifyAlert, and alertTriggerUpdate.

activityType Enumeration

Used in the activity filter of getTradeLog and the tradelog subscribe, and in the activity field of each trade-log entry. Values are matched case-insensitively. The filter accepts one or more names (as a CSV or an array).

streamer state / status enumerations

Used in the state and fromState fields of dataStreamerStateUpdate and tradingAccountStateUpdate, and in the status and fromStatus fields of dataStreamerStatusUpdate and tradingAccountStatusUpdate. The values are sent as strings.

The state tracks the streamer's progress through login and connection. A streamer or trading account is ready to be used once it reaches IdleOrStreaming.

The status tracks whether the streamer is running, independent of its state.

tradingAccountSettings

Sent automatically on startTradingAccount and re-requestable via getTradingAccountSettings. Describes the valid parameters for the connected broker. Values vary per brokerage — inspect the live response for your account.