gloomberb 0.18.3 → 0.18.4

package/src/api-client/data.ts

@@ -1,9 +1,10 @@
 import type { AttentionPayload, AttentionWindow } from "./attention";
-import type { HiringBoard, HiringPayload } from "./hiring";
+import type { HiringBoard, HiringBuildingBoard, HiringBuildingFilter, HiringCompanyBuilding, HiringCompanyMoves, HiringCompanySignals, HiringMovesBoard, HiringMovesFilter, HiringPayload, HiringSignalGroup, HiringSignalsBoard, HiringSignalsFilter } from "./hiring";
 import type { AppAttentionFilter, AppAttentionPayload, AppRankPayload } from "./app-attention";
 import type { CatalystResponse, CatalystDetail, CatalystFilters, CatalystStatus, CatalystChanges } from "./catalysts";
 import type { KpisPayload, GuidancePayload, KpiQueryOptions } from "./company-kpis";
 import { companyDisclosurePath } from "./company-kpis";
+import { cloudExchangeAnnouncementsPath } from "./exchange-announcements";
 import type { PowerBoard, PowerDetail, PowerFilter, PowerHistory } from "./power";
 import type { PerpBoardPayload, PerpEquitiesPayload, PerpEquityListing, PerpHistoryPayload, PerpRankingsPayload, PerpBoardQuery, PerpHistoryQuery,
   PerpMarketPayload } from "./perps";
@@ -29,13 +30,16 @@ import type { IpoCalendarParams, IpoCalendarPayload } from "./ipo";
 import type { TickerChanges } from "../types/ticker-changes";
 import type { IssuerListings } from "../types/issuer-listings";
 import type { OrganizationTickersResponse } from "./organization-tickers";
-import type { CryptoMarketsPayload, StablecoinSupplyHistoryPayload, StablecoinSupplyPayload } from "./crypto-markets";
+import type { CryptoMarketsPayload, DefiTvlPayload, StablecoinSupplyHistoryPayload, StablecoinSupplyPayload } from "./crypto-markets";
+import type { CryptoEtfFlowAsset, CryptoEtfFlowsPayload } from "./crypto-etf-flows";
 import type { CentralBankRatesPayload } from "./central-bank-rates";
 import type { EstimateRevisionsPayload } from "./estimate-revisions";
 import type { MoneyMarketsPayload } from "./money-markets";
 import type { CloudCurveHistory, CloudCurveId, CloudCurveView, CloudWorldCurves } from "./yield-curves";
+import type { SwapCurvePayload, SwapTenor } from "./swap-curve";
 import type { CdxBoardPayload, CloudCreditBoardParams, SovrBoardPayload } from "./credit-boards";
 import type { ShortVolumePayload, ShortVolumeScope } from "./short-volume";
+import type { FailsToDeliverPayload, OtcVolumePayload } from "./short-side-publications";
 import type { BeneficialOwnersPayload, CloudBeneficialOwnersParams } from "./beneficial-owners";
 import type { CloudInsiderSignalsParams, InsiderSignalsPayload } from "./insider-signals";
 import type { SocialMentionDayPosts, SocialMentionsPayload, SocialMentionsRange } from "./social-mentions";
@@ -74,6 +78,7 @@ import {
   cloudEarningsTranscriptPath,
   cloudJobsMoversPath,
   cloudJobsPath,
+  cloudJobsPostingPath,
   cloudJobsPostingsPath,
   type CloudJobsPostingsParams,
   type IssuerListingParams,
@@ -130,6 +135,7 @@ import type {
   CloudEarningsCallAudioPayload,
   CloudEarningsTranscriptPayload,
   CloudJobsMoversPayload,
+  CloudJobsPostingDetail,
   CloudJobsPostingsPayload,
   CloudJobsResponse,
   CloudProxyStatementListPayload,
@@ -139,6 +145,7 @@ import type {
   CloudRiskReportPayload,
   CloudCorporateActionsPayload,
   CloudEconEventPayload,
+  CloudShortRatesPayload,
   CloudMacroReleaseDaysPayload,
   CloudEquityDiagnosticMode,
   CloudEquityDiagnosticResult,
@@ -234,9 +241,16 @@ export class CloudDataApi {
     return this.request<import("./members").FundMembersPayload>(`/cloud/members/${encodeURIComponent(fund)}`);
   }
 
+  /** A company's recent announcements on its exchange (ASX only); another exchange answers 404. */
+  getCloudExchangeAnnouncements(params: { symbol: string; exchange: string; limit?: number }) {
+    return this.request<import("./exchange-announcements").ExchangeAnnouncementsPayload>(
+      cloudExchangeAnnouncementsPath(params),
+    );
+  }
+
   /** A US-listed fund's fee, NAV, premium and net assets as its sponsor publishes them. */
-  getFundFacts(ticker: string) {
-    return this.request<import("./fund-facts").FundFactsPayload>(`/cloud/fund-facts/${encodeURIComponent(ticker)}`);
+  getFundFacts(ticker: string, options: { signal?: AbortSignal } = {}) {
+    return this.request<import("./fund-facts").FundFactsPayload>(`/cloud/fund-facts/${encodeURIComponent(ticker)}`, options.signal ? { signal: options.signal } : undefined);
   }
 
   getFundChanges(fund: string) {
@@ -546,6 +560,11 @@ export class CloudDataApi {
     return this.request<{ events: CloudEconEventPayload[]; storedFrom: string | null }>(`/cloud/econ/calendar/history?from=${encodeURIComponent(from)}`);
   }
 
+  /** Each currency's short rate and its day, for forwards implied by covered interest parity. */
+  async getCloudShortRates(): Promise<CloudShortRatesPayload> {
+    return this.request<CloudShortRatesPayload>("/cloud/econ/short-rates");
+  }
+
   async getCloudMacroReleaseDays(): Promise<CloudMacroReleaseDaysPayload> {
     return this.request<CloudMacroReleaseDaysPayload>("/cloud/econ/release-days");
   }
@@ -593,6 +612,34 @@ export class CloudDataApi {
     return this.request<HiringBoard | HiringPayload>(symbol ? `/cloud/hiring/${encodeURIComponent(symbol)}` : `/cloud/hiring?${params}`, { signal });
   }
 
+  /** HIRE's moves: the board of the latest computed week, or one company's weeks. */
+  async getCloudHiringMoves(symbol?: string, query: { limit?: number; offset?: number; signal?: HiringMovesFilter } = {}, signal?: AbortSignal): Promise<HiringMovesBoard | HiringCompanyMoves> {
+    const params = new URLSearchParams({ limit: String(query.limit ?? 100), offset: String(query.offset ?? 0), signal: query.signal ?? "moves" });
+    return this.request<HiringMovesBoard | HiringCompanyMoves>(symbol ? `/cloud/hiring/moves/${encodeURIComponent(symbol)}` : `/cloud/hiring/moves?${params}`, { signal });
+  }
+
+  /** HIRE's Expansion or Anomalies board of the latest computed week. */
+  async getCloudHiringSignals(group: HiringSignalGroup, query: { limit?: number; offset?: number; kind?: HiringSignalsFilter } = {}, signal?: AbortSignal): Promise<HiringSignalsBoard> {
+    const params = new URLSearchParams({ limit: String(query.limit ?? 100), offset: String(query.offset ?? 0), kind: query.kind ?? "all" });
+    return this.request<HiringSignalsBoard>(`/cloud/hiring/signals/${group}?${params}`, { signal });
+  }
+
+  /** One company's expansion and anomaly signals, both groups. */
+  async getCloudHiringCompanySignals(symbol: string, signal?: AbortSignal): Promise<HiringCompanySignals> {
+    return this.request<HiringCompanySignals>(`/cloud/hiring/signals/company/${encodeURIComponent(symbol)}`, { signal });
+  }
+
+  /** HIRE's Building board: role-family and theme shifts of the latest computed week. */
+  async getCloudHiringBuilding(query: { limit?: number; offset?: number; dimension?: HiringBuildingFilter } = {}, signal?: AbortSignal): Promise<HiringBuildingBoard> {
+    const params = new URLSearchParams({ limit: String(query.limit ?? 100), offset: String(query.offset ?? 0), dimension: query.dimension ?? "all" });
+    return this.request<HiringBuildingBoard>(`/cloud/hiring/building?${params}`, { signal });
+  }
+
+  /** One company's mix by role family and theme, and its shifts. */
+  async getCloudHiringCompanyBuilding(symbol: string, signal?: AbortSignal): Promise<HiringCompanyBuilding> {
+    return this.request<HiringCompanyBuilding>(`/cloud/hiring/building/${encodeURIComponent(symbol)}`, { signal });
+  }
+
   async getCloudAppRankHistory(store: "app-store" | "google-play", appId: string, query: AppAttentionFilter = {}, signal?: AbortSignal): Promise<AppRankPayload> {
     const params = new URLSearchParams(Object.entries(query).filter(([, value]) => value !== undefined).map(([key, value]) => [key, String(value)]));
     return this.request<AppRankPayload>(`/cloud/app-attention/app/${store}/${encodeURIComponent(appId)}?${params}`, { signal });
@@ -790,6 +837,12 @@ export class CloudDataApi {
     return this.request<CloudYieldPointPayload[]>("/cloud/econ/yield-curve");
   }
 
+  /** Daily USD SOFR swap estimates, comparisons and the selected tenor's history. */
+  async getCloudSwapCurve(tenor: SwapTenor = "10Y", days = 365): Promise<SwapCurvePayload> {
+    const query = new URLSearchParams({ tenor, days: String(days) });
+    return this.request<SwapCurvePayload>(`/cloud/econ/swap-curve?${query}`, { signal: AbortSignal.timeout(30_000) });
+  }
+
   /** A curve's session on or before `date` (latest without one), with look-backs and spreads. */
   async getCloudCurve(curve: CloudCurveId, date?: string | null): Promise<CloudCurveView> {
     const query = date ? `?${new URLSearchParams({ date })}` : "";
@@ -827,6 +880,19 @@ export class CloudDataApi {
     );
   }
 
+  /** Total DeFi TVL, the largest protocols and chains with 7D and 30D changes, and the total's daily history. */
+  async getCloudDefiTvl(): Promise<DefiTvlPayload> {
+    return this.request<DefiTvlPayload>("/cloud/crypto/defi/tvl", { signal: AbortSignal.timeout(30_000) });
+  }
+
+  /** Daily net flows of the US spot bitcoin or ether ETFs, per fund, in US$ millions. */
+  async getCloudCryptoEtfFlows(asset: CryptoEtfFlowAsset): Promise<CryptoEtfFlowsPayload> {
+    return this.request<CryptoEtfFlowsPayload>(
+      `/cloud/crypto/etf-flows?asset=${asset.toLowerCase()}`,
+      { signal: AbortSignal.timeout(30_000) },
+    );
+  }
+
   async getCloudCentralBankRates(): Promise<CentralBankRatesPayload> {
     return this.request<CentralBankRatesPayload>("/cloud/econ/central-bank-rates", { signal: AbortSignal.timeout(45_000) });
   }
@@ -904,6 +970,14 @@ export class CloudDataApi {
     return this.request<IpoCalendarPayload>(`/cloud/ipo/calendar${suffix}`, { signal: signalWithTimeout(options?.signal, 30_000) });
   }
 
+  async getCloudFailsToDeliver(symbol: string): Promise<FailsToDeliverPayload> {
+    return this.request<FailsToDeliverPayload>(`/cloud/fails-to-deliver?${new URLSearchParams({ symbol })}`, { signal: AbortSignal.timeout(20_000) });
+  }
+
+  async getCloudOtcVolume(symbol: string): Promise<OtcVolumePayload> {
+    return this.request<OtcVolumePayload>(`/cloud/otc-volume?${new URLSearchParams({ symbol })}`, { signal: AbortSignal.timeout(20_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) });
@@ -979,6 +1053,10 @@ export class CloudDataApi {
     return this.request<CloudJobsPostingsPayload>(cloudJobsPostingsPath(ticker, params));
   }
 
+  async getCloudJobsPosting(ticker: string, posting: { id: number } | { externalId: string }): Promise<CloudJobsPostingDetail> {
+    return this.request<CloudJobsPostingDetail>(cloudJobsPostingPath(ticker, posting));
+  }
+
   async getCloudJobsMovers(limit?: number, offset?: number): Promise<CloudJobsMoversPayload> {
     return this.request<CloudJobsMoversPayload>(cloudJobsMoversPath(limit, offset));
   }
@@ -1180,8 +1258,9 @@ export class CloudDataApi {
   async searchCloudNews(
     query: string,
     limit?: number,
+    topics?: readonly string[],
   ): Promise<CloudNewsListResponse> {
-    return this.request<CloudNewsListResponse>(cloudNewsSearchPath(query, limit));
+    return this.request<CloudNewsListResponse>(cloudNewsSearchPath(query, limit, topics));
   }
 
   async getCloudNewsStory(storyId: string): Promise<CloudNewsPayload> {

package/src/api-client/doe.ts

@@ -37,6 +37,8 @@ interface DoeSeasonal {
   band: Array<[number, number | null, number | null, number | null]>;
 }
 
+type DoeComparisonBasis = "published" | "computed";
+
 export interface DoeSeriesRow {
   id: string;
   key: string;
@@ -50,6 +52,12 @@ export interface DoeSeriesRow {
   weekChange: number | null;
   yearAgo: DoeYearAgo | null;
   fiveYear: DoeFiveYear | null;
+  /**
+   * Where the year-ago and five-year average comparisons come from: the
+   * EIA's own published figures for the week (gas storage), or worked out
+   * from the stored weekly history. Absent from older servers.
+   */
+  basis?: DoeComparisonBasis;
   /** One plain read worked out from the numbers. */
   read: string | null;
   seasonal: DoeSeasonal | null;
@@ -63,6 +71,13 @@ export interface DoeReportStatus {
   nextWeekEnding: string | null;
   nextReleaseAt: string | null;
   nextReleaseHoliday: string | null;
+  /**
+   * The economic calendar's consensus and prior for the next release, in the
+   * report's unit (Bcf of net change for gas storage); null when the calendar
+   * has none. Absent from older servers.
+   */
+  nextConsensus?: number | null;
+  nextPrior?: number | null;
 }
 
 export interface DoeBoardPayload {

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

@@ -112,6 +112,11 @@ export interface ScreenMetric {
   sourceUrl: string | null;
   /** Set by the client on a Pro field the server left out for a caller without Gloom Pro; never sent. */
   access?: "pro";
+  /**
+   * Set on a multiple that is not meaningful (a P/E over a loss, an EV/revenue or EV/EBITDA over an EV or EBITDA at
+   * or below zero): `value` is null, `reason` says why, and it shows as N/M.
+   */
+  notMeaningful?: true;
   percentile: {
     value: number | null;
     sampleCount: number;
@@ -156,6 +161,29 @@ export interface ScreenPayload {
   nextCursor: string | null;
   warnings: string[];
 }
+interface ScreenCriterionCheck {
+  criterion: ScreenCriterion;
+  /** The screen's currency restriction, which also controls membership. */
+  implicit: boolean;
+  value: number | string | null;
+  passes: boolean | null;
+  state: "available" | "partial" | "stale" | "unavailable" | "missing" | "not-covered";
+  unit: string;
+  asOf: string | null;
+  observedAt: string | null;
+  reason: string | null;
+}
+export interface ScreenCheckPayload {
+  version: 1;
+  status: "available" | "partial" | "not-covered";
+  symbol: string;
+  definition: ScreenDefinition;
+  snapshot: ScreenSnapshot;
+  matches: boolean | null;
+  row: Pick<ScreenRow, "symbol" | "exchange" | "name" | "currency" | "sector" | "industry"> | null;
+  criteria: ScreenCriterionCheck[];
+  warnings: string[];
+}
 export interface SavedScreen {
   id: string;
   name: string;

package/src/api-client/exchange-announcements.ts

@@ -0,0 +1,38 @@
+/** One company announcement as its exchange released it (ASX). */
+interface ExchangeAnnouncement {
+  /** Release time, ISO 8601 UTC. */
+  date: string;
+  headline: string;
+  /** The exchange's announcement types ("Quarterly Activities Report"). */
+  types: string[];
+  priceSensitive: boolean;
+  /** "354KB", as the exchange states it; null when it does not. */
+  fileSize: string | null;
+  documentKey: string;
+  /** The document on the exchange's site. */
+  url: string;
+}
+
+/** A listed company's recent exchange announcements, from Gloom Cloud's `/cloud/announcements` (ASX only). */
+export interface ExchangeAnnouncementsPayload {
+  exchange: string;
+  symbol: string;
+  /** The company as the exchange names it; null when it does not say. */
+  name: string | null;
+  /** The company's announcements page on the exchange's site. */
+  page: string;
+  announcements: ExchangeAnnouncement[];
+  /** How many announcements the exchange holds for the company; null when it does not say. */
+  total: number | null;
+  /** When Gloom Cloud read the list from the exchange. */
+  retrievedAt: string;
+  /** An earlier read, served because the exchange could not be reached. */
+  stale?: boolean;
+}
+
+/** `/cloud/announcements?symbol=NST&exchange=ASX&limit=15`. */
+export function cloudExchangeAnnouncementsPath(params: { symbol: string; exchange: string; limit?: number }): string {
+  const search = new URLSearchParams({ symbol: params.symbol, exchange: params.exchange });
+  if (params.limit != null) search.set("limit", String(params.limit));
+  return `/cloud/announcements?${search}`;
+}

package/src/api-client/fund-facts.ts

@@ -32,6 +32,41 @@ export interface FundBondFacts {
   duration: (FundFact<number> & { measure: "effective" | "average" }) | null;
 }
 
+/**
+ * A leveraged or inverse fund's objective as its sponsor states it: `value`
+ * times its benchmark's return over each `reset` period (3 for TQQQ, -3 for
+ * SQQQ, 1.5 for UVXY), dated by the sponsor page or list it was read from.
+ * `proxy`: what tracks the benchmark one for one (QQQ for the Nasdaq-100, the
+ * share a single-stock fund multiplies), which CMP draws the objective from;
+ * null when nothing does.
+ */
+export interface FundLeverage extends FundFact<number> {
+  reset: "daily" | "monthly";
+  benchmark: string | null;
+  proxy: { ticker: string; basis: "index-fund" | "underlying" } | null;
+}
+
+/**
+ * A gold or silver trust's metal in trust (GLD, GLDM, IAU, IAUM, SLV), as its
+ * sponsor publishes it each business day: troy ounces, the sponsor's own
+ * tonnes, and the change on the stored day before (`since`). `change` is null
+ * until two days are stored: iShares publishes no history of its ounces, so
+ * IAU, IAUM and SLV have days from October 2026 only.
+ */
+export interface FundMetalHoldings {
+  metal: "gold" | "silver";
+  asOf: string;
+  ounces: number;
+  tonnes: number | null;
+  change: { since: string; ounces: number; tonnes: number | null } | null;
+  /** The sponsor and the fund page that shows the figures. */
+  source: { publisher: string; page: string };
+  /** The last read of the sponsor's file that succeeded. */
+  fetchedAt: string;
+  /** The newest day is more than five days old. */
+  stale: boolean;
+}
+
 /**
  * `not-collected-yet`: a source Gloom reads covers the fund, but it has no
  * figures yet. `not-published`: no source Gloom reads covers it. Servers
@@ -63,9 +98,13 @@ export interface FundFactsPayload {
   netAssets: (FundFact<number> & { scope: "share-class" | "fund" | null; period?: "day" | "month-end"; document?: "N-PORT" }) | null;
   sponsor: FundFact<string> | null;
   inception: FundFact<string> | null;
+  /** A leveraged or inverse fund's objective; null for any other fund. Servers before it leave it out. */
+  leverage?: FundLeverage | null;
   index: FundFact<string> | null;
   /** A bond fund's SEC yield, yield to worst and duration; null for any other fund. Servers before it leave it out. */
   bond?: FundBondFacts | null;
+  /** A metal trust's metal in trust; absent for any other fund, until its first read, and from servers before it. */
+  metalHoldings?: FundMetalHoldings | null;
   /** The newest NAV is older than a few US trading days: every figure is older than it looks. */
   stale: boolean;
   fetchedAt: string | null;

package/src/api-client/futures-curve.ts

@@ -133,7 +133,15 @@ export interface FuturesCurvePayload {
     historyStart: string | null
     historyEnd: string | null
     asOf: string | null
-    state: "contango" | "backwardation" | "flat" | "unavailable"
+    /**
+     * What the spread subtracts: two last trades made at the same time
+     * ("last"), or both contracts' settlements for the session in `asOf`
+     * ("settle"). Absent from a server that does not say.
+     */
+    basis?: "last" | "settle" | null
+    /** The leg that makes the spread thin (state "thin"): too few lots this session, or no trade in it. */
+    thinSymbol?: string | null
+    state: "contango" | "backwardation" | "flat" | "thin" | "unavailable"
   }
   gaps: string[]
   /** The session the contracts' settlements are for; null when none is confirmed. */