Logo

    HELP

    Description

    The HELP command returns all available MetaSocket commands.

    By adding additional COMMAND parameter to the HELP command, information regarding that indicated command is returned (see Example 2 below).

    Important

    All JSON commands you send to MetaSocket should be in a single line format similar to the examples below. Additionally, example replies in this page are presented in a "beautified" format for presentation purposes. Actual replies are always returned in a single line.

    Example 1: General HELP

    {"MSG": "HELP"}

    Reply

    {
    "MSG": "HELP",
    "AVAILABLE_COMMANDS": [
    "HELP",
    "ACCOUNT_STATUS",
    "ATR_INDICATOR",
    "CALENDAR_LIST",
    "CONNECTION_STATUS",
    "CUSTOM_INDICATOR",
    "EXIT",
    "MA_INDICATOR",
    "MARGIN_INFO",
    "ORDER_CLOSE",
    "ORDER_INFO",
    "ORDER_LIST",
    "ORDER_MODIFY",
    "ORDER_SEND",
    "PRICE_HISTORY",
    "QUOTE",
    "SYMBOL_INFO",
    "SYMBOL_LIST",
    "TERMINAL_INFO",
    "TICK_DATA",
    "TRACK_MBOOK",
    "TRACK_OHLC",
    "TRACK_PRICES",
    "TRACK_TRADE_EVENTS",
    "TRADE_HISTORY"
    ],
    "ERROR_ID": 0,
    "ERROR_DESCRIPTION": "no error"
    }

    Example 2: HELP with COMMAND parameter

    {"MSG": "HELP","COMMAND": "QUOTE"}

    Reply

    {
    "MSG": "HELP",
    "COMMAND": "QUOTE",
    "DESCRIPTION": "Get current bid/ask prices for a symbol",
    "MANDATORY_TAGS": [
    "SYMBOL (String)"
    ],
    "OPTIONAL_TAGS": [
    null
    ],
    "ERROR_ID": 0,
    "ERROR_DESCRIPTION": "no error"
    }