RequestTradingSymbolsAggregated
Request information about trading symbols aggregated into a symbol tree
Request format
{
"RequestId": "8338874f-25df-4aee-a6fb-808c700f2cb7",
"Search" : "eurusd",
"SymbolsGroups": [
"forex"
],
"TradeMode": "Disabled",
"SortDirection": "Ascending",
"SortFields": ["Symbol", "Group"],
"PageSize": 100,
"PageNum": 1,
"Nodes": [
"node1",
"node2"
],
"RequestName": "RequestTradingSymbolsAggregated"
}
Request parameters:
| Name | Description |
|---|---|
| RequestId | Unique GUID request ID |
| Search | Search field, works only with SourceSymbol field |
| Nodes | List of nodes that participate in request. If the list is empty, all available nodes are requested. |
| RequestName | Type of request |
| SortDirection | Specifies the sort direction for the fields specified in "SortFields" (enum ListSortDirection: Descending) |
| SortFields | Specifies the fields to sort in the direction specified in "SortDirection" (enum SortableFields Source) |
| PageSize | Page size |
| PageNum | Page number |
| SymbolsGroups | Filter for groups of symbols. If the list is empty, then all available ones are returned. |
| TradeMode | TradeMode enumeration of the trade mode. If the field is empty, then all are returned. |
Response ResponseNodesInfo
{
"Result": {
"Page": [
{
"Node": "",
"Symbol": "AAPL",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc",
"Level": 3,
"Symbols": [
{
"Node": "CTrader",
"Platform": "CTrader",
"Symbol": "AAPL",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc",
"Level": 2,
"Symbols": [
{
"Node": "CTrader",
"Platform": "CTrader",
"Symbol": "AAPL",
"Sector": "AAPL",
"Description": "Apple Inc",
"Group": "Default Category",
"GroupDescription": "Default Category",
"Trade": "TradeEnabled",
"ExeMode": "Market",
"ProfitMode": "Forex",
"MarginCurrency": "AAPL",
"Contracts": [],
"AggregationSymbol": "apple inc",
"SourceSymbol": "AAPL",
"Level": 1,
"Symbols": []
}
]
},
{
"Node": "MT5dev",
"Platform": "Mt5",
"Symbol": "AAPL",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc",
"Level": 2,
"Symbols": [
{
"Node": "MT5dev",
"Platform": "Mt5",
"Symbol": "AAPL",
"Sector": "Technology",
"Industry": "Consumer Electronics",
"Description": "Apple Inc",
"Group": "Stocks No leverage",
"GroupDescription": "",
"Trade": "LongOnly",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc",
"SourceSymbol": "AAPL",
"Level": 1,
"Symbols": []
}
]
},
{
"Node": "MT5Indigosoft",
"Platform": "Mt5",
"Symbol": "AAPL.m",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc",
"Level": 2,
"Symbols": [
{
"Node": "MT5Indigosoft",
"Platform": "Mt5",
"Symbol": "AAPL.m",
"Sector": "Technology",
"Industry": "Consumer Electronics",
"Description": "Apple Inc",
"Group": "Preliminary\\US Shares M",
"GroupDescription": "",
"Trade": "TradeDisabled",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc",
"SourceSymbol": "AAPL.m",
"Level": 1,
"Symbols": []
}
]
},
{
"Node": "Demo MT5",
"Platform": "Mt5",
"Symbol": "AAPL.US",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc",
"Level": 2,
"Symbols": [
{
"Node": "Demo MT5",
"Platform": "Mt5",
"Symbol": "AAPL.US",
"Sector": "Technology",
"Industry": "Consumer Electronics",
"Description": "Apple Inc",
"Group": "Stocks.US CFD",
"GroupDescription": "",
"Trade": "TradeEnabled",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc",
"SourceSymbol": "AAPL.US",
"Level": 1,
"Symbols": []
}
]
},
{
"Node": "Second",
"Platform": "Mt4",
"Symbol": "AAPL.US",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc",
"Level": 2,
"Symbols": [
{
"Node": "Second",
"Platform": "Mt4",
"Symbol": "AAPL.US",
"Description": "Apple Inc ",
"Group": "Stocks US",
"GroupDescription": "",
"Trade": "TradeEnabled",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc",
"SourceSymbol": "AAPL.US",
"Level": 1,
"Symbols": []
}
]
}
]
},
{
"Node": "",
"Symbol": "AAPL.US",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"Level": 3,
"Symbols": [
{
"Node": "Demo MT5",
"Platform": "Mt5",
"Symbol": "AAPL.US",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"Level": 2,
"Symbols": [
{
"Node": "Demo MT5",
"Platform": "Mt5",
"Symbol": "Apple",
"Sector": "Undefined",
"Industry": "Undefined",
"Description": "Apple Inc CFD",
"Group": "WebTerminalInstruments",
"GroupDescription": "",
"Trade": "CloseOnly",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"SourceSymbol": "AAPL.US",
"Level": 1,
"Symbols": []
}
]
},
{
"Node": "MT4dev",
"Platform": "Mt4",
"Symbol": "AAPL.US",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"Level": 2,
"Symbols": [
{
"Node": "MT4dev",
"Platform": "Mt4",
"Symbol": "AAPL.US",
"Description": "Apple Inc CFD",
"Group": "Stocks US CFD",
"GroupDescription": "CFD",
"Trade": "TradeEnabled",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"SourceSymbol": "AAPL.US",
"Level": 1,
"Symbols": []
}
]
},
{
"Node": "MT5dev",
"Platform": "Mt5",
"Symbol": "AAPL.US",
"Trade": "TradeDisabled",
"ExeMode": "Request",
"ProfitMode": "Forex",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"Level": 2,
"Symbols": [
{
"Node": "MT5dev",
"Platform": "Mt5",
"Symbol": "AAPL.US",
"Sector": "Technology",
"Industry": "Consumer Electronics",
"Description": "Apple Inc CFD",
"Group": "Stocks.US CFD",
"GroupDescription": "",
"Trade": "TradeEnabled",
"ExeMode": "Market",
"ProfitMode": "CFD",
"MarginCurrency": "USD",
"Contracts": [],
"AggregationSymbol": "apple inc cfd",
"SourceSymbol": "AAPL.US",
"Level": 1,
"Symbols": []
}
]
}
]
}
],
"PageSize": 15,
"PageNum": 1,
"TotalRecords": 2
},
"RequestId": "51bc135c-a4eb-45a9-9f98-822c1ba0830c",
"Errors": [],
"ResponseMaster": "ResponseTradingSymbolsAggregated"
}
TradeMode enumeration
public enum SymbolTradeMode
{
/// <summary>
/// Торговля запрещена.
/// </summary>
TradeDisabled,
/// <summary>
/// Разрешено т олько закрытие.
/// </summary>
CloseOnly,
/// <summary>
/// Полный доступ к торговле.
/// </summary>
TradeEnabled,
/// <summary>
/// Разрешены только shorts
/// </summary>
ShortOnly,
/// <summary>
/// Разрешены только лонги
/// </summary>
LongOnly
}