@huskly/ibkr-client 0.2.0

package/dist/types.d.ts

@@ -0,0 +1,81 @@
+/**
+ * Broker-neutral domain types shared across the CLI.
+ *
+ * Command handlers render these normalized shapes and never touch raw broker
+ * JSON. Both the IBKR client (here) and Schwab (when this is merged into
+ * huskly-cli) implement {@link BrokerClient}, so a single set of handlers can
+ * serve either broker. The field names mirror huskly-cli's `getAccountBalances`
+ * / `SchwabPosition` shapes to keep that future merge mechanical.
+ */
+export type BrokerName = "ibkr" | "schwab";
+export interface AuthStatus {
+    authenticated: boolean;
+    competing: boolean;
+}
+export interface AccountBalances {
+    netLiquidation: number;
+    availableFunds: number;
+    buyingPower: number;
+    cashBalance: number;
+}
+export interface BrokerPosition {
+    /** Human-readable contract symbol/description. */
+    symbol: string;
+    /** Normalized asset type, e.g. EQUITY, OPTION, FUTURE. */
+    assetType: string;
+    longQuantity: number;
+    shortQuantity: number;
+    averagePrice: number;
+    marketPrice: number;
+    marketValue: number;
+    /** P/L for the current trading day. */
+    currentDayProfitLoss: number;
+    /** Unrealized open P/L. */
+    openProfitLoss: number;
+}
+export interface BrokerInstrument {
+    /** Broker-native contract id (IBKR conid), as a string. */
+    brokerId?: string;
+    symbol?: string;
+    description?: string;
+    exchange?: string;
+    assetType?: string;
+}
+export interface BrokerQuoteReference {
+    description?: string;
+    exchange?: string;
+    exchangeName?: string;
+}
+export interface BrokerQuoteData {
+    lastPrice?: number;
+    bidPrice?: number;
+    askPrice?: number;
+    closePrice?: number;
+    highPrice?: number;
+    lowPrice?: number;
+    openPrice?: number;
+    netChange?: number;
+    netPercentChange?: number;
+    totalVolume?: number;
+}
+/**
+ * Broker-neutral quote, mirroring huskly-cli's (Schwab-shaped) `BrokerQuote` so
+ * consumers normalize IBKR and Schwab quotes through one code path.
+ */
+export interface BrokerQuote {
+    symbol: string;
+    reference: BrokerQuoteReference;
+    quote: BrokerQuoteData;
+}
+/**
+ * The contract every broker client satisfies. Kept intentionally small (account,
+ * positions, quotes); extend as commands are added.
+ */
+export interface BrokerClient {
+    getAuthStatus(): Promise<AuthStatus>;
+    getAccountId(): Promise<string>;
+    getAccountBalances(): Promise<AccountBalances>;
+    getPositions(symbol?: string): Promise<BrokerPosition[]>;
+    getQuotes(symbols: string[]): Promise<Record<string, BrokerQuote>>;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE3C,MAAM,WAAW,UAAU;IACzB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,2BAA2B;IAC3B,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,2DAA2D;IAC3D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,oBAAoB,CAAC;IAChC,KAAK,EAAE,eAAe,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,kBAAkB,IAAI,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/C,YAAY,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACzD,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;CACpE"}

package/dist/types.js

@@ -0,0 +1,11 @@
+/**
+ * Broker-neutral domain types shared across the CLI.
+ *
+ * Command handlers render these normalized shapes and never touch raw broker
+ * JSON. Both the IBKR client (here) and Schwab (when this is merged into
+ * huskly-cli) implement {@link BrokerClient}, so a single set of handlers can
+ * serve either broker. The field names mirror huskly-cli's `getAccountBalances`
+ * / `SchwabPosition` shapes to keep that future merge mechanical.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG"}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@huskly/ibkr-client",
+  "version": "0.2.0",
+  "description": "Interactive Brokers Web API client (OAuth 1.0a) and terminal CLI",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "bin": {
+    "ibkr-cli": "./dist/cli/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": "github.com/huskly/ibkr-client",
+  "author": "Felipe Lima",
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsx src/cli/index.ts",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\"",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "check": "npm run lint && npm run format:check && npm run typecheck",
+    "prepublishOnly": "npm run clean && npm run build"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "dotenv": "^17.2.3",
+    "ibkr-client": "^1.0.4"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^25",
+    "eslint": "^9.16.0",
+    "eslint-config-prettier": "^10",
+    "prettier": "^3.4.2",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.49.0"
+  }
+}