Message: ClientMsg

File: WebAPI/webapi_2.proto

Description

Top level client-to-server message, must include at least one field.

Note: Logon, LogonRoutineClient, RestoreOrJoinSession or ObtainDemoCredentials are required to be the first and the only message after connection.

Limits: Client messages rate is limited, 1000 messages per 10 seconds by default. If this rate is exceeded then a user message is sent with details and the connection is closed.

Relates to: ServerMsg.

Fields

logon

Type: user_session_2.Logon

logon_routine_client

Type: user_session_2.LogonRoutineClient

password_change

Type: user_session_2.PasswordChange

password_change_routine_client

Type: user_session_2.PasswordChangeRoutineClient

restore_or_join_session

Type: user_session_2.RestoreOrJoinSession

logoff

Type: user_session_2.Logoff

obtain_demo_credentials

Type: user_session_2.ObtainDemoCredentials

user_session_state_request

Type: user_session_2.UserSessionStateRequest

ping

Type: user_session_2.Ping

pong

Type: user_session_2.Pong

set_collapsing_level_request

Type: user_session_2.SetCollapsingLevelRequest

information_requests

Type: InformationRequest

Description: Various information data requests.

trade_subscriptions

Type: trade_routing_2.TradeSubscription

Description: Subscriptions on trade routing information (orders, positions, account summary, etc.).

order_requests

Type: order_2.OrderRequest

Description: Order requests.

allocation_requests

Type: order_2.AllocationRequest

Description: Allocate order fills request.

market_data_subscriptions

Type: market_data_2.MarketDataSubscription

Description: Market data subscriptions.

time_and_sales_requests

Type: historical_2.TimeAndSalesRequest

time_bar_requests

Type: historical_2.TimeBarRequest

volume_profile_requests

Type: historical_2.VolumeProfileRequest

non_timed_bar_requests

Type: historical_2.NonTimedBarRequest

rule_requests

Type: rules_1.RuleRequest

Description: Rules requests.

account_logon_requests (deprecated)

Type: account_authorization_2.AccountLogon

account_password_change_requests

Type: account_authorization_2.AccountPasswordChange

account_logoff_requests

Type: account_authorization_2.AccountLogoff

account_logon_routines_client

Type: account_authorization_2.AccountLogonRoutineClient

account_password_change_routines_client

Type: account_authorization_2.AccountPasswordChangeRoutineClient

metadata_admin_requests

Type: metadata_admin_2.MetadataAdminRequest

Description: Administrative messages to manipulate security and instrument settings.

otc_requests

Type: otc_1.OtcRequest

Description: OTC related requests. Used to receive data from OTC and manipulate OTC instances.

rfq_requests

Type: market_data_2.RFQRequest

Description: RFQ requests.

rfq_subscription_requests

Type: market_data_2.RFQSubscriptionRequest

Description: RFQ subscription requests.

option_calculation_requests

Type: market_data_2.OptionCalculationRequest

Description: Option calculation requests.

cqg_requests

Type: cqg_api.Request

Description: Requests to new CQG data delivery system.