README.md

IBKR: Interactive Brokers

Run IBKR in style

This is an event-based ibkr client for node

	Feature
✅	Accounts
✅	Portfolios
✅	Orders
✅	Historical Data
✅	Realtime price updates
✅	Contracts (stocks/forex/options/index .e.t.c)
✅	Mosaic Market scanner
⬜️	News

1. Install

npm i @stoqey/ibkr

2. Usage

Initialize

import ibkr, { AccountSummary, IBKREVENTS, IbkrEvents, PortFolioUpdate, getContractDetails } from '@stoqey/ibkr';

const ibkrEvents = IbkrEvents.Instance;


// 0. Using env process.env.IB_PORT and process.env.IB_HOST
await ibkr();

// 1. Async 
await ibkr({ port: IB_PORT, host: IB_HOST });

// 2. Callback
ibkr({ port: IB_PORT, host: IB_HOST }).then(started => {
  
    if(!started){
          // Error IBKR has not started
          console.log('error cannot start ibkr');
        //   Not to proceed if not connected with interactive brokers
          return process.exit(1);
    }

    // Your code here

})

Accounts, Summary e.t.c

const accountId = AccountSummary.Instance.accountSummary.AccountId;
const totalCashValue = AccountSummary.Instance.accountSummary.TotalCashValue;

Portfolios

// Get current portfolios
const portfolios = Portfolios.Instance;
const accountPortfolios = await portfolios.getPortfolios();

// Subscribe to portfolio updates
ibkrEvents.on(IBKREVENTS.PORTFOLIOS, (porfolios: PortFolioUpdate[]) => {
      // use porfolios  updates here
})

Historical Data + Realtime price updates

• Market data

import { HistoricalData } from '@stoqey/ibkr';

// 1. Init
const historyApi = HistoricalData.Instance;

const args = {
  symbol,
  // contract: ib.contract.stock("AAPL"),
  endDateTime = '',
  durationStr = '1 D',
  barSizeSetting = '1 min',
  whatToShow = 'ASK'
};

// 2. Get market data async promise
const data = await historyApi.reqHistoricalData(args);

// OR 

// 3.1 Request for market data using events
historyApi.getHistoricalData(args);
ibkrEvents.emit(IBKREVENTS.GET_MARKET_DATA, args); // the same

// 3.2. Subscribe to market data results
ibkrEvents.on(IBKREVENTS.ON_MARKET_DATA, ({ symbol, marketData }) => {
    //  Use the data here
})

• Real-time price updates

import { PriceUpdates } from '@stoqey/ibkr';

PriceUpdates.Instance; // init

// subscribe for price updates
ibkrEvents.on(IBKREVENTS.ON_PRICE_UPDATES, (priceUpdates) => {
     // use the price updates here
 });

//  Request price updates
ibkrEvents.emit(IBKREVENTS.SUBSCRIBE_PRICE_UPDATES, { symbol: 'AAPL' });

// Unsubscribe from price updates
ibkrEvents.emit(IBKREVENTS.UNSUBSCRIBE_PRICE_UPDATES, symbol);

Contracts

 
const contractDetails = await getContractDetails(ib.contract.stock("AAPL"));

//  or e.g options
const contractDetails = await getContractDetails({
    currency: 'USD',
    exchange: 'SMART',
    multiplier: 100,
    right: 'C',
    secType: 'OPT',
    strike: 300,
    symbol: 'AAPL'
});

// e.g forex
const contractDetails = await getContractDetails({
    "symbol":"GBP",
    "secType":"CASH",
    "currency":"USD",
     // "localSymbol":"GBP.USD",
});


// or with just a symbol, defaults to stocks
 const contractDetails = await getContractDetails('AAPL');

Orders

import { Orders, OrderStock } from '@stoqey/ibkr';

const orderTrade = Orders.Instance;

const myStockOrder: OrderStock = { ... }

const placedOrder = await orderTrade.placeOrder(myStockOrder);
          

OrderStock

const stockOrderBuyOut: OrderStock = {
    symbol: symbol,
    action: "SELL",
    type: "limit",
    parameters: ["1", "9999"], // 'SELL', 1, 9999,
}

type

• limit ('SELL', 1, 9999) like in example above
• market (action, quantity, transmitOrder, goodAfterTime, goodTillDate)
• marketClose (action, quantity, price, transmitOrder)
• stop (action, quantity, price, transmitOrder, parentId, tif)
• stopLimit (action, quantity, limitPrice, stopPrice, transmitOrder, parentId, tif)
• trailingStop (action, quantity, auxPrice, tif, transmitOrder, parentId)

Order events

• Order filled

ibkrEvents.on(IBKREVENTS.ORDER_FILLED, (data) => {

});

• Order status

ibkrEvents.on(IBKREVENTS.ORDER_STATUS, (data) => {

});

• Open Orders updates

ibkrEvents.on(IBKREVENTS.OPEN_ORDERS, (data) => {

});

Mosaic Scanner

import { MosaicScanner } from '@stoqey/ibkr';
const mosaicScanner = new MosaicScanner();

const scannerData = await mosaicScanner.scanMarket({
      instrument: 'STK',
      locationCode: 'STK.US.MAJOR',
      numberOfRows: 10,
      scanCode: 'TOP_PERC_GAIN',
      stockTypeFilter: 'ALL'
})

see any .test.ts file for examples

3. Debug

We use debug library for logging. Run with DEBUG=ibkr:* to see all logs, or DEBUG=ibkr:info for less verbose logs.

See change log for updates

Stoqey Inc