Overview

Key Features

1. Install

npm i @stoqey/ibkr

2. Usage

IBKR_HOST=localhostIBKR_PORT=7497IBKR_CLIENT_ID=123DEBUG=ibkr*

Initialize

importibkrfrom'@stoqey/ibkr';awaitibkr();// your code

Accounts Summary e.t.c

import{AccountSummary}from"@stoqey/ibkr";constaccountInstance=AccountSummary.Instance;// account summaries is automatically updated for youconstaccountSummaries=accountInstance.accountSummary;constaccountId=accountSummaries.accountId;consttotalCashValue=accountSummaries.TotalCashValue.value;

Portfolios

import{Portfolios}from"@stoqey/ibkr";// Get current portfoliosconstportfolios=Portfolios.Instance;// positions is automatically updated for youconstaccountPortfolios=portfolios.positions;

Historical Data + Realtime price updates

import{MarketDataManager}from'@stoqey/ibkr';// 1. Get market data managerconstmkdManager=MarketDataManager.Instance;// 2. Get market data async promiseconstdata=awaitmkdManager.getHistoricalData(contract,endDateTime,durationStr,barSizeSetting,whatToShow,useRTH);

import{MarketDataManager,IBKREvents,IBKREVENTS}from'@stoqey/ibkr';// 1. Get IBKR eventsconstibkrEvents=IBKREvents.Instance;// 2. Get market data managerconstmkdManager=MarketDataManager.Instance;// 3. Request historical data updatesawaitmkdManager.getHistoricalDataUpdates(contract,barSizeSetting,whatToShow);// 3. Subscribe for historical data updatesibkrEvents.on(IBKREVENTS.IBKR_BAR,(bar:MarketData)=>{// use the historical data updates here});// 4. get the cached marketdataconstcachedData=awaitmkdManager.historicalData(contract,start,end)

// Unsubscribe from historical data updatesmkdManager.removeHistoricalDataUpdates(contract);

Contracts

import{MarketDataManager}from'@stoqey/ibkr';// 1. Get market data managerconstmkdManager=MarketDataManager.Instance;constcontract={symbol:"PLTR",secType:"STK"};constcontractDetails=awaitmkdManager.getContract(contract);//  or e.g optionsconstcontractDetails=awaitmkdManager.getContract({currency:'USD',exchange:'SMART',multiplier:100,right:'C',secType:'OPT',strike:300,symbol:'AAPL'});// e.g forexconstcontractDetails=awaitmkdManager.getContract({"symbol":"GBP","secType":"CASH","currency":"USD",});

Orders

import{Orders,OrderStock,IBKREvents,IBKREVENTS}from'@stoqey/ibkr';// 1. Get IBKR eventsconstibkrEvents=IBKREvents.Instance;// 2. Get orders managerconstordersManager=Orders.Instance;// 3. Place orderconstcontract=awaitmkdManager.getContract({symbol:ticker,secType:"STK"/* STK, OPT, FUT, etc. */,exchange:"SMART"/* SMART, NYSE, NASDAQ, etc. */,currency:"USD"/* USD, EUR, GBP, etc. */})constmyOrder={  action,// 1. BUY, 2. SELLtotalQuantity:quantity,orderType:price ?OrderType.LIMIT :OrderType.MARKET,// 1. MARKET, 2. LIMIT, 3. STOP, etc.  ...(price&&{lmtPrice:price}),transmit:true,// true to submit order immediately, false to save as draftoutsideRth:false,// true to allow execution outside regular trading hours, false otherwisetif:"DAY",// DAY (day order), GTC (good till canceled), IOC (immediate or cancel), etc.};constplacedOrder=awaitordersManager.placeOrder(contract,myOrder);// 4. Modify orderconstmodifyOrder=awaitordersManager.modifyOrder(id,contract,myOrder);// get orders, this is automatically updatedconstorders=ordersManager.orders;// get filled orders(trades), this is automatically updatedconsttrades=ordersManager.trades;// subscribe for trades, when orders are filled in real timeibkrEvents.on(IBKREVENTS.IBKR_SAVE_TRADE,(bar:Trade)=>{// use trade here});// other methods e.t.c....awaitordersManager.cancelOrder(orderId)awaitordersManager.cancelAllOrders()

3. Debug

See change log for updates

Community