@stoqey/ib/dist/common/errorCode.d.ts

Interactive Brokers TWS/IB Gateway API client library for Node.js (TS)

/**
 * [[IBApi]] error event codes.
 */
export declare enum ErrorCode {
    /** No request id associated to this error */
    NO_VALID_ID = -1,
    /** Order Canceled - reason: */
    ORDER_CANCELLED = 202,
    /** Order Message: BUY 1 SPY ARCA Warning: your order will not be placed at the exchange until 2024-12-02 04:00:00 US/Eastern (#399) */
    ORDER_MESSAGE = 399,
    /** You must subscribe for additional permissions to obtain precise results for scanner.Parameter:Most Active,Filter:Price;Real-Time Market Data:Pink Sheets */
    SCANNER_LOW_PRECISION = 492,
    /** Requested market data is not subscribed. Delayed market data is not available. */
    REQ_MKT_DATA_NOT_AVAIL = 354,
    /** No trading permissions. */
    NO_TRADING_PERMISSIONS = 460,
    /** Already connected. */
    ALREADY_CONNECTED = 501,
    /**
     * Couldn't connect to TWS.
     *
     * Confirm that "Enable ActiveX and Socket Clients" is enabled and connection port is the same as Socket Port on
     * the TWS  "Edit->Global Configuration...->API->Settings" menu.
     *
     * Live Trading ports: TWS: 7496; IB Gateway: 4001.
     *
     * Simulated Trading ports for new installations of version 954.1 or newer: TWS: 7497; IB Gateway: 4002
     */
    CONNECT_FAIL = 502,
    /** The TWS is out of date and must be upgraded. */
    UPDATE_TWS = 503,
    /** Not connected. */
    NOT_CONNECTED = 504,
    /** Fatal Error: Unknown message id. */
    UNKNOWN_ID = 505,
    /** Unsupported Version. */
    UNSUPPORTED_VERSION = 506,
    /** Bad Message Length. */
    BAD_LENGTH = 507,
    /** Bad Message. */
    BAD_MESSAGE = 508,
    /** Failed to send message. */
    FAIL_SEND = 509,
    /** Request Market Data Sending Error. */
    FAIL_SEND_REQMKT = 510,
    /** Cancel Market Data Sending Error. */
    FAIL_SEND_CANMKT = 511,
    /** Order Sending Error. */
    FAIL_SEND_ORDER = 512,
    /** Account Update Request Sending Error. */
    FAIL_SEND_ACCT = 513,
    /** Request For Executions Sending Error. */
    FAIL_SEND_EXEC = 514,
    /** Cancel Order Sending Error. */
    FAIL_SEND_CORDER = 515,
    /** Request Open Order Sending Error. */
    FAIL_SEND_OORDER = 516,
    /** Unknown contract. Verify the contract details supplied. */
    UNKNOWN_CONTRACT = 517,
    /** Request Contract Data Sending Error. */
    FAIL_SEND_REQCONTRACT = 518,
    /** Request Market Depth Sending Error. */
    FAIL_SEND_REQMKTDEPTH = 519,
    /** Cancel Market Depth Sending Error. */
    FAIL_SEND_CANMKTDEPTH = 520,
    /** Set Server Log Level Sending Error. */
    FAIL_SEND_SERVER_LOG_LEVEL = 521,
    /** FA Information Request Sending Error. */
    FAIL_SEND_FA_REQUEST = 522,
    /** FA Information Replace Sending Error. */
    FAIL_SEND_FA_REPLACE = 523,
    /** Request Scanner Subscription Sending Error . */
    FAIL_SEND_REQSCANNER = 524,
    /** Cancel Scanner Subscription Sending Error. */
    FAIL_SEND_CANSCANNER = 525,
    /** Request Scanner Parameter Sending Error. */
    FAIL_SEND_REQSCANNERPARAMETERS = 526,
    /** Request Historical Data Sending Error. */
    FAIL_SEND_REQHISTDATA = 527,
    /** Request Historical Data Sending Error. */
    FAIL_SEND_CANHISTDATA = 528,
    /** Request Real-time Bar Data Sending Error. */
    FAIL_SEND_REQRTBARS = 529,
    /** Cancel Real-time Bar Data Sending Error. */
    FAIL_SEND_CANRTBARS = 530,
    /** Request Current Time Sending Error. */
    FAIL_SEND_REQCURRTIME = 531,
    /** Request Fundamental Data Sending Error. */
    FAIL_SEND_REQFUNDDATA = 532,
    /** Cancel Fundamental Data Sending Error. */
    FAIL_SEND_CANFUNDDATA = 533,
    /** Request Calculate Implied Volatility Sending Error. */
    FAIL_SEND_REQCALCIMPLIEDVOLAT = 534,
    /** Request Calculate Option Price Sending Error. */
    FAIL_SEND_REQCALCOPTIONPRICE = 535,
    /** Cancel Calculate Implied Volatility Sending Error. */
    FAIL_SEND_CANCALCIMPLIEDVOLAT = 536,
    /** Cancel Calculate Option Price Sending Error. */
    FAIL_SEND_CANCALCOPTIONPRICE = 537,
    /** Request Global Cancel Sending Error. */
    FAIL_SEND_REQGLOBALCANCEL = 538,
    /** Request Market Data Type Sending Error. */
    FAIL_SEND_REQMARKETDATATYPE = 539,
    /** Request Positions Sending Error. */
    FAIL_SEND_REQPOSITIONS = 540,
    /** Cancel Positions Sending Error. */
    FAIL_SEND_CANPOSITIONS = 541,
    /** Request Account Data Sending Error. */
    FAIL_SEND_REQACCOUNTDATA = 542,
    /** Cancel Account Data Sending Error. */
    FAIL_SEND_CANACCOUNTDATA = 543,
    /** Verify Request Sending Error. */
    FAIL_SEND_VERIFYREQUEST = 544,
    /** Verify Message Sending Error. */
    FAIL_SEND_VERIFYMESSAGE = 545,
    /** Query Display Groups Sending Error. */
    FAIL_SEND_QUERYDISPLAYGROUPS = 546,
    /** Subscribe To Group Events Sending Error. */
    FAIL_SEND_SUBSCRIBETOGROUPEVENTS = 547,
    /** Update Display Group Sending Error. */
    FAIL_SEND_UPDATEDISPLAYGROUP = 548,
    /** Unsubscribe From Group Events Sending Error. */
    FAIL_SEND_UNSUBSCRIBEFROMGROUPEVENTS = 549,
    /** Start API Sending Error. */
    FAIL_SEND_STARTAPI = 550,
    /** Verify And Auth Request Sending Error. */
    FAIL_SEND_VERIFYANDAUTHREQUEST = 551,
    /** Verify And Auth Message Sending Error. */
    FAIL_SEND_VERIFYANDAUTHMESSAGE = 552,
    /** Request Positions Multi Sending Error. */
    FAIL_SEND_REQPOSITIONSMULTI = 553,
    /** Cancel Positions Multi Sending Error. */
    FAIL_SEND_CANPOSITIONSMULTI = 554,
    /** Request Account Updates Multi Sending Error. */
    FAIL_SEND_REQACCOUNTUPDATESMULTI = 555,
    /** Cancel Account Updates Multi Sending Error. */
    FAIL_SEND_CANACCOUNTUPDATESMULTI = 556,
    /** Request Security Definition Option Params Sending Error. */
    FAIL_SEND_REQSECDEFOPTPARAMS = 557,
    /** Request Soft Dollar Tiers Sending Error. */
    FAIL_SEND_REQSOFTDOLLARTIERS = 558,
    /** Request Family Codes Sending Error. */
    FAIL_SEND_REQFAMILYCODES = 559,
    /** Request Matching Symbols Sending Error. */
    FAIL_SEND_REQMATCHINGSYMBOLS = 560,
    /** Request Market Depth Exchanges Sending Error. */
    FAIL_SEND_REQMKTDEPTHEXCHANGES = 561,
    /** Request Smart Components Sending Error. */
    FAIL_SEND_REQSMARTCOMPONENTS = 562,
    /** Request News Providers Sending Error. */
    FAIL_SEND_REQNEWSPROVIDERS = 563,
    /** Request News Article Sending Error. */
    FAIL_SEND_REQNEWSARTICLE = 564,
    /** Request Historical News Sending Error. */
    FAIL_SEND_REQHISTORICALNEWS = 565,
    /** Request Head Time Stamp Sending Error. */
    FAIL_SEND_REQHEADTIMESTAMP = 566,
    /** CRequest Histogram Data Sending Error */
    FAIL_SEND_REQHISTOGRAMDATA = 567,
    /** Request Market Rule Sending Error. */
    FAIL_SEND_CANCELHISTOGRAMDATA = 568,
    /** Cancel PnL Single Sending Error. */
    FAIL_SEND_CANCELHEADTIMESTAMP = 569,
    /** Request Historical Ticks Sending Error. */
    FAIL_SEND_HISTORICAL_TICK = 569,
    /** Request Market Rule Sending Error. */
    FAIL_SEND_REQMARKETRULE = 570,
    /** Request PnL Sending Error. */
    FAIL_SEND_REQPNL = 571,
    /** Cancel PnL Sending Error. */
    FAIL_SEND_CANCELPNL = 572,
    /** Request PnL Single Error. */
    FAIL_SEND_REQPNLSINGLE = 573,
    /** Cancel PnL Single Sending Error . */
    FAIL_SEND_CANCELPNLSINGLE = 574,
    /** Request Historical Ticks Error. */
    FAIL_SEND_REQHISTORICALTICKS = 575,
    /** Request Tick-By-Tick Data Sending Error */
    FAIL_SEND_REQTICKBYTICKDATA = 576,
    /** Cancel Tick-By-Tick Data Sending Error */
    FAIL_SEND_CANCELTICKBYTICKDATA = 577,
    /** Request Completed Orders Sending Error  */
    FAIL_SEND_REQCOMPLETEDORDERS = 578,
    /** Invalid symbol in string */
    INVALID_SYMBOL = 579,
    /** "Request WSH Meta Data Sending Error */
    FAIL_SEND_REQ_WSH_META_DATA = 580,
    /** Cancel WSH Meta Data Sending Error */
    FAIL_SEND_CAN_WSH_META_DATA = 581,
    /** Request WSH Event Data Sending Error */
    FAIL_SEND_REQ_WSH_EVENT_DATA = 582,
    /** Cancel WSH Event Data Sending Error */
    FAIL_SEND_CAN_WSH_EVENT_DATA = 583,
    /** Request User Info Sending Error */
    FAIL_SEND_REQ_USER_INFO = 584,
    /** FA Profile is not supported anymore, use FA Group instead */
    FA_PROFILE_NOT_SUPPORTED = 585,
    /** Failed to read message because not connected */
    FAIL_READ_MESSAGE = 586,
    /** Connectivity between IBKR and Trader Workstation has been lost.
     * @When client is connected to TWS and server but TWS losses connection to server.
     * 🗣️🗣️🗣️ "Market data connection lost".
     */
    FAIL_CONNECTION_LOST_BETWEEN_SERVER_AND_TWS = 1100,
    /** Connectivity between Trader Workstation and server is broken. It will be restored automatically.
     * @When client connects to TWS but TWS isn't connected to server.
     */
    FAIL_CONNECTION_LOST_BETWEEN_TWS_AND_SERVER = 2110,
    /** Invalid position trade derived value */
    INVALID_POSITION_TRADE_DERIVATED_VALUE = 2150,
    /** Part of requested market data is not subscribed. */
    PART_OF_REQUESTED_DATA_NOT_SUBSCRIBED = 10090,
    /** Requested market data is not subscribed. Displaying delayed market data. */
    DISPLAYING_DELAYED_DATA = 10167,
    NEWS_FEED_NOT_ALLOWED = 10276
}
/**
 * Check if an error message is fatal (to the request execution) or only a warning/information message
 */
export declare const isNonFatalError: (code: ErrorCode, error: Error) => boolean;