> For the complete documentation index, see [llms.txt](https://tradesync.gitbook.io/tradesync/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tradesync.gitbook.io/tradesync/fxtr-v2/functions-of-fxtr-v2/open-stream-for-the-account/messages-that-can-be-sent-in-open-stream/getinstruments.md).

# GetInstruments

**`GetInstruments`**` ``-`get information about "eurusd", "gbpusd", "btcusd" instruments available for the account

**Request Body Fields:** 

<table><thead><tr><th>Parameter</th><th width="106" data-type="checkbox">Required</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td><code>symbol</code></td><td>true</td><td><code>string</code> </td><td>optional array of strings with a list of instruments to get inofrmation about</td></tr></tbody></table>

**Example**

```json
{"id": 11, "type":"GetInstruments", "body": {"symbols":["eurusd", "gbpusd", "btcusd"]}}
```

**Responce Type** - `GetInstruments.`

**Responce Body Fields:**

<table><thead><tr><th width="244">Parameter</th><th width="153" data-type="checkbox">Always returned</th><th width="138">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>symbol</code></td><td>true</td><td><code>string</code> </td><td>symbol for which a tick was receive</td></tr><tr><td><code>symbol_group</code></td><td>true</td><td><code>string</code> </td><td>the name of symbol group</td></tr><tr><td><code>currency_base</code></td><td>true</td><td><code>string</code> </td><td>the currency of user trading account</td></tr><tr><td><code>currency_margin</code></td><td>true</td><td><code>string</code> </td><td>the symbol margin currency</td></tr><tr><td><code>currency_profit</code></td><td>true</td><td><code>string</code> </td><td>the profit currency for the symbol</td></tr><tr><td><code>currency_source</code></td><td>true</td><td><code>string</code> </td><td>the source of currency for the symbol</td></tr><tr><td><code>digits</code></td><td>true</td><td><code>int64</code></td><td>the number of decimal places in the price of the symbol.</td></tr><tr><td><code>contract_size</code></td><td>true</td><td><code>int64</code></td><td>the contract size of the symbol</td></tr><tr><td><code>stops_level</code></td><td>true</td><td><code>int64</code></td><td>the price band, within which placing stop orders is not allowed</td></tr><tr><td><code>calc_mode</code></td><td>true</td><td><code>int64</code></td><td>the mode of margin and profit calculation</td></tr><tr><td><code>trade_mode</code></td><td>true</td><td><code>int64</code></td><td>the symbol trading mode</td></tr><tr><td><code>volume_min</code></td><td>true</td><td><code>double</code></td><td>the minimum volume of trade operations for the symbol</td></tr><tr><td><code>volume_max</code></td><td>true</td><td><code>double</code></td><td>the maximum volume of trade operations for the symbol</td></tr><tr><td><code>volume_step</code></td><td>true</td><td><code>double</code></td><td>the volume change step for trade operations for the symbol</td></tr><tr><td><code>initial_margin</code></td><td>true</td><td><code>double</code></td><td>the size of the initial margin</td></tr><tr><td><code>hedged_margin</code></td><td>true</td><td><code>double</code></td><td>the value of the hedged margin</td></tr><tr><td><code>maintenance_margin</code></td><td>true</td><td><code>double</code></td><td>the size of the maintenance margin</td></tr><tr><td><code>initial_margin_rate_buy</code></td><td>true</td><td><code>double</code></td><td>the initial margin rate for orders of the specified type (buy)</td></tr><tr><td><code>initial_margin_rate_sell</code></td><td>true</td><td><code>double</code></td><td>the initial margin rate for orders of the specified type (sell)</td></tr><tr><td><code>maintenance_margin_rate_buy</code></td><td>true</td><td><code>double</code></td><td>the maintenance margin rate for orders of the specified type (buy)</td></tr><tr><td><code>maintenance_margin_rate_sell</code></td><td>true</td><td><code>double</code></td><td>the maintenance margin rate for orders of the specified type (sell)</td></tr><tr><td><code>tick_size</code></td><td>true</td><td><code>int64</code></td><td>the size of one tick of the symbol</td></tr><tr><td><code>tick_value</code></td><td>true</td><td><code>int64</code></td><td>the price of one tick of the symbol</td></tr><tr><td><code>swap_mode</code></td><td>true</td><td><code>int64</code></td><td>the swap calculation mode for the symbol</td></tr><tr><td><code>swap_long</code></td><td>true</td><td><code>double</code></td><td>the swap size for long positions</td></tr><tr><td><code>swap_short</code></td><td>true</td><td><code>double</code></td><td>the swap size for short positions</td></tr><tr><td><code>swap_3day</code></td><td>true</td><td><code>double</code></td><td>the triple swap day</td></tr><tr><td><code>commission_in</code></td><td>true</td><td><code>double</code></td><td>in comission</td></tr><tr><td><code>commission_out</code></td><td>true</td><td><code>double</code></td><td>out comission</td></tr><tr><td><code>commission_daily</code></td><td>true</td><td><code>double</code></td><td>daily commission</td></tr><tr><td><code>commission_monthly</code></td><td>true</td><td><code>double</code></td><td>month commission</td></tr><tr><td><code>fee</code></td><td>true</td><td><code>double</code></td><td>fee</td></tr></tbody></table>

**Possible values of parameter `trade_mode`:**

<table><thead><tr><th>ID</th><th width="104">Value</th><th>Description</th></tr></thead><tbody><tr><td><code>TRADE_DISABLED</code></td><td>0</td><td>Trade is disabled.</td></tr><tr><td><code>TRADE_LONGONLY</code></td><td>1</td><td>Only long positions are allowed.</td></tr><tr><td><code>TRADE_SHORTONLY</code></td><td>2</td><td>Only short positions are allowed.</td></tr><tr><td><code>TRADE_CLOSEONLY</code></td><td>3</td><td>Only closure is allowed.</td></tr><tr><td><code>TRADE_FULL</code></td><td>4</td><td>Full trading access.</td></tr></tbody></table>

**Possible values of parameter `calc_mode`:**

<table><thead><tr><th width="271">ID</th><th width="76">Value</th><th>Description</th></tr></thead><tbody><tr><td><code>TRADE_MODE_FOREX</code></td><td>0</td><td>The Forex calculation mode.</td></tr><tr><td><code>TRADE_MODE_FUTURES</code></td><td>1</td><td>The Futures calculation mode.</td></tr><tr><td><code>TRADE_MODE_CFD</code></td><td>2</td><td>The CFD calculation mode.</td></tr><tr><td><code>TRADE_MODE_CFDINDEX</code></td><td>3</td><td>The CFDIndex calculation mode.</td></tr><tr><td><code>TRADE_MODE_CFDLEVERAGE</code></td><td>4</td><td>The CFDLeverage calculation mode.</td></tr><tr><td><code>TRADE_MODE_FOREX_NO_LEVERAGE</code></td><td>5</td><td>Totally equivalent to the <code>TRADE_MODE_FOREX</code> type except that the client leverage is not taken into account when <a href="https://support.metaquotes.net/en/docs/mt5/platform/administration/admin_symbols/admin_symbols_settings/symbol_settings_trade/margin_calculation/margin_forex#noleverage">calculating the margin</a>. <code>RADE_MODE_FOREX_NO_LEVERAGE</code> can be used if it is necessary to calculate the margin with a fixed leverage for all clients regardless of their actual leverage. If this type is selected, the client leverage is not taken into account when calculating the margin. A fixed leverage can be set through <a href="mk:@MSITStore:C:\Projects\CPP\justforex\rw-manager\MetaTrader5SDK\Docs\MetaTrader5SDK.chm::/imtconsymbol_marginrateinitial.htm">margin rates</a> (for example, the rate of 0.01 is similar to the leverage of 1:100).</td></tr></tbody></table>

**Possible values of parameter `swap_mode`:**

<table><thead><tr><th width="313">ID</th><th width="87">Value</th><th>Description</th></tr></thead><tbody><tr><td><code>SWAP_DISABLED</code></td><td>0</td><td>Swap charging is disabled.</td></tr><tr><td><code>SWAP_BY_POINTS</code></td><td>1</td><td>Swaps are calculated as the amount of points of the symbol price.</td></tr><tr><td><code>SWAP_BY_SYMBOL_CURRENCY</code></td><td>2</td><td>Swap charging in the base currency of a symbol.</td></tr><tr><td><code>SWAP_BY_MARGIN_CURRENCY</code></td><td>3</td><td>Swap charging in the margin currency of a symbol.</td></tr><tr><td><code>SWAP_BY_GROUP_CURRENCY</code></td><td>4</td><td>Swap charging in the group (deposit) currency.</td></tr><tr><td><code>SWAP_BY_INTEREST_CURRENT</code></td><td>5</td><td>Swap charging as a per cent from the price of a symbol at calculation of swap.</td></tr><tr><td><code>SWAP_BY_INTEREST_OPEN</code></td><td>6</td><td>Swap charging as a per cent from the open price of a position by a symbol.</td></tr><tr><td><code>SWAP_REOPEN_BY_CLOSE_PRICE</code></td><td>7</td><td>Swap charging by reopening position. At the end of a trading day position is closed. Next day it is reopened by the close price +/- number of points specified using the <code>IMTConSymbol::SwapLong</code> and <code>IMTConSymbol::SwapShort</code> methods.</td></tr><tr><td><code>SWAP_REOPEN_BY_BID</code></td><td>8</td><td>Swap charging by reopening position. At the end of a trading day position is closed. At the end of a trading day position is closed. Next day it is reopened by the current Bid price +/- number of points specified using the <code>IMTConSymbol::SwapLong</code> and <code>IMTConSymbol::SwapShort</code> methods.</td></tr><tr><td><code>SWAP_BY_PROFIT_CURRENCY</code></td><td>9</td><td>Swap charging in the profit currency of a symbol.</td></tr></tbody></table>

**Example:**

```json
{
    "type": "GetInstruments",
    "id": 11,
    "body": [
        {
            "symbol": "AUDCAD.s",
            "symbol_group": "Forex S",
            "currency_base": "AUD",
            "currency_margin": "AUD",
            "currency_profit": "CAD",
            "currency_source": "",
            "digits": 5,
            "contract_size": 100000,
            "stops_level": 0,
            "calc_mode": 0,
            "trade_mode": 4,
            "volume_min": 0.01,
            "volume_max": 100,
            "volume_step": 0.01,
            "initial_margin": 0,
            "hedged_margin": 0,
            "maintenance_margin": 0,
            "initial_margin_rate_buy": 1,
            "initial_margin_rate_sell": 1,
            "maintenance_margin_rate_buy": 1,
            "maintenance_margin_rate_sell": 1,
            "tick_size": 0,
            "tick_value": 0,
            "swap_mode": 1,
            "swap_long": 0.13,
            "swap_short": -0.3588,
            "swap_3day": 3,
            "commission_in": 0,
            "commission_out": 0,
            "commission_daily": 0,
            "commission_monthly": 0,
            "fee": 0,
            "sessions": {
                "sunday": {
                    "trade": [],
                    "quote": []
                },
                "monday": {
                    "trade": [
                        {
                            "open": "00:01 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ],
                    "quote": [
                        {
                            "open": "00:00 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ]
                },
                "tuesday": {
                    "trade": [
                        {
                            "open": "00:01 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ],
                    "quote": [
                        {
                            "open": "00:00 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ]
                },
                "wednesday": {
                    "trade": [
                        {
                            "open": "00:01 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ],
                    "quote": [
                        {
                            "open": "00:00 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ]
                },
                "thursday": {
                    "trade": [
                        {
                            "open": "00:01 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ],
                    "quote": [
                        {
                            "open": "00:00 GMT-0300",
                            "close": "23:59 GMT-0300"
                        }
                    ]
                },
                "friday": {
                    "trade": [
                        {
                            "open": "00:01 GMT-0300",
                            "close": "23:58 GMT-0300"
                        }
                    ],
                    "quote": [
                        {
                            "open": "00:00 GMT-0300",
                            "close": "23:58 GMT-0300"
                        }
                    ]
                },
                "saturday": {
                    "trade": [],
                    "quote": []
                }
            }
        }
]}

```