reportify-sdk 0.3.21 → 0.3.22

package/dist/index.d.mts

@@ -1811,6 +1811,62 @@ declare class FollowingModule {
     }>;
 }
 
+/**
+ * Macro Module
+ *
+ * Provides access to macroeconomic data including commodity prices.
+ */
+
+type CommodityType = 'oil' | 'gold' | 'gas' | 'silver' | 'platinum';
+interface CommodityData {
+    date: string;
+    /** WTI crude oil spot price (USD/barrel) - type=oil */
+    wti_co_sp?: number;
+    /** Brent crude oil spot price (USD/barrel) - type=oil */
+    brent_co_sp?: number;
+    /** Shanghai gold price (CNY) - type=gold */
+    sge_pm_cny?: number;
+    /** London gold LBMA PM price (USD/oz) - type=gold */
+    lbma_pm_usd?: number;
+    /** Henry Hub natural gas spot price (USD/MMBtu) - type=gas */
+    hh_ng_sp?: number;
+    /** London silver price (USD/oz) - type=silver */
+    si_eur?: number;
+    /** London platinum price (USD/oz) - type=platinum */
+    pl_usd?: number;
+}
+declare class MacroModule {
+    private client;
+    constructor(client: Reportify);
+    /**
+     * Get commodity price data
+     *
+     * @param type - Commodity type: oil, gold, gas, silver, or platinum
+     * @param options.startDate - Start date (YYYY-MM-DD)
+     * @param options.endDate - End date (YYYY-MM-DD)
+     *
+     * @example
+     * ```typescript
+     * // Get oil prices
+     * const oil = await client.macro.commodities('oil', {
+     *   startDate: '2026-02-01',
+     *   endDate: '2026-02-09',
+     * });
+     * console.log(oil); // [{ date: '...', wti_co_sp: 63.77, brent_co_sp: 70.45 }, ...]
+     *
+     * // Get gold prices
+     * const gold = await client.macro.commodities('gold', {
+     *   startDate: '2026-02-01',
+     *   endDate: '2026-02-09',
+     * });
+     * ```
+     */
+    commodities(type: CommodityType, options: {
+        startDate: string;
+        endDate: string;
+    }): Promise<CommodityData[]>;
+}
+
 /**
  * Reportify Client
  *
@@ -1847,6 +1903,7 @@ declare class Reportify {
     readonly timeline: TimelineModule;
     readonly user: UserModule;
     readonly following: FollowingModule;
+    readonly macro: MacroModule;
     constructor(config: ReportifyConfig);
     /**
      * Make an HTTP request to the API
@@ -1877,4 +1934,4 @@ declare class Reportify {
     getBytes(path: string): Promise<ArrayBuffer>;
 }
 
-export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchKline1mParams, type BatchMinuteParams, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, FollowingModule, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Kline1mParams, type Market, type MinuteParams, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
+export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchKline1mParams, type BatchMinuteParams, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CommodityData, type CommodityType, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, FollowingModule, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Kline1mParams, MacroModule, type Market, type MinuteParams, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };

package/dist/index.d.ts

@@ -1811,6 +1811,62 @@ declare class FollowingModule {
     }>;
 }
 
+/**
+ * Macro Module
+ *
+ * Provides access to macroeconomic data including commodity prices.
+ */
+
+type CommodityType = 'oil' | 'gold' | 'gas' | 'silver' | 'platinum';
+interface CommodityData {
+    date: string;
+    /** WTI crude oil spot price (USD/barrel) - type=oil */
+    wti_co_sp?: number;
+    /** Brent crude oil spot price (USD/barrel) - type=oil */
+    brent_co_sp?: number;
+    /** Shanghai gold price (CNY) - type=gold */
+    sge_pm_cny?: number;
+    /** London gold LBMA PM price (USD/oz) - type=gold */
+    lbma_pm_usd?: number;
+    /** Henry Hub natural gas spot price (USD/MMBtu) - type=gas */
+    hh_ng_sp?: number;
+    /** London silver price (USD/oz) - type=silver */
+    si_eur?: number;
+    /** London platinum price (USD/oz) - type=platinum */
+    pl_usd?: number;
+}
+declare class MacroModule {
+    private client;
+    constructor(client: Reportify);
+    /**
+     * Get commodity price data
+     *
+     * @param type - Commodity type: oil, gold, gas, silver, or platinum
+     * @param options.startDate - Start date (YYYY-MM-DD)
+     * @param options.endDate - End date (YYYY-MM-DD)
+     *
+     * @example
+     * ```typescript
+     * // Get oil prices
+     * const oil = await client.macro.commodities('oil', {
+     *   startDate: '2026-02-01',
+     *   endDate: '2026-02-09',
+     * });
+     * console.log(oil); // [{ date: '...', wti_co_sp: 63.77, brent_co_sp: 70.45 }, ...]
+     *
+     * // Get gold prices
+     * const gold = await client.macro.commodities('gold', {
+     *   startDate: '2026-02-01',
+     *   endDate: '2026-02-09',
+     * });
+     * ```
+     */
+    commodities(type: CommodityType, options: {
+        startDate: string;
+        endDate: string;
+    }): Promise<CommodityData[]>;
+}
+
 /**
  * Reportify Client
  *
@@ -1847,6 +1903,7 @@ declare class Reportify {
     readonly timeline: TimelineModule;
     readonly user: UserModule;
     readonly following: FollowingModule;
+    readonly macro: MacroModule;
     constructor(config: ReportifyConfig);
     /**
      * Make an HTTP request to the API
@@ -1877,4 +1934,4 @@ declare class Reportify {
     getBytes(path: string): Promise<ArrayBuffer>;
 }
 
-export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchKline1mParams, type BatchMinuteParams, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, FollowingModule, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Kline1mParams, type Market, type MinuteParams, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };
+export { APIError, type AgentConversation, type AgentMessage, AgentModule, AuthenticationError, type BacktestParams, type BacktestResult, type BatchKline1mParams, type BatchMinuteParams, type BatchOHLCVParams, type Calendar, type Channel, ChannelsModule, type ChatCompletionOptions, type ChatCompletionResponse, type ChatMode, ChatModule, type Chunk, type ChunkSearchOptions, type CommodityData, type CommodityType, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, type DocsListOptions, DocsModule, type Document, type DocumentInput, type EarningsEvent, type EarningsSearchOptions, type FactorComputeParams, type FactorMeta, type FinancialStatement, type FollowedCompany, FollowingModule, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, KBModule, type KBSearchOptions, type Kline1mParams, MacroModule, type Market, type MinuteParams, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, SearchModule, type SearchOptions, type Shareholder, type ShareholderType, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions, type UploadDocRequest, UserModule };

package/dist/index.js

@@ -29,6 +29,7 @@ __export(index_exports, {
   DocsModule: () => DocsModule,
   FollowingModule: () => FollowingModule,
   KBModule: () => KBModule,
+  MacroModule: () => MacroModule,
   NotFoundError: () => NotFoundError,
   QuantModule: () => QuantModule,
   RateLimitError: () => RateLimitError,
@@ -1940,6 +1941,51 @@ var FollowingModule = class {
   }
 };
 
+// src/macro.ts
+var MacroModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get commodity price data
+   *
+   * @param type - Commodity type: oil, gold, gas, silver, or platinum
+   * @param options.startDate - Start date (YYYY-MM-DD)
+   * @param options.endDate - End date (YYYY-MM-DD)
+   *
+   * @example
+   * ```typescript
+   * // Get oil prices
+   * const oil = await client.macro.commodities('oil', {
+   *   startDate: '2026-02-01',
+   *   endDate: '2026-02-09',
+   * });
+   * console.log(oil); // [{ date: '...', wti_co_sp: 63.77, brent_co_sp: 70.45 }, ...]
+   *
+   * // Get gold prices
+   * const gold = await client.macro.commodities('gold', {
+   *   startDate: '2026-02-01',
+   *   endDate: '2026-02-09',
+   * });
+   * ```
+   */
+  async commodities(type, options) {
+    const body = {
+      type,
+      start_date: options.startDate,
+      end_date: options.endDate
+    };
+    const response = await this.client.post("/v1/stock/macro-commodities", body);
+    if (Array.isArray(response)) {
+      return response;
+    }
+    if ("data" in response && response.data && "items" in response.data) {
+      return response.data.items;
+    }
+    return [];
+  }
+};
+
 // src/types.ts
 var ReportifyError = class extends Error {
   statusCode;
@@ -1994,6 +2040,7 @@ var Reportify = class {
   timeline;
   user;
   following;
+  macro;
   constructor(config) {
     if (!config.apiKey) {
       throw new AuthenticationError("API key is required");
@@ -2013,6 +2060,7 @@ var Reportify = class {
     this.timeline = new TimelineModule(this);
     this.user = new UserModule(this);
     this.following = new FollowingModule(this);
+    this.macro = new MacroModule(this);
   }
   /**
    * Make an HTTP request to the API
@@ -2129,6 +2177,7 @@ var Reportify = class {
   DocsModule,
   FollowingModule,
   KBModule,
+  MacroModule,
   NotFoundError,
   QuantModule,
   RateLimitError,

package/dist/index.mjs

@@ -1897,6 +1897,51 @@ var FollowingModule = class {
   }
 };
 
+// src/macro.ts
+var MacroModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get commodity price data
+   *
+   * @param type - Commodity type: oil, gold, gas, silver, or platinum
+   * @param options.startDate - Start date (YYYY-MM-DD)
+   * @param options.endDate - End date (YYYY-MM-DD)
+   *
+   * @example
+   * ```typescript
+   * // Get oil prices
+   * const oil = await client.macro.commodities('oil', {
+   *   startDate: '2026-02-01',
+   *   endDate: '2026-02-09',
+   * });
+   * console.log(oil); // [{ date: '...', wti_co_sp: 63.77, brent_co_sp: 70.45 }, ...]
+   *
+   * // Get gold prices
+   * const gold = await client.macro.commodities('gold', {
+   *   startDate: '2026-02-01',
+   *   endDate: '2026-02-09',
+   * });
+   * ```
+   */
+  async commodities(type, options) {
+    const body = {
+      type,
+      start_date: options.startDate,
+      end_date: options.endDate
+    };
+    const response = await this.client.post("/v1/stock/macro-commodities", body);
+    if (Array.isArray(response)) {
+      return response;
+    }
+    if ("data" in response && response.data && "items" in response.data) {
+      return response.data.items;
+    }
+    return [];
+  }
+};
+
 // src/types.ts
 var ReportifyError = class extends Error {
   statusCode;
@@ -1951,6 +1996,7 @@ var Reportify = class {
   timeline;
   user;
   following;
+  macro;
   constructor(config) {
     if (!config.apiKey) {
       throw new AuthenticationError("API key is required");
@@ -1970,6 +2016,7 @@ var Reportify = class {
     this.timeline = new TimelineModule(this);
     this.user = new UserModule(this);
     this.following = new FollowingModule(this);
+    this.macro = new MacroModule(this);
   }
   /**
    * Make an HTTP request to the API
@@ -2085,6 +2132,7 @@ export {
   DocsModule,
   FollowingModule,
   KBModule,
+  MacroModule,
   NotFoundError,
   QuantModule,
   RateLimitError,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "reportify-sdk",
-  "version": "0.3.21",
+  "version": "0.3.22",
   "description": "TypeScript SDK for Reportify API - Financial data and document search",
   "main": "dist/index.js",
   "module": "dist/index.mjs",