File: WebAPI/webapi_2.proto
Report with requested information and subscription updates. It will contain only one report type at the same time (related to id).
Note: In some cases the response may not have a typed report field (e.g in case of multiple chunks, if it is the last chunk, see InformationReport.is_report_complete field).
Request: InformationRequest.
Type: uint32
Description: Report ID is equal to a corresponding request and subscription ID. See: InformationRequest.id
Type: bool
Default: true
Description: True means that requested data is complete at the moment, false means more report messages are expected for completeness.
Type: uint32
Description: This field is associated with InformationReport.StatusCode enum type.
Type: string
Description: Possible details of status or failure.
Type: trading_account_2.AccountsReport
Description: Report with trading accounts.
Type: metadata_2.SymbolResolutionReport
Description: Resolved symbol initial information or update.
last_statement_balances_report
Type: trading_account_2.LastStatementBalancesReport
Description: Report with balances from the last statement for all authorized accounts.
Type: trading_account_2.CurrencyRatesReport
Description: Report with currency rates per brokerage.
Type: trading_account_2.CurrencyRateSourcesReport
Description: Report with currency rate source contracts.
Type: trading_session_2.SessionInformationReport
Description: Report with session information.
Type: trade_routing_2.HistoricalOrdersReport
Description: Report with a list of historical orders according to specified parameters.
Type: metadata_2.OptionMaturityListReport
Description: Report with a list of option maturities.
Type: metadata_2.InstrumentGroupReport
Description: Report with a group of instruments.
Type: market_data_2.AtTheMoneyStrikeReport
Description: Report with at-the-money strike.
Type: strategy_2.StrategyDefinitionReport
Description: Report with the defined strategy metadata. This field can be filled in case of STATUS_CODE_FAILURE, if the exchange response contains a strategy that differs significantly from the requested one.
Example: user wants to define UDS(A - B), but opposite UDS(B - A) already exists on exchange.
Type: trading_session_2.SessionTimeRangeReport
Description: Report with session timerange information.
Type: trading_session_2.TradingDayTimeRangeReport
Description: Report with trading day timerange information.
Type: order_2.OrderEntitlementReport
Description: Report with order entitlements.
Type: symbol_browsing_2.SymbolCategoryListReport
Description: Report with a symbol category tree for a particular root.
Type: symbol_browsing_2.SymbolCategoryReport
Description: Report with a symbol category.
symbol_category_list_by_instrument_type_report
Type: symbol_browsing_2.SymbolCategoryListByInstrumentTypeReport
Description: Report with a list of matched category symbols.
Type: symbol_browsing_2.SymbolListReport
Description: Report with a list of found symbols.
Type: symbol_browsing_2.SymbolReport
Description: Report with a symbol.
Type: metadata_2.ContractMetadataReport
Description: Report with the requested contract metadata.
algo_strategy_definition_report
Type: strategy_2.AlgoStrategyDefinitionReport
Description: Report with algo strategies definitions.
Type: metadata_2.ContributorMetadataReport
Description: Report with contributor metadata.
Type: api_limit_2.ApiLimitReport
Description: Report with WebAPI limit values.
brokerage_trading_feature_entitlement_report
Type: trade_routing_2.BrokerageTradingFeatureEntitlementReport
Description: Report with trading feature entitlements.
Type: order_2.OrderStatusReport
Description: Report with an order status.
Type: symbol_browsing_2.ProductSearchReport
Description: Report with a list of found product symbols.
Type: metadata_2.MarketStateMetadataReport
Description: Report with Market State/Status metadata.
Type: instrument_definition_2.InstrumentDefinitionReport
Description: Report with the defined (non-strategy) instrument metadata.
Type: metadata_2.ExchangeMetadataReport
Description: Report with exchange metadata.
instrument_group_by_securities_report
Type: metadata_2.InstrumentGroupBySecuritiesReport
Description: Report with a group of instruments for a particular set of securities.
instrument_group_by_exchange_report
Type: metadata_2.InstrumentGroupByExchangeReport
Description: Report with a group of instruments for a particular exchange securities.
Type: metadata_2.ExchangeSecuritiesReport
Description: Report with a list of securities for a particular exchange.
care_auto_activation_parameters_report
Type: trade_routing_2.CareAutoActivationParametersReport
Description: Report with a list of care auto activation parameters.
account_risk_parameters_report
Type: trade_routing_2.AccountRiskParametersReport
Description: Report with account risk parameters.
Type: metadata_2.CountryListReport
Description: Report with a list of countries.
Type: economic_calendar_2.CalendarEventListReport
Description: Report with a list of calendar events.
calendar_event_provider_list_report
Type: economic_calendar_2.CalendarEventProviderListReport
Description: Report with a list of calendar event providers.
calendar_event_type_list_report
Type: economic_calendar_2.CalendarEventTypeListReport
Description: Report with a list of calendar event types.
Type: metadata_2.DialectMetadataResult
Description: Result with metadata about the requested dialect.
Description: Status code for a request or subscription.
•STATUS_CODE_SUCCESS = 0
Request is processed without subscription (subscription was not requested or cannot be established, e.g., for deleted or synthetic strategy contracts).
Note: Result on InformationRequest without set InformationRequest.subscribe.
•STATUS_CODE_SUBSCRIBED = 1
Request is processed and subscription is established. Note: Result on InformationRequest with InformationRequest.subscribe = true.
•STATUS_CODE_DROPPED = 2
The subscription is dropped by the client.
Note: Result on InformationRequest with InformationRequest.subscribe = false.
•STATUS_CODE_UPDATE = 3
Unsolicited information update because of subscription.
•STATUS_CODE_DISCONNECTED = 4
Currently subscription is disconnected because of communication issues.
Note: Clients should not resubscribe in this case, the server will restore subscription with sending STATUS_CODE_SUBSCRIBED status once communication issues are resolved. Collection of items should not be cleared once STATUS_CODE_DISCONNECTED status is received, and further reports should be treated as updates unless otherwise noted in request description.
•STATUS_CODE_FAILURE = 101
General failure.
•STATUS_CODE_INVALID_PARAMS = 102
Request parameters are invalid.
•STATUS_CODE_NOT_FOUND = 104
Requested information is not found.
•STATUS_CODE_REQUEST_RATE_LIMIT_VIOLATION = 105
The request rate limit has been violated.
•STATUS_CODE_SUBSCRIPTION_LIMIT_VIOLATION = 106
The limit of subscriptions has been violated.
•STATUS_CODE_ACTIVE_REQUESTS_LIMIT_VIOLATION = 107
The limit of active requests has been violated.
•STATUS_CODE_TOO_LARGE_RESPONSE = 108
The response is too large to return. Try more specific request parameters to narrow response size if possible.