Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stoqey/ibkr
Interactive Brokers wrapper 🚩
https://github.com/stoqey/ibkr
forex-api ibkr ibkr-api interactive-brokers market market-data options-api price-updates stocks-api trading-api twsapi
Last synced: 21 days ago
JSON representation
Interactive Brokers wrapper 🚩
- Host: GitHub
- URL: https://github.com/stoqey/ibkr
- Owner: stoqey
- License: mit
- Created: 2020-04-09T01:00:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T03:29:47.000Z (almost 2 years ago)
- Last Synced: 2024-05-01T11:35:38.896Z (8 months ago)
- Topics: forex-api, ibkr, ibkr-api, interactive-brokers, market, market-data, options-api, price-updates, stocks-api, trading-api, twsapi
- Language: TypeScript
- Homepage:
- Size: 881 KB
- Stars: 55
- Watchers: 6
- Forks: 11
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
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
```bash
npm i @stoqey/ibkr
```
## 2. Usage
### Initialize
```ts
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
```ts
const accountId = AccountSummary.Instance.accountSummary.AccountId;
const totalCashValue = AccountSummary.Instance.accountSummary.TotalCashValue;
```
### Portfolios
```ts
// 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
```ts
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
```ts
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' });
```
```ts
// Unsubscribe from price updates
ibkrEvents.emit(IBKREVENTS.UNSUBSCRIBE_PRICE_UPDATES, symbol);
```
### Contracts
```ts
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
```ts
import { Orders, OrderStock } from '@stoqey/ibkr';
const orderTrade = Orders.Instance;
const myStockOrder: OrderStock = { ... }
const placedOrder = await orderTrade.placeOrder(myStockOrder);
```
**OrderStock**
```ts
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
```ts
ibkrEvents.on(IBKREVENTS.ORDER_FILLED, (data) => {
});
```
- Order status
```ts
ibkrEvents.on(IBKREVENTS.ORDER_STATUS, (data) => {
});
```
- Open Orders updates
```ts
ibkrEvents.on(IBKREVENTS.OPEN_ORDERS, (data) => {
});
```
**Mosaic Scanner**
```ts
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](https://github.com/visionmedia/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](/docs/changelog/README.md)
Stoqey Inc