reportify-sdk 0.2.4 → 0.2.5

package/dist/index.d.mts

@@ -117,7 +117,7 @@ type Market = 'us' | 'hk' | 'cn';
 type IPOStatus = 'Filing' | 'Hearing' | 'Priced';
 interface IndustryConstituent {
     symbol: string;
-    area: string;
+    market: string;
     name: string;
     type_name?: string;
     industry_one_level_name?: string;
@@ -125,6 +125,17 @@ interface IndustryConstituent {
     industry_third_level_name?: string;
     [key: string]: unknown;
 }
+interface IndexConstituent {
+    market: string;
+    symbol: string;
+    [key: string]: unknown;
+}
+interface IndexFund {
+    short_name: string;
+    name: string;
+    symbol: string;
+    [key: string]: unknown;
+}
 interface TimelineOptions {
     num?: number;
 }
@@ -292,14 +303,46 @@ declare class StockModule {
      * @example
      * ```typescript
      * // Get CN defense industry stocks
-     * const stocks = await client.stock.industryConstituent('cn', '军工');
+     * const stocks = await client.stock.industryConstituents('cn', '军工');
      * console.log(stocks);
      *
      * // Get US technology stocks
-     * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+     * const techStocks = await client.stock.industryConstituents('us', 'Technology');
+     * ```
+     */
+    industryConstituents(market: Market, name: string, type?: string): Promise<IndustryConstituent[]>;
+    /**
+     * Get constituent stocks of an index
+     *
+     * @param symbol - Index symbol
+     *
+     * @example
+     * ```typescript
+     * // Get CSI 300 constituent stocks
+     * const stocks = await client.stock.indexConstituents('000300');
+     * console.log(stocks);
+     *
+     * // Get ChiNext constituent stocks
+     * const stocks = await client.stock.indexConstituents('399006');
+     * ```
+     */
+    indexConstituents(symbol: string): Promise<IndexConstituent[]>;
+    /**
+     * Get tracking funds of an index
+     *
+     * @param symbol - Index symbol
+     *
+     * @example
+     * ```typescript
+     * // Get CSI 300 tracking funds
+     * const funds = await client.stock.indexFunds('000300');
+     * console.log(funds);
+     *
+     * // Get SSE 50 tracking funds
+     * const funds = await client.stock.indexFunds('000016');
      * ```
      */
-    industryConstituent(market: Market, name: string, type?: string): Promise<IndustryConstituent[]>;
+    indexFunds(symbol: string): Promise<IndexFund[]>;
     private normalizeArrayResponse;
 }
 
@@ -827,4 +870,4 @@ declare class Reportify {
     searchTranscripts(query: string, options?: SearchOptions): Promise<Document[]>;
 }
 
-export { APIError, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Chunk, type CompanyInfo, type CompanyOverview, DocsModule, type Document, type EarningsEvent, type FactorComputeParams, type FactorMeta, type FinancialStatement, type IPOEvent, type IPOStatus, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, type Interval, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceAdjust, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, type SearchOptions, type Shareholder, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions };
+export { APIError, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Chunk, type CompanyInfo, type CompanyOverview, DocsModule, type Document, type EarningsEvent, type FactorComputeParams, type FactorMeta, type FinancialStatement, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, type Interval, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceAdjust, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, type SearchOptions, type Shareholder, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions };

package/dist/index.d.ts

@@ -117,7 +117,7 @@ type Market = 'us' | 'hk' | 'cn';
 type IPOStatus = 'Filing' | 'Hearing' | 'Priced';
 interface IndustryConstituent {
     symbol: string;
-    area: string;
+    market: string;
     name: string;
     type_name?: string;
     industry_one_level_name?: string;
@@ -125,6 +125,17 @@ interface IndustryConstituent {
     industry_third_level_name?: string;
     [key: string]: unknown;
 }
+interface IndexConstituent {
+    market: string;
+    symbol: string;
+    [key: string]: unknown;
+}
+interface IndexFund {
+    short_name: string;
+    name: string;
+    symbol: string;
+    [key: string]: unknown;
+}
 interface TimelineOptions {
     num?: number;
 }
@@ -292,14 +303,46 @@ declare class StockModule {
      * @example
      * ```typescript
      * // Get CN defense industry stocks
-     * const stocks = await client.stock.industryConstituent('cn', '军工');
+     * const stocks = await client.stock.industryConstituents('cn', '军工');
      * console.log(stocks);
      *
      * // Get US technology stocks
-     * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+     * const techStocks = await client.stock.industryConstituents('us', 'Technology');
+     * ```
+     */
+    industryConstituents(market: Market, name: string, type?: string): Promise<IndustryConstituent[]>;
+    /**
+     * Get constituent stocks of an index
+     *
+     * @param symbol - Index symbol
+     *
+     * @example
+     * ```typescript
+     * // Get CSI 300 constituent stocks
+     * const stocks = await client.stock.indexConstituents('000300');
+     * console.log(stocks);
+     *
+     * // Get ChiNext constituent stocks
+     * const stocks = await client.stock.indexConstituents('399006');
+     * ```
+     */
+    indexConstituents(symbol: string): Promise<IndexConstituent[]>;
+    /**
+     * Get tracking funds of an index
+     *
+     * @param symbol - Index symbol
+     *
+     * @example
+     * ```typescript
+     * // Get CSI 300 tracking funds
+     * const funds = await client.stock.indexFunds('000300');
+     * console.log(funds);
+     *
+     * // Get SSE 50 tracking funds
+     * const funds = await client.stock.indexFunds('000016');
      * ```
      */
-    industryConstituent(market: Market, name: string, type?: string): Promise<IndustryConstituent[]>;
+    indexFunds(symbol: string): Promise<IndexFund[]>;
     private normalizeArrayResponse;
 }
 
@@ -827,4 +870,4 @@ declare class Reportify {
     searchTranscripts(query: string, options?: SearchOptions): Promise<Document[]>;
 }
 
-export { APIError, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Chunk, type CompanyInfo, type CompanyOverview, DocsModule, type Document, type EarningsEvent, type FactorComputeParams, type FactorMeta, type FinancialStatement, type IPOEvent, type IPOStatus, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, type Interval, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceAdjust, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, type SearchOptions, type Shareholder, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions };
+export { APIError, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Chunk, type CompanyInfo, type CompanyOverview, DocsModule, type Document, type EarningsEvent, type FactorComputeParams, type FactorMeta, type FinancialStatement, type IPOEvent, type IPOStatus, type IndexConstituent, type IndexFund, type IndicatorComputeParams, type IndicatorData, type IndicatorMeta, type IndustryConstituent, type Interval, KBModule, type KBSearchOptions, type Market, NotFoundError, type OHLCVData, type OHLCVParams, type PaginatedResponse, type Period, type PriceAdjust, type PriceData, QuantModule, type Quote, RateLimitError, Reportify, type ReportifyConfig, ReportifyError, type ScreenParams, type ScreenedStock, type SearchOptions, type Shareholder, type StockInfo, type StockMarket, StockModule, TimelineModule, type TimelineOptions };

package/dist/index.js

@@ -265,19 +265,57 @@ var StockModule = class {
    * @example
    * ```typescript
    * // Get CN defense industry stocks
-   * const stocks = await client.stock.industryConstituent('cn', '军工');
+   * const stocks = await client.stock.industryConstituents('cn', '军工');
    * console.log(stocks);
    *
    * // Get US technology stocks
-   * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+   * const techStocks = await client.stock.industryConstituents('us', 'Technology');
    * ```
    */
-  async industryConstituent(market, name, type) {
+  async industryConstituents(market, name, type) {
     const body = { market, name };
     if (type) {
       body.type = type;
     }
-    const response = await this.client.post("/v1/stock/industry-constituent", body);
+    const response = await this.client.post("/v1/stock/industry-constituents", body);
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get constituent stocks of an index
+   *
+   * @param symbol - Index symbol
+   *
+   * @example
+   * ```typescript
+   * // Get CSI 300 constituent stocks
+   * const stocks = await client.stock.indexConstituents('000300');
+   * console.log(stocks);
+   *
+   * // Get ChiNext constituent stocks
+   * const stocks = await client.stock.indexConstituents('399006');
+   * ```
+   */
+  async indexConstituents(symbol) {
+    const response = await this.client.post("/v1/stock/index-constituents", { symbol });
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get tracking funds of an index
+   *
+   * @param symbol - Index symbol
+   *
+   * @example
+   * ```typescript
+   * // Get CSI 300 tracking funds
+   * const funds = await client.stock.indexFunds('000300');
+   * console.log(funds);
+   *
+   * // Get SSE 50 tracking funds
+   * const funds = await client.stock.indexFunds('000016');
+   * ```
+   */
+  async indexFunds(symbol) {
+    const response = await this.client.post("/v1/stock/index-tracking-funds", { symbol });
     return this.normalizeArrayResponse(response);
   }
   // ===========================================================================

package/dist/index.mjs

@@ -229,19 +229,57 @@ var StockModule = class {
    * @example
    * ```typescript
    * // Get CN defense industry stocks
-   * const stocks = await client.stock.industryConstituent('cn', '军工');
+   * const stocks = await client.stock.industryConstituents('cn', '军工');
    * console.log(stocks);
    *
    * // Get US technology stocks
-   * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+   * const techStocks = await client.stock.industryConstituents('us', 'Technology');
    * ```
    */
-  async industryConstituent(market, name, type) {
+  async industryConstituents(market, name, type) {
     const body = { market, name };
     if (type) {
       body.type = type;
     }
-    const response = await this.client.post("/v1/stock/industry-constituent", body);
+    const response = await this.client.post("/v1/stock/industry-constituents", body);
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get constituent stocks of an index
+   *
+   * @param symbol - Index symbol
+   *
+   * @example
+   * ```typescript
+   * // Get CSI 300 constituent stocks
+   * const stocks = await client.stock.indexConstituents('000300');
+   * console.log(stocks);
+   *
+   * // Get ChiNext constituent stocks
+   * const stocks = await client.stock.indexConstituents('399006');
+   * ```
+   */
+  async indexConstituents(symbol) {
+    const response = await this.client.post("/v1/stock/index-constituents", { symbol });
+    return this.normalizeArrayResponse(response);
+  }
+  /**
+   * Get tracking funds of an index
+   *
+   * @param symbol - Index symbol
+   *
+   * @example
+   * ```typescript
+   * // Get CSI 300 tracking funds
+   * const funds = await client.stock.indexFunds('000300');
+   * console.log(funds);
+   *
+   * // Get SSE 50 tracking funds
+   * const funds = await client.stock.indexFunds('000016');
+   * ```
+   */
+  async indexFunds(symbol) {
+    const response = await this.client.post("/v1/stock/index-tracking-funds", { symbol });
     return this.normalizeArrayResponse(response);
   }
   // ===========================================================================

package/package.json

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