Independent Enums

Enum ApiLimit

Description: Range 110000-299999 is reserved for requests in cqg_api.Request messages.

A subrange of 10 values is reserved for each request type. The offset is calculated as: 110000 + request_type_id * 10.

Limits for each request type will have offsets: 110000 + request_type_id * 10 + N, where N = [1-10].

Currently, there are three per-request limits: 1. Maximum number of requests of the corresponding type per output period. 2. Maximum number of requests of the corresponding type in processing util a snapshot received. 3. Maximum number of subscriptions for updates.

A request exceeding any of the limits will be rejected.

For example, for cqg_api.rates.ImpliedRateRequest with (request_type_id) = 250: * API_LIMIT_IMPLIED_RATE_REQUEST_RATE = 112501; // 110000 + 25010 + 1  API_LIMIT_IMPLIED_RATE_REQUESTS_IN_PROCESSING = 112502; * API_LIMIT_IMPLIED_RATE_SUBSCRIPTIONS = 112503;

If a limit for a request type is not returned, or is returned with status code API_LIMIT_ENTRY_STATUS_CODE_NOT_FOUND, it indicates that no limit is currently enforced.

Values

      API_LIMIT_UNSPECIFIED = 0

     Limit type unspecified and must be ignored.

      API_LIMIT_CONNECTION_RATE = 1

     Max connection rate from one IP address

      API_LIMIT_CONCURRENT_SUBSESSIONS = 2

     Max concurrent subsessions per user

      API_LIMIT_CONNECTIONS_PER_IP = 3

     Number of maximum allowed simultaneous connections from single IP address

      API_LIMIT_SOCKET_UNREADY_PERIOD_TO_CLOSE_CONNECTION = 100

     Maximum allowed duration (in seconds) of WebSocket unavailability for outgoing messages.

      API_LIMIT_CLIENT_MESSAGES_RATE = 110

      API_LIMIT_INFORMATION_REQUESTS_RATE = 200

      API_LIMIT_ACCOUNTS_REQUESTS_RATE = 210

      API_LIMIT_SYMBOL_RESOLUTION_REQUESTS_RATE = 220

      API_LIMIT_LAST_STATEMENT_BALANCES_RATE = 230

      API_LIMIT_CURRENCY_RATES_REQUESTS_RATE = 240

      API_LIMIT_CURRENCY_RATE_SOURCES_REQUESTS_RATE = 241

      API_LIMIT_SESSION_INFORMATION_REQUESTS_IN_PROCESSING = 250

      API_LIMIT_SESSION_INFORMATION_SUBSCRIPTIONS = 251

      API_LIMIT_HISTORICAL_ORDERS_REQUESTS_IN_PROCESSING = 260

      API_LIMIT_HISTORICAL_ORDERS_DAYS = 261

     Maximum allowed days back from now for historical orders requests. Requests exceeding the limit fail.

      API_LIMIT_OPTION_MATURITY_LIST_REQUESTS_IN_PROCESSING = 270

      API_LIMIT_OPTION_MATURITY_LIST_SUBSCRIPTIONS = 271

      API_LIMIT_INSTRUMENT_GROUP_REQUESTS_IN_PROCESSING = 280

      API_LIMIT_INSTRUMENT_GROUP_SUBSCRIPTIONS = 281

      API_LIMIT_AT_THE_MONEY_STRIKE_REQUESTS_IN_PROCESSING = 290

      API_LIMIT_AT_THE_MONEY_STRIKE_SUBSCRIPTIONS = 291

      API_LIMIT_STRATEGY_DEFINITION_REQUESTS_RATE = 300

      API_LIMIT_SESSION_TIME_RANGE_REQUESTS_IN_PROCESSING = 310

      API_LIMIT_TRADING_DAY_TIME_RANGE_REQUESTS_IN_PROCESSING = 320

      API_LIMIT_ORDER_ENTITLEMENT_REQUESTS_IN_PROCESSING = 330

      API_LIMIT_SYMBOL_CATEGORY_LIST_REQUESTS_IN_PROCESSING = 340

      API_LIMIT_SYMBOL_CATEGORY_LIST_SUBSCRIPTIONS = 341

      API_LIMIT_SYMBOL_CATEGORY_REQUESTS_IN_PROCESSING = 350

      API_LIMIT_SYMBOL_CATEGORY_SUBSCRIPTIONS = 351

      API_LIMIT_SYMBOL_LIST_REQUESTS_IN_PROCESSING = 360

      API_LIMIT_SYMBOL_LIST_SUBSCRIPTIONS = 361

      API_LIMIT_SYMBOL_REQUESTS_RATE = 370

      API_LIMIT_SYMBOL_REQUESTS_IN_PROCESSING = 371

      API_LIMIT_ALGO_STRATEGY_DEFINITION_REQUESTS_IN_PROCESSING = 380

      API_LIMIT_API_LIMITS_SUBSCRIPTIONS_AND_REQUESTS_IN_PROCESSING = 390

      API_LIMIT_CONTRIBUTOR_METADATA_REQUESTS_RATE = 400

      API_LIMIT_CONTRIBUTOR_METADATA_REQUESTS_IN_PROCESSING = 401

      API_LIMIT_CONTRIBUTOR_METADATA_SUBSCRIPTIONS = 402

API_LIMIT_BROKERAGE_TRADING_FEATURE_ENTITLEMENT_REQUESTS_IN_PROCESSING = 410

      API_LIMIT_ORDER_STATUS_REQUESTS_RATE = 420

      API_LIMIT_PRODUCT_SEARCH_REQUESTS_RATE = 430

      API_LIMIT_PRODUCT_SEARCH_REQUESTS_IN_PROCESSING = 431

      API_LIMIT_SYMBOL_CATEGORY_LIST_BY_INSTRUMENT_TYPE_REQUESTS_RATE = 440

API_LIMIT_SYMBOL_CATEGORY_LIST_BY_INSTRUMENT_TYPE_REQUESTS_IN_PROCESSING = 441

      API_LIMIT_MARKET_STATE_METADATA_REQUESTS_RATE = 450

      API_LIMIT_MARKET_STATE_METADATA_REQUESTS_IN_PROCESSING = 451

      API_LIMIT_MARKET_STATE_METADATA_SUBSCRIPTIONS = 452

      API_LIMIT_INSTRUMENT_DEFINITION_REQUESTS_RATE = 460

      API_LIMIT_EXCHANGE_METADATA_REQUESTS_IN_PROCESSING = 470

      API_LIMIT_EXCHANGE_METADATA_SUBSCRIPTIONS = 471

      API_LIMIT_ENTITLEMENT_REQUESTS_SUBSCRIPTIONS = 480

      API_LIMIT_INSTRUMENT_GROUP_BY_SECURITIES_REQUESTS_RATE = 490

      API_LIMIT_INSTRUMENT_GROUP_BY_SECURITIES_REQUESTS_IN_PROCESSING = 491

      API_LIMIT_INSTRUMENT_GROUP_BY_SECURITIES_SUBSCRIPTIONS = 492

      API_LIMIT_INSTRUMENT_GROUP_BY_EXCHANGE_REQUESTS_RATE = 500

      API_LIMIT_INSTRUMENT_GROUP_BY_EXCHANGE_REQUESTS_IN_PROCESSING = 501

      API_LIMIT_INSTRUMENT_GROUP_BY_EXCHANGE_SUBSCRIPTIONS = 502

      API_LIMIT_EXCHANGE_SECURITIES_REQUESTS_RATE = 510

      API_LIMIT_EXCHANGE_SECURITIES_REQUESTS_IN_PROCESSING = 511

      API_LIMIT_EXCHANGE_SECURITIES_SUBSCRIPTIONS = 512

      API_LIMIT_COUNTRY_LIST_REQUESTS_RATE = 520

      API_LIMIT_COUNTRY_LIST_REQUESTS_IN_PROCESSING = 521

      API_LIMIT_COUNTRY_LIST_SUBSCRIPTIONS = 522

      API_LIMIT_CALENDAR_EVENT_LIST_REQUESTS_RATE = 530

      API_LIMIT_CALENDAR_EVENT_LIST_REQUESTS_IN_PROCESSING = 531

      API_LIMIT_CALENDAR_EVENT_LIST_SUBSCRIPTIONS = 532

      API_LIMIT_CALENDAR_EVENT_PROVIDER_LIST_REQUESTS_RATE = 540

      API_LIMIT_CALENDAR_EVENT_PROVIDER_LIST_REQUESTS_IN_PROCESSING = 541

      API_LIMIT_CALENDAR_EVENT_PROVIDER_LIST_SUBSCRIPTIONS = 542

      API_LIMIT_CALENDAR_EVENT_TYPE_LIST_REQUESTS_RATE = 550

      API_LIMIT_CALENDAR_EVENT_TYPE_LIST_REQUESTS_IN_PROCESSING = 551

      API_LIMIT_CALENDAR_EVENT_TYPE_LIST_SUBSCRIPTIONS = 552

      API_LIMIT_DIALECT_METADATA_REQUESTS_RATE = 560

      API_LIMIT_TRADE_ROUTING_ACCOUNTS = 600

     Maximum account number per trader to process

      API_LIMIT_TRADE_SUBSCRIPTIONS = 610

      API_LIMIT_TRADE_SUBSCRIPTIONS_ACCOUNTS = 611

     Maximum accounts to subscribe to

      API_LIMIT_ORDER_REQUESTS_RATE = 700

      API_LIMIT_ORDER_REQUESTS_ACCOUNT_RATE = 701

     Rate per account

      API_LIMIT_ALLOCATION_REQUEST_RATE = 702

     Maximum number of allocation requests to process per time period

      API_LIMIT_MARKET_DATA_SUBSCRIPTION_RATE = 800

      API_LIMIT_MARKET_DATA_SUBSCRIPTIONS = 801

      API_LIMIT_MARKET_DATA_DELAY_TO_CLOSE_CONNECTION = 810

     Market data quotes delay threshold (in seconds) after which user will be disconnected.

      API_LIMIT_HISTORICAL_REQUESTS_IN_PROCESSING = 1000

      API_LIMIT_HISTORICAL_SUBSCRIPTIONS = 1001

      API_LIMIT_TIME_AND_SALES_REQUESTS_RATE = 1010

      API_LIMIT_TIME_BAR_REQUESTS_RATE = 1020

      API_LIMIT_VOLUME_PROFILE_REQUESTS_CONTRACT_AND_RANGE_RATE = 1030

     Per contract and time range, not per connection

      API_LIMIT_NON_TIMED_BAR_REQUESTS_RATE = 1040

      API_LIMIT_RULE_REQUESTS_RATE = 1201

      API_LIMIT_RESERVED1 = 1300

      API_LIMIT_PUBLISH_UNPUBLISH_PREVIEW_CONTRACT_REQUESTS_RATE = 1301

      API_LIMIT_PUBLISH_UNPUBLISH_PUBLISHED_CONTRACT_REQUESTS_RATE = 1302

      API_LIMIT_GET_SECURITY_PARAMETERS_REQUESTS_RATE = 1303

      API_LIMIT_SET_SECURITY_PARAMETERS_REQUESTS_RATE = 1304

      API_LIMIT_GET_CONTRACT_PARAMETERS_REQUESTS_RATE = 1305

      API_LIMIT_OTC_INSTANCES_SUBSCRIPTIONS = 1400

      API_LIMIT_HEDGE_BOOKS_SUBSCRIPTIONS = 1410

      API_LIMIT_HEDGE_BOOK_DETAILS_REQUESTS_RATE = 1420

      API_LIMIT_HEDGE_BOOK_DETAILS_REQUESTS_IN_PROCESSING = 1421

      API_LIMIT_HEDGE_BOOK_DETAILS_SUBSCRIPTIONS = 1422

      API_LIMIT_OFFSET_HEDGE_BALANCE_REQUESTS_RATE = 1430

      API_LIMIT_CHANGE_OTC_STATE_REQUESTS_RATE = 1440

      API_LIMIT_FILL_CASH_ORDER_REQUESTS_RATE = 1450

      API_LIMIT_BALANCE_ITEMS_LINKS_REQUESTS_RATE = 1460

      API_LIMIT_ARCHIVE_HEDGE_BALANCE_DETAILS_REQUESTS_RATE = 1470

      API_LIMIT_TAIL_MANAGEMENT_CONFIGURATION_SUBSCRIPTIONS = 1480

      API_LIMIT_UPDATE_TAIL_MANAGEMENT_CONFIGURATION_REQUESTS_RATE = 1490

      API_LIMIT_TAIL_MANAGEMENT_CONFIGURATION_METADATA_REQUESTS_RATE = 10000

      API_LIMIT_RESERVED2 = 10010

      API_LIMIT_RFQ_REQUESTS_ACCOUNT_RATE = 1500

      API_LIMIT_OPTION_CALCULATION_REQUESTS_RATE = 1600

      API_LIMIT_OPTION_CALCULATION_SUBSCRIPTIONS = 1601

      API_LIMIT_RFQ_SUBSCRIPTION_REQUESTS_RATE = 1700

Enum ApiLimitEntryStatusCode

Values

      API_LIMIT_ENTRY_STATUS_CODE_UNSPECIFIED = 0

     Entry not specified and must be ignored.

      API_LIMIT_ENTRY_STATUS_CODE_SUCCESS = 1

     Value is populated.

      API_LIMIT_ENTRY_STATUS_CODE_FAILURE = 101

     General failure, client should use the default value (from proto file comments, descriptions, etc.)

      API_LIMIT_ENTRY_STATUS_CODE_NOT_FOUND = 104

     Limit type not found or already deleted (value is not restricted).