gloomberb 0.14.1 → 0.15.0

package/README.md

@@ -69,7 +69,13 @@ Press `Ctrl+P` to open the command bar, or press `` ` `` to search for a ticker.
 |-----|-------|
 | `DES AAPL` | Company details |
 | `GP NVDA` | Price chart |
+| `OVDV AAPL` | Implied-volatility surface and options term structure |
+| `HVG AAPL` / `HVT AAPL` | Realized volatility and volatility cones |
+| `COT [code or root]` | CFTC positioning and cross-market extremes |
 | `TOP` | Market stories |
+| `WIRP` / `FFIP` | US rate path and conditional FOMC probabilities |
+| `BTMM` | Funding rates, bill curves and Federal Reserve liquidity |
+| `CTM [root]` | Futures contract curve, historical ghosts, roll yield and open interest, including `CTM VX` |
 | `PF` | Portfolios and watchlists |
 | `HELP` | Commands and keyboard shortcuts |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gloomberb",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "packageManager": "bun@1.3.11",
   "description": "Market research and portfolio tracker for the terminal",
   "module": "src/index.tsx",
@@ -109,6 +109,7 @@
     "@opentui/core": "^0.3.2",
     "@opentui/react": "^0.3.2",
     "@tanstack/react-virtual": "^3.14.2",
+    "fast-xml-parser": "5.7.3",
     "hls.js": "1.6.13",
     "jimp": "1.6.1",
     "qrcode-generator": "^2.0.4",

package/src/api-client/askg.ts

@@ -57,6 +57,45 @@ export interface ASKGStreamOptions {
   lastEventId?: number;
 }
 
+/** A stored conversation as the sidebar lists it. */
+export interface ASKGConversationSummary {
+  id: string;
+  title: string | null;
+  messageCount: number;
+  lastMessageAt: string | null;
+  createdAt: string;
+  updatedAt: string;
+}
+
+/**
+ * One tool a stored answer was built from. The platform keeps the call and its
+ * outcome, never its rows, so a reopened conversation names what Gloom ran
+ * without pretending the table is still there to open.
+ */
+export interface ASKGConversationTool {
+  toolCallId: string;
+  name: string;
+  origin: "client" | "server";
+  status: string;
+  args?: Record<string, unknown>;
+  rowCount?: number;
+  elapsedMs?: number;
+  note?: string;
+}
+
+export interface ASKGConversationMessage {
+  seq: number;
+  role: "user" | "assistant";
+  text: string;
+  tools: ASKGConversationTool[];
+  turnId: string | null;
+  createdAt: string;
+}
+
+export interface ASKGConversationDetail extends ASKGConversationSummary {
+  messages: ASKGConversationMessage[];
+}
+
 export interface ASKGTransport {
   isStreamingSupported(): boolean;
   startSession(
@@ -78,6 +117,23 @@ export interface ASKGTransport {
     turnId: string,
     options?: { signal?: AbortSignal },
   ): Promise<void>;
+  listConversations(options?: {
+    signal?: AbortSignal;
+  }): Promise<ASKGConversationSummary[]>;
+  /** Null when the conversation is gone, which a stale sidebar row can be. */
+  loadConversation(
+    id: string,
+    options?: { signal?: AbortSignal },
+  ): Promise<ASKGConversationDetail | null>;
+  renameConversation(
+    id: string,
+    title: string | null,
+    options?: { signal?: AbortSignal },
+  ): Promise<ASKGConversationSummary | null>;
+  deleteConversation(
+    id: string,
+    options?: { signal?: AbortSignal },
+  ): Promise<boolean>;
 }
 
 /** One decoded server-sent event frame. */
@@ -541,4 +597,69 @@ export class CloudASKGApi implements ASKGTransport {
       throw classifyASKGRequestError(error);
     }
   }
+
+  async listConversations(
+    options: { signal?: AbortSignal } = {},
+  ): Promise<ASKGConversationSummary[]> {
+    try {
+      const response = await this.options.request<{
+        items?: ASKGConversationSummary[];
+      }>("/askg/conversations", { signal: options.signal });
+      return response?.items ?? [];
+    } catch (error) {
+      throw classifyASKGRequestError(error);
+    }
+  }
+
+  async loadConversation(
+    id: string,
+    options: { signal?: AbortSignal } = {},
+  ): Promise<ASKGConversationDetail | null> {
+    try {
+      return await this.options.request<ASKGConversationDetail>(
+        `/askg/conversations/${encodeURIComponent(id)}`,
+        { signal: options.signal },
+      );
+    } catch (error) {
+      // A row the sidebar still shows may already be gone elsewhere.
+      if (error instanceof ApiRequestError && error.status === 404) return null;
+      throw classifyASKGRequestError(error);
+    }
+  }
+
+  async renameConversation(
+    id: string,
+    title: string | null,
+    options: { signal?: AbortSignal } = {},
+  ): Promise<ASKGConversationSummary | null> {
+    try {
+      return await this.options.request<ASKGConversationSummary>(
+        `/askg/conversations/${encodeURIComponent(id)}`,
+        {
+          method: "PATCH",
+          body: JSON.stringify({ title }),
+          signal: options.signal,
+        },
+      );
+    } catch (error) {
+      if (error instanceof ApiRequestError && error.status === 404) return null;
+      throw classifyASKGRequestError(error);
+    }
+  }
+
+  async deleteConversation(
+    id: string,
+    options: { signal?: AbortSignal } = {},
+  ): Promise<boolean> {
+    try {
+      await this.options.request<void>(
+        `/askg/conversations/${encodeURIComponent(id)}`,
+        { method: "DELETE", signal: options.signal },
+      );
+      return true;
+    } catch (error) {
+      if (error instanceof ApiRequestError && error.status === 404) return false;
+      throw classifyASKGRequestError(error);
+    }
+  }
 }

package/src/api-client/central-bank-rates.ts

@@ -0,0 +1,37 @@
+import type { MoneyMarketObservation, MoneyMarketPercentile } from "./money-markets";
+
+export interface CentralBankRow {
+  id: string
+  label: string
+  countryCodes: string[]
+  centralBank: string | null
+  instrument: string
+  source: "fred" | "bis" | null
+  sourceUrl: string | null
+  sourceSeriesIds: string[]
+  unit: "percent"
+  publicationFrequency: "daily" | "weekly" | null
+  value: number | null
+  range: { lower: number; upper: number } | null
+  asOf: string | null
+  lagDays: number | null
+  fetchedAt: string | null
+  changeBps: number | null
+  lastChangeDate: string | null
+  previousValue: number | null
+  previousAsOf: string | null
+  direction: "hike" | "cut" | "unchanged" | "unavailable"
+  percentile: MoneyMarketPercentile
+  history: MoneyMarketObservation[]
+  status: "available" | "stale" | "unavailable"
+  unavailableReason: "source-unavailable" | "metadata-mismatch" | "metadata-unavailable" | "no-observations" | "no-policy-rate" | "no-unified-rate" | null
+  notes: string[]
+  nextMeeting: { date: string; sourceUrl: string; verifiedAt: string } | null
+}
+
+export interface CentralBankRatesPayload {
+  generatedAt: string
+  status: "available" | "partial" | "unavailable"
+  rows: CentralBankRow[]
+  gaps: string[]
+}

package/src/api-client/cot.ts

@@ -0,0 +1,72 @@
+export type CotFamily = "legacy" | "disaggregated"
+export type CotClass = "noncommercial" | "commercial" | "producer" | "swap" | "managed-money" | "other-reportable" | "nonreportable"
+export interface CotPosition { long: number | null; short: number | null; spreading: number | null }
+export interface CotPercentile {
+  value: number | null
+  rank: number | null
+  sampleCount: number
+  windowStart: string
+  windowEnd: string
+  historyStart: string | null
+  historyEnd: string | null
+  completeWindow: boolean
+  min: number | null
+  max: number | null
+  mean: number | null
+}
+export interface CotClassSummary extends CotPosition {
+  id: CotClass
+  label: string
+  net: number | null
+  netPercentOfOpenInterest: number | null
+  weeklyChange: number | null
+  previousReportDate: string | null
+  percentile1Y: CotPercentile
+  percentile3Y: CotPercentile
+}
+export interface CotMarket {
+  contractCode: string
+  marketName: string
+  exchangeCode: string
+  commodityCode: string
+}
+export interface CotPayloadBase {
+  source: "CFTC"
+  scope: "futures-only"
+  reportFamily: CotFamily
+  generatedAt: string
+  /** Tuesday position observation date, distinct from publication/download time. */
+  asOf: string | null
+  /** Latest report's actual source download time, not its publication time. */
+  fetchedAt: string | null
+  /** These files do not establish the report's actual publication timestamp. */
+  publishedAt: null
+  status: "available" | "partial" | "unavailable"
+  gaps: string[]
+  classes: Array<{ id: CotClass; label: string }>
+}
+export interface CotBoardRow extends CotMarket {
+  reportDate: string
+  openInterest: number | null
+  position: CotClassSummary
+  status: "available" | "stale" | "unavailable"
+}
+export interface CotBoardPayload extends CotPayloadBase {
+  traderClass: CotClass
+  /** All markets in the latest report, ranked by distance from median 1Y net. */
+  rows: CotBoardRow[]
+}
+export interface CotHistoryPoint {
+  reportDate: string
+  openInterest: number | null
+  positions: Array<CotPosition & { id: CotClass; net: number | null; netPercentOfOpenInterest: number | null }>
+}
+export interface CotContractPayload extends CotPayloadBase {
+  contract: CotMarket | null
+  sourceUrl: string | null
+  openInterest: number | null
+  /** Latest report's classes, each with 1Y and 3Y dated distribution context. */
+  positions: CotClassSummary[]
+  /** Oldest first. Missing/suppressed legs and corresponding net remain null. */
+  history: CotHistoryPoint[]
+}

package/src/api-client/crypto-markets.ts

@@ -0,0 +1,49 @@
+/** Completed UTC daily closes, oldest first, one slot per calendar day. */
+export interface CryptoDailyCloses {
+  start: string;
+  closes: Array<number | null>;
+}
+
+export type CryptoAssetKind = "coin" | "stablecoin";
+
+export interface CryptoMarketAsset {
+  /** Quote symbol for streaming and the ticker pane, for example BTC-USD. */
+  symbol: string;
+  /** Display code, for example BTC. */
+  code: string;
+  name: string;
+  kind: CryptoAssetKind;
+  /** Market-cap rank within its kind. */
+  rank: number;
+  price: number;
+  previousClose: number | null;
+  change: number | null;
+  changePercent: number | null;
+  dayHigh: number | null;
+  dayLow: number | null;
+  volume24h: number | null;
+  marketCap: number | null;
+  circulatingSupply: number | null;
+  maxSupply: number | null;
+  high52w: number | null;
+  low52w: number | null;
+  /** Price one year before the quote, so a live price can restate the 1Y return. */
+  yearAgoPrice: number | null;
+  quoteTime: string | null;
+  history: CryptoDailyCloses | null;
+}
+
+export interface CryptoMarketsPayload {
+  version: 1;
+  generatedAt: string;
+  asOf: string | null;
+  status: "available" | "partial" | "unavailable";
+  source: {
+    name: string;
+    url: string;
+    screenerFetchedAt: string | null;
+    historyFetchedAt: string | null;
+  };
+  assets: CryptoMarketAsset[];
+  warnings: string[];
+}

package/src/api-client/data.ts

@@ -1,4 +1,14 @@
+import type { DebtMaturitiesPayload } from "./debt-maturities";
+import type { CryptoMarketsPayload } from "./crypto-markets";
+import type { CentralBankRatesPayload } from "./central-bank-rates";
+import type { EstimateRevisionsPayload } from "./estimate-revisions";
+import type { MoneyMarketsPayload } from "./money-markets";
+import type { ShortVolumePayload, ShortVolumeScope } from "./short-volume";
+import type { FuturesCurvePayload } from "./futures-curve";
+import type { CotBoardPayload, CotContractPayload, CotFamily, CotClass } from "./cot";
+import type { TapeSnapshot } from "./tape";
 import type { ExchangeRateSnapshot } from "../types/exchange-rate";
+import type { RatePathPayload } from "./rates";
 import type { TickerFinancials } from "../types/financials";
 import type { InstrumentSearchResult } from "../types/instrument";
 import {
@@ -102,6 +112,7 @@ import type {
   CloudTweetSearchResponse,
   CloudWorldVenueMapPayload,
   CloudYieldPointPayload,
+  ScannerFlowHistoryPage,
 } from "./types";
 
 type CloudApiRequest = <T>(path: string, options?: RequestInit) => Promise<T>;
@@ -130,6 +141,16 @@ export class CloudDataApi {
     });
   }
 
+  /** EQS endpoints live in the plugin client; one prefix-scoped method keeps the shared client small. */
+  equityScreener<T>(path: string, init?: RequestInit) {
+    return this.request<T>(`/cloud/equity-screener/${path}`, init);
+  }
+
+  /** Stored implied volatility (HIVG, VCA, OVDV dates); one prefix-scoped method, like EQS. */
+  impliedVolatility<T>(path: string, init?: RequestInit) {
+    return this.request<T>(`/cloud/iv/${path}`, init);
+  }
+
   async searchInstruments(
     query: string,
     limit = 10,
@@ -140,6 +161,10 @@ export class CloudDataApi {
     return response.data ?? [];
   }
 
+  async getCloudEstimateRevisions(symbol: string, exchange: string): Promise<EstimateRevisionsPayload> {
+    return this.request<EstimateRevisionsPayload>(`/cloud/research/estimates/${encodeURIComponent(symbol)}?exchange=${encodeURIComponent(exchange)}`, { signal: AbortSignal.timeout(45_000) });
+  }
+
   async getCloudQuote(
     symbol: string,
     exchange?: string,
@@ -328,19 +353,72 @@ export class CloudDataApi {
     return this.request<CloudShillerPayload>(cloudShillerPath());
   }
 
+  async getCloudCotBoard(report: CotFamily, traderClass: CotClass): Promise<CotBoardPayload> {
+    return this.request<CotBoardPayload>(`/cloud/cot/board?${new URLSearchParams({ report, traderClass })}`);
+  }
+
+  async getCloudCotContract(code: string, report: CotFamily): Promise<CotContractPayload> {
+    return this.request<CotContractPayload>(`/cloud/cot/contracts/${encodeURIComponent(code)}?${new URLSearchParams({ report })}`);
+  }
+
+  async getCloudTape(symbol: string, exchange: string, signal?: AbortSignal): Promise<TapeSnapshot> {
+    return this.request<TapeSnapshot>(`/cloud/tape/${encodeURIComponent(symbol)}?exchange=${encodeURIComponent(exchange)}`, { signal: signal ?? AbortSignal.timeout(30_000) });
+  }
+
   async getCloudYieldCurve(): Promise<CloudYieldPointPayload[]> {
     return this.request<CloudYieldPointPayload[]>("/cloud/econ/yield-curve");
   }
 
+  async getCloudCryptoMarkets(): Promise<CryptoMarketsPayload> {
+    return this.request<CryptoMarketsPayload>("/cloud/crypto/markets", { signal: AbortSignal.timeout(45_000) });
+  }
+
+  async getCloudCentralBankRates(): Promise<CentralBankRatesPayload> {
+    return this.request<CentralBankRatesPayload>("/cloud/econ/central-bank-rates", { signal: AbortSignal.timeout(45_000) });
+  }
+
+  /** Recorded FLOW prints older than the live tape (Pro); the plugin builds `search`. */
+  getScannerFlowHistory(search: string, signal?: AbortSignal) {
+    return this.request<ScannerFlowHistoryPage>(`/market/scanner/flow/history?${search}`, { signal });
+  }
+
+  getMobileAlertHistory<T>(offset = 0) {
+    return this.request<T>(`/mobile/alerts/history?offset=${offset}`);
+  }
+
+  async getCloudMoneyMarkets(): Promise<MoneyMarketsPayload> {
+    return this.request<MoneyMarketsPayload>("/cloud/econ/money-markets", { signal: AbortSignal.timeout(45_000) });
+  }
+
+  async getCloudDebtMaturities(symbol: string): Promise<DebtMaturitiesPayload> {
+    const params = new URLSearchParams({ symbol });
+    return this.request<DebtMaturitiesPayload>(`/cloud/debt-maturities?${params}`, { signal: AbortSignal.timeout(45_000) });
+  }
+
+  async getCloudShortVolume(symbol: string, scope: ShortVolumeScope = "nms"): Promise<ShortVolumePayload> {
+    const params = new URLSearchParams({ symbol, scope });
+    return this.request<ShortVolumePayload>(`/cloud/short-volume?${params}`, { signal: AbortSignal.timeout(20_000) });
+  }
+
+  async getCloudFuturesCurve(root: string): Promise<FuturesCurvePayload> {
+    return this.request<FuturesCurvePayload>(`/cloud/futures/curve/${encodeURIComponent(root)}`, { signal: AbortSignal.timeout(60_000) });
+  }
+
+  async getCloudRatePath(): Promise<RatePathPayload> {
+    return this.request<RatePathPayload>("/cloud/econ/rate-path", { signal: AbortSignal.timeout(45_000) });
+  }
+
   async getCloudCds(params: CloudCdsParams = {}): Promise<CloudCdsResponse> {
     return this.request<CloudCdsResponse>(cloudCdsPath(params));
   }
 
   async getCloudCongressHouse(
     params: CloudCongressHouseParams = {},
+    options?: { signal?: AbortSignal },
   ): Promise<CloudCongressHousePayload> {
     return this.request<CloudCongressHousePayload>(
       cloudCongressHousePath(params),
+      options,
     );
   }
 

package/src/api-client/debt-maturities.ts

@@ -0,0 +1,92 @@
+export interface DebtFact {
+  value: number;
+  tag: string;
+  unit: string;
+  start: string | null;
+  end: string;
+  accession: string;
+  filed: string;
+  form: string;
+}
+export interface DebtBorrowingCost {
+  value: number;
+  interest: DebtFact;
+  opening: DebtFact[];
+  closing: DebtFact[];
+  periodStart: string;
+  periodEnd: string;
+}
+export interface DebtPercentile {
+  value: number | null;
+  rank: number | null;
+  sampleCount: number;
+  minimumSamples: number;
+  windowStart: string;
+  windowEnd: string;
+  historyStart: string | null;
+  historyEnd: string | null;
+  min: number | null;
+  max: number | null;
+  mean: number | null;
+}
+export interface DebtMetric {
+  value: number | null;
+  unit: string;
+  asOf: string;
+  filed: string;
+  percentile: DebtPercentile;
+}
+export interface DebtHistoryPoint {
+  asOf: string;
+  filed: string;
+  accession: string;
+  currency: string;
+  complete: boolean;
+  totalPrincipal: number | null;
+  next12Months: number | null;
+  next12MonthsShare: number | null;
+  next3Years: number | null;
+  next3YearsShare: number | null;
+  interestExpense: number | null;
+  borrowingCostPercent: number | null;
+  interestExpenseTag: string | null;
+  borrowingCostDebtTags: string | null;
+}
+export interface DebtMaturitiesPayload {
+  version: 1;
+  symbol: string;
+  cik: string | null;
+  entityName: string | null;
+  taxonomy: "us-gaap" | null;
+  status: "available" | "partial" | "unavailable";
+  fetchedAt: string;
+  asOf: string | null;
+  source: { name: string; url: string; cadence: string };
+  latest: null | {
+    asOf: string;
+    filed: string;
+    accession: string;
+    form: string;
+    currency: string;
+    filingUrl: string;
+    complete: boolean;
+    buckets: Array<{
+      id: string;
+      label: string;
+      year: number | null;
+      value: number | null;
+      fact: DebtFact | null;
+    }>;
+    totalPrincipal: DebtMetric;
+    next12Months: DebtMetric;
+    next12MonthsShare: DebtMetric;
+    next3Years: DebtMetric;
+    next3YearsShare: DebtMetric;
+    interestExpense: DebtMetric;
+    borrowingCostPercent: DebtMetric;
+    interestExpenseFact: DebtFact | null;
+    borrowingCostEvidence: DebtBorrowingCost | null;
+  };
+  history: DebtHistoryPoint[];
+  warnings: string[];
+}

package/src/api-client/equity-screener.ts

@@ -0,0 +1,149 @@
+export const NUMERIC_FIELDS = [
+  "price",
+  "changePercent",
+  "volume",
+  "averageVolume20d",
+  "relativeVolume",
+  "marketCap",
+  "trailingPE",
+  "forwardPE",
+  "enterpriseToRevenue",
+  "dividendYieldPercent",
+  "revenueGrowthPercent",
+  "earningsGrowthPercent",
+  "grossMarginPercent",
+  "operatingMarginPercent",
+  "netMarginPercent",
+  "shortInterestShares",
+  "shortInterestChangePercent",
+  "daysToCover",
+  "insiderPurchases90d",
+  "insiderSales90d",
+  "institutionalHolders",
+  "institutionalNewHolders",
+  "institutionalExits",
+] as const;
+export const CATEGORY_FIELDS = [
+  "symbol",
+  "exchange",
+  "currency",
+  "sector",
+  "industry",
+] as const;
+export type NumericField = (typeof NUMERIC_FIELDS)[number];
+export type CategoryField = (typeof CATEGORY_FIELDS)[number];
+export type ScreenField = NumericField | CategoryField;
+export type ScreenOperator =
+  "gte" | "lte" | "gt" | "lt" | "eq" | "between" | "in" | "present" | "missing";
+export type ScreenCriterion =
+  | {
+      field: NumericField;
+      op: "gte" | "lte" | "gt" | "lt" | "eq";
+      value: number;
+    }
+  | { field: NumericField; op: "between"; value: [number, number] }
+  | { field: CategoryField; op: "in"; value: string[] }
+  | { field: ScreenField; op: "present" | "missing" };
+
+export interface ScreenDefinition {
+  version: 1;
+  criteria: ScreenCriterion[];
+  sort: { field: ScreenField; direction: "asc" | "desc" };
+  /** Native quote/market-cap currency. Null allows mixed currencies only for nonmonetary criteria/sorts. */
+  currency: string | null;
+}
+export interface ScreenQuery extends ScreenDefinition {
+  limit: number;
+  cursor: string | null;
+}
+export interface ScreenMetric {
+  value: number | null;
+  unit: string;
+  /** Source observation date or timestamp. Never filled from collection time. */
+  asOf: string | null;
+  /** Latest known public filing date where supplied by the source. */
+  availableAt: string | null;
+  observedAt: string | null;
+  source: string;
+  state: "available" | "partial" | "stale" | "unavailable";
+  scope: "reported" | "derived" | "observed-subset";
+  reason: string | null;
+  sourceUrl: string | null;
+  percentile: {
+    value: number | null;
+    sampleCount: number;
+    scope: "covered-universe";
+  };
+}
+export interface ScreenRow {
+  symbol: string;
+  exchange: string;
+  name: string | null;
+  currency: string | null;
+  sector: string | null;
+  industry: string | null;
+  metrics: Record<NumericField, ScreenMetric>;
+  warnings: string[];
+}
+export interface ScreenCoverage {
+  covered: number;
+  skipped: number;
+  knownByField: Record<NumericField, number>;
+  missingByField: Record<NumericField, number>;
+  partialByField: Record<NumericField, number>;
+  staleByField: Record<NumericField, number>;
+  currencies: string[];
+  sectors: string[];
+  exchanges: string[];
+}
+export interface ScreenSnapshot {
+  id: string;
+  assembledAt: string;
+  expiresAt: string;
+  sourceOldestAt: string | null;
+  sourceNewestAt: string | null;
+}
+export interface ScreenPayload {
+  version: 1;
+  status: "available" | "partial" | "unavailable";
+  snapshot: ScreenSnapshot | null;
+  definition: ScreenDefinition;
+  universe: ScreenCoverage & { matched: number };
+  rows: ScreenRow[];
+  nextCursor: string | null;
+  warnings: string[];
+}
+export interface SavedScreen {
+  id: string;
+  name: string;
+  definition: ScreenDefinition;
+  revision: number;
+  createdAt: string;
+  updatedAt: string;
+}
+export interface ScreenFieldDefinition {
+  id: ScreenField;
+  label: string;
+  kind: "number" | "category";
+  unit: string;
+  operators: ScreenOperator[];
+  description: string;
+}
+
+export interface ScreenFieldsResponse {
+  version: 1;
+  fields: ScreenFieldDefinition[];
+  limits: {
+    criteria: number;
+    pageSize: number;
+    exportRows: number;
+    savedScreens: number;
+  };
+  cadenceSeconds: number;
+}
+export interface ScreenExportResponse {
+  csv: string;
+  filename: string;
+  snapshotId: string;
+  rowCount: number;
+}