File: WebAPI/webapi_2.proto
Requests for different information with optional subscription for updates. There must be only one request type (e.g., accounts_request and symbol_resolution_request cannot be sent at the same time).
Limits:
1. Message rate: 1000 requests per 100 seconds by default.
2. Simultaneous subscriptions: separate limit per information request type.
3. Overall information requests per session: separate limit per information request type.
Response: InformationReport.
Type: uint32
Description: ID of a request and optional subscription that should be unique enough to match responses and updates with corresponding requests.
Type: bool
Description: If set to true, then corresponding reports are also sent when requested information is changed during the session. If set to false, then subscription is dropped. If omitted, then data is returned without changing subscription status.
Type: trading_account_2.AccountsRequest
Description: Request for authorized accounts for trading.
Type: metadata_2.SymbolResolutionRequest
Description: Request symbol resolution with optional subscription. Note: Subscription is essential to follow active contract switching.
last_statement_balances_request
Type: trading_account_2.LastStatementBalancesRequest
Description: Request for balances from the last statement for all authorized accounts.
Type: trading_account_2.CurrencyRatesRequest
Description: Request for currency rates for all brokerages user’s accounts belong to.
Type: trading_account_2.CurrencyRateSourcesRequest
Description: Request for currency rate source contracts for all brokerages user’s accounts belong to.
Type: trading_session_2.SessionInformationRequest
Description: Request for session information.
Type: trade_routing_2.HistoricalOrdersRequest
Description: Request for a list of historical orders (including all transactions) according to a search criteria. Subscription is not supported for this request.
Type: metadata_2.OptionMaturityListRequest
Description: Request a list of option maturities.
Type: metadata_2.InstrumentGroupRequest
Description: Request a group of instruments.
Type: market_data_2.AtTheMoneyStrikeRequest
Description: Request at-the-money strike for the option maturity.
Type: strategy_2.StrategyDefinitionRequest
Description: Request strategy definition with no subscription.
Type: trading_session_2.SessionTimeRangeRequest
Description: Request for session timerange information. Subscription is not supported for this request. Subscribe flag is ignored.
Type: trading_session_2.TradingDayTimeRangeRequest
Description: Request for trading day timerange information. Subscription is not supported for this request. Subscribe flag is ignored.
Type: order_2.OrderEntitlementRequest
Description: Request for order entitlements. Subscription is not supported for this request.
Type: symbol_browsing_2.SymbolCategoryListRequest
Description: Request for a symbol category tree for a particular root.
Type: symbol_browsing_2.SymbolCategoryRequest
Description: Request for a specific category by its ID.
symbol_category_list_by_instrument_type_request
Type: symbol_browsing_2.SymbolCategoryListByInstrumentTypeRequest
Description: Request for a list of category symbols matching input instrument client type. Subscription is not supported for this request.
Type: symbol_browsing_2.SymbolListRequest
Description: Request for a list of symbols according to a specified filter.
Type: symbol_browsing_2.SymbolRequest
Description: Request for a specific symbol by its ID. Subscription is not supported for this request.
Type: metadata_2.ContractMetadataRequest
Description: Request contract metadata by contract ID.
algo_strategy_definition_request
Type: strategy_2.AlgoStrategyDefinitionRequest
Description: Request algo strategy definitions. Subscription is not supported for this request.
Type: metadata_2.ContributorMetadataRequest
Description: Request contributor metadata by contributor group ID.
Type: api_limit_2.ApiLimitRequest
Description: WebAPI user limits request.
brokerage_trading_feature_entitlement_request
Type: trade_routing_2.BrokerageTradingFeatureEntitlementRequest
Description: Request for trading feature entitlements. Subscription is not supported for this request.
Type: order_2.OrderStatusRequest
Description: Request for a single order status. Subscription is not supported for this request.
Type: symbol_browsing_2.ProductSearchRequest
Description: Request for a list of product symbols matching the search criteria. Subscription is not supported for this request.
Type: metadata_2.MarketStateMetadataRequest
Description: Request MarketState metadata by MarketState group ID.
Type: instrument_definition_2.InstrumentDefinitionRequest
Description: Request (non-strategy) instrument definition with no subscription.
Type: metadata_2.ExchangeMetadataRequest
Description: Request metadata of available exchanges.
instrument_group_by_securities_request
Type: metadata_2.InstrumentGroupBySecuritiesRequest
Description: Request for a subscription on metadata for a group of instruments based on a given list of securities. Multiple subscriptions on the same set of securities are prohibited.
instrument_group_by_exchange_request
Type: metadata_2.InstrumentGroupByExchangeRequest
Description: Request for a subscription on metadata for a group of instruments of a particular exchange. Multiple subscriptions on the same exchange ID are prohibited.
Type: metadata_2.ExchangeSecuritiesRequest
Description: Request for a list of securities for a particular exchange.
care_auto_activation_parameters_request
Type: trade_routing_2.CareAutoActivationParametersRequest
Description: Request for care auto activation parameters for the user.
account_risk_parameters_request
Type: trade_routing_2.AccountRiskParametersRequest
Description: Request for account risk parameters. Subscription is not supported for this request.
Type: metadata_2.CountryListRequest
Description: Request list of countries with metadata for them.
Type: economic_calendar_2.CalendarEventListRequest
Description: Request for calendar events.
calendar_event_provider_list_request
Type: economic_calendar_2.CalendarEventProviderListRequest
Description: Request list of calendar event providers.
calendar_event_type_list_request
Type: economic_calendar_2.CalendarEventTypeListRequest
Description: Request list of calendar event types.
Type: metadata_2.DialectMetadataRequest
Description: Request metadata about a dialect. Subscription is not supported for this request.