reportify-sdk 0.2.1 → 0.2.3

package/dist/index.d.mts

@@ -115,6 +115,16 @@ type Interval = '1d' | '1w' | '1m';
 type PriceAdjust = 'forward' | 'backward' | 'none';
 type Market = 'us' | 'hk' | 'cn';
 type IPOStatus = 'Filing' | 'Hearing' | 'Priced';
+interface IndustryConstituent {
+    symbol: string;
+    area: string;
+    name: string;
+    type_name?: string;
+    industry_one_level_name?: string;
+    industry_second_level_name?: string;
+    industry_third_level_name?: string;
+    [key: string]: unknown;
+}
 interface TimelineOptions {
     num?: number;
 }
@@ -272,6 +282,24 @@ declare class StockModule {
      * Get Hong Kong IPO calendar
      */
     ipoCalendarHK(status?: IPOStatus): Promise<IPOEvent[]>;
+    /**
+     * Get constituent stocks of an industry
+     *
+     * @param market - Stock market ("cn", "hk", "us")
+     * @param name - Industry name
+     * @param type - Industry classification type (optional)
+     *
+     * @example
+     * ```typescript
+     * // Get CN defense industry stocks
+     * const stocks = await client.stock.industryConstituent('cn', '军工');
+     * console.log(stocks);
+     *
+     * // Get US technology stocks
+     * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+     * ```
+     */
+    industryConstituent(market: Market, name: string, type?: string): Promise<IndustryConstituent[]>;
     private normalizeArrayResponse;
 }
 
@@ -498,16 +526,18 @@ interface OHLCVData {
     [key: string]: unknown;
 }
 interface BacktestParams {
-    symbol: string;
-    formula: string;
     startDate: string;
     endDate: string;
+    symbol: string;
     market?: StockMarket;
+    entryFormula: string;
+    exitFormula?: string;
     initialCash?: number;
     commission?: number;
     stopLoss?: number;
     sizerPercent?: number;
     autoClose?: boolean;
+    labels?: Record<string, string>;
 }
 interface BacktestResult {
     success: boolean;
@@ -684,17 +714,37 @@ declare class QuantModule {
      *
      * @example
      * ```typescript
+     * // Simple golden cross strategy
      * const result = await client.quant.backtest({
-     *   symbol: '000001',
-     *   formula: 'CROSS(MA(5), MA(20))',  // Golden cross buy signal
      *   startDate: '2023-01-01',
      *   endDate: '2024-01-01',
+     *   symbol: '000001',
+     *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy when MA5 crosses above MA20
      *   initialCash: 100000
      * });
      *
      * console.log(`Total Return: ${(result.total_return_pct * 100).toFixed(2)}%`);
      * console.log(`Max Drawdown: ${(result.max_drawdown * 100).toFixed(2)}%`);
      * console.log(`Win Rate: ${(result.win_rate * 100).toFixed(2)}%`);
+     *
+     * // Strategy with entry and exit signals
+     * const result2 = await client.quant.backtest({
+     *   startDate: '2023-01-01',
+     *   endDate: '2024-01-01',
+     *   symbol: '000001',
+     *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy signal
+     *   exitFormula: 'CROSSDOWN(MA(5), MA(20))'  // Sell signal
+     * });
+     *
+     * // With custom labels for analysis
+     * const result3 = await client.quant.backtest({
+     *   startDate: '2023-01-01',
+     *   endDate: '2024-01-01',
+     *   symbol: '000001',
+     *   entryFormula: 'RSI(14) < 30',
+     *   exitFormula: 'RSI(14) > 70',
+     *   labels: { rsi: 'RSI(14)', ma20: 'MA(20)' }
+     * });
      * ```
      */
     backtest(params: BacktestParams): Promise<BacktestResult>;
@@ -777,4 +827,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 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 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

@@ -115,6 +115,16 @@ type Interval = '1d' | '1w' | '1m';
 type PriceAdjust = 'forward' | 'backward' | 'none';
 type Market = 'us' | 'hk' | 'cn';
 type IPOStatus = 'Filing' | 'Hearing' | 'Priced';
+interface IndustryConstituent {
+    symbol: string;
+    area: string;
+    name: string;
+    type_name?: string;
+    industry_one_level_name?: string;
+    industry_second_level_name?: string;
+    industry_third_level_name?: string;
+    [key: string]: unknown;
+}
 interface TimelineOptions {
     num?: number;
 }
@@ -272,6 +282,24 @@ declare class StockModule {
      * Get Hong Kong IPO calendar
      */
     ipoCalendarHK(status?: IPOStatus): Promise<IPOEvent[]>;
+    /**
+     * Get constituent stocks of an industry
+     *
+     * @param market - Stock market ("cn", "hk", "us")
+     * @param name - Industry name
+     * @param type - Industry classification type (optional)
+     *
+     * @example
+     * ```typescript
+     * // Get CN defense industry stocks
+     * const stocks = await client.stock.industryConstituent('cn', '军工');
+     * console.log(stocks);
+     *
+     * // Get US technology stocks
+     * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+     * ```
+     */
+    industryConstituent(market: Market, name: string, type?: string): Promise<IndustryConstituent[]>;
     private normalizeArrayResponse;
 }
 
@@ -498,16 +526,18 @@ interface OHLCVData {
     [key: string]: unknown;
 }
 interface BacktestParams {
-    symbol: string;
-    formula: string;
     startDate: string;
     endDate: string;
+    symbol: string;
     market?: StockMarket;
+    entryFormula: string;
+    exitFormula?: string;
     initialCash?: number;
     commission?: number;
     stopLoss?: number;
     sizerPercent?: number;
     autoClose?: boolean;
+    labels?: Record<string, string>;
 }
 interface BacktestResult {
     success: boolean;
@@ -684,17 +714,37 @@ declare class QuantModule {
      *
      * @example
      * ```typescript
+     * // Simple golden cross strategy
      * const result = await client.quant.backtest({
-     *   symbol: '000001',
-     *   formula: 'CROSS(MA(5), MA(20))',  // Golden cross buy signal
      *   startDate: '2023-01-01',
      *   endDate: '2024-01-01',
+     *   symbol: '000001',
+     *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy when MA5 crosses above MA20
      *   initialCash: 100000
      * });
      *
      * console.log(`Total Return: ${(result.total_return_pct * 100).toFixed(2)}%`);
      * console.log(`Max Drawdown: ${(result.max_drawdown * 100).toFixed(2)}%`);
      * console.log(`Win Rate: ${(result.win_rate * 100).toFixed(2)}%`);
+     *
+     * // Strategy with entry and exit signals
+     * const result2 = await client.quant.backtest({
+     *   startDate: '2023-01-01',
+     *   endDate: '2024-01-01',
+     *   symbol: '000001',
+     *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy signal
+     *   exitFormula: 'CROSSDOWN(MA(5), MA(20))'  // Sell signal
+     * });
+     *
+     * // With custom labels for analysis
+     * const result3 = await client.quant.backtest({
+     *   startDate: '2023-01-01',
+     *   endDate: '2024-01-01',
+     *   symbol: '000001',
+     *   entryFormula: 'RSI(14) < 30',
+     *   exitFormula: 'RSI(14) > 70',
+     *   labels: { rsi: 'RSI(14)', ma20: 'MA(20)' }
+     * });
      * ```
      */
     backtest(params: BacktestParams): Promise<BacktestResult>;
@@ -777,4 +827,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 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 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

@@ -255,6 +255,31 @@ var StockModule = class {
     );
     return this.normalizeArrayResponse(response);
   }
+  /**
+   * Get constituent stocks of an industry
+   *
+   * @param market - Stock market ("cn", "hk", "us")
+   * @param name - Industry name
+   * @param type - Industry classification type (optional)
+   *
+   * @example
+   * ```typescript
+   * // Get CN defense industry stocks
+   * const stocks = await client.stock.industryConstituent('cn', '军工');
+   * console.log(stocks);
+   *
+   * // Get US technology stocks
+   * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+   * ```
+   */
+  async industryConstituent(market, name, type) {
+    const body = { market, name };
+    if (type) {
+      body.type = type;
+    }
+    const response = await this.client.post("/v1/stock/industry-constituent", body);
+    return this.normalizeArrayResponse(response);
+  }
   // ===========================================================================
   // Helper Methods
   // ===========================================================================
@@ -655,32 +680,59 @@ var QuantModule = class {
    *
    * @example
    * ```typescript
+   * // Simple golden cross strategy
    * const result = await client.quant.backtest({
-   *   symbol: '000001',
-   *   formula: 'CROSS(MA(5), MA(20))',  // Golden cross buy signal
    *   startDate: '2023-01-01',
    *   endDate: '2024-01-01',
+   *   symbol: '000001',
+   *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy when MA5 crosses above MA20
    *   initialCash: 100000
    * });
    *
    * console.log(`Total Return: ${(result.total_return_pct * 100).toFixed(2)}%`);
    * console.log(`Max Drawdown: ${(result.max_drawdown * 100).toFixed(2)}%`);
    * console.log(`Win Rate: ${(result.win_rate * 100).toFixed(2)}%`);
+   *
+   * // Strategy with entry and exit signals
+   * const result2 = await client.quant.backtest({
+   *   startDate: '2023-01-01',
+   *   endDate: '2024-01-01',
+   *   symbol: '000001',
+   *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy signal
+   *   exitFormula: 'CROSSDOWN(MA(5), MA(20))'  // Sell signal
+   * });
+   *
+   * // With custom labels for analysis
+   * const result3 = await client.quant.backtest({
+   *   startDate: '2023-01-01',
+   *   endDate: '2024-01-01',
+   *   symbol: '000001',
+   *   entryFormula: 'RSI(14) < 30',
+   *   exitFormula: 'RSI(14) > 70',
+   *   labels: { rsi: 'RSI(14)', ma20: 'MA(20)' }
+   * });
    * ```
    */
   async backtest(params) {
-    return this.client.post("/v1/quant/backtest", {
-      symbol: params.symbol,
-      formula: params.formula,
+    const body = {
       start_date: params.startDate,
       end_date: params.endDate,
+      symbol: params.symbol,
       market: params.market || "cn",
+      entry_formula: params.entryFormula,
       initial_cash: params.initialCash ?? 1e5,
       commission: params.commission ?? 0,
       stop_loss: params.stopLoss ?? 0,
       sizer_percent: params.sizerPercent ?? 99,
       auto_close: params.autoClose ?? true
-    });
+    };
+    if (params.exitFormula !== void 0) {
+      body.exit_formula = params.exitFormula;
+    }
+    if (params.labels !== void 0) {
+      body.labels = params.labels;
+    }
+    return this.client.post("/v1/quant/backtest", body);
   }
 };
 

package/dist/index.mjs

@@ -219,6 +219,31 @@ var StockModule = class {
     );
     return this.normalizeArrayResponse(response);
   }
+  /**
+   * Get constituent stocks of an industry
+   *
+   * @param market - Stock market ("cn", "hk", "us")
+   * @param name - Industry name
+   * @param type - Industry classification type (optional)
+   *
+   * @example
+   * ```typescript
+   * // Get CN defense industry stocks
+   * const stocks = await client.stock.industryConstituent('cn', '军工');
+   * console.log(stocks);
+   *
+   * // Get US technology stocks
+   * const techStocks = await client.stock.industryConstituent('us', 'Technology');
+   * ```
+   */
+  async industryConstituent(market, name, type) {
+    const body = { market, name };
+    if (type) {
+      body.type = type;
+    }
+    const response = await this.client.post("/v1/stock/industry-constituent", body);
+    return this.normalizeArrayResponse(response);
+  }
   // ===========================================================================
   // Helper Methods
   // ===========================================================================
@@ -619,32 +644,59 @@ var QuantModule = class {
    *
    * @example
    * ```typescript
+   * // Simple golden cross strategy
    * const result = await client.quant.backtest({
-   *   symbol: '000001',
-   *   formula: 'CROSS(MA(5), MA(20))',  // Golden cross buy signal
    *   startDate: '2023-01-01',
    *   endDate: '2024-01-01',
+   *   symbol: '000001',
+   *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy when MA5 crosses above MA20
    *   initialCash: 100000
    * });
    *
    * console.log(`Total Return: ${(result.total_return_pct * 100).toFixed(2)}%`);
    * console.log(`Max Drawdown: ${(result.max_drawdown * 100).toFixed(2)}%`);
    * console.log(`Win Rate: ${(result.win_rate * 100).toFixed(2)}%`);
+   *
+   * // Strategy with entry and exit signals
+   * const result2 = await client.quant.backtest({
+   *   startDate: '2023-01-01',
+   *   endDate: '2024-01-01',
+   *   symbol: '000001',
+   *   entryFormula: 'CROSS(MA(5), MA(20))',  // Buy signal
+   *   exitFormula: 'CROSSDOWN(MA(5), MA(20))'  // Sell signal
+   * });
+   *
+   * // With custom labels for analysis
+   * const result3 = await client.quant.backtest({
+   *   startDate: '2023-01-01',
+   *   endDate: '2024-01-01',
+   *   symbol: '000001',
+   *   entryFormula: 'RSI(14) < 30',
+   *   exitFormula: 'RSI(14) > 70',
+   *   labels: { rsi: 'RSI(14)', ma20: 'MA(20)' }
+   * });
    * ```
    */
   async backtest(params) {
-    return this.client.post("/v1/quant/backtest", {
-      symbol: params.symbol,
-      formula: params.formula,
+    const body = {
       start_date: params.startDate,
       end_date: params.endDate,
+      symbol: params.symbol,
       market: params.market || "cn",
+      entry_formula: params.entryFormula,
       initial_cash: params.initialCash ?? 1e5,
       commission: params.commission ?? 0,
       stop_loss: params.stopLoss ?? 0,
       sizer_percent: params.sizerPercent ?? 99,
       auto_close: params.autoClose ?? true
-    });
+    };
+    if (params.exitFormula !== void 0) {
+      body.exit_formula = params.exitFormula;
+    }
+    if (params.labels !== void 0) {
+      body.labels = params.labels;
+    }
+    return this.client.post("/v1/quant/backtest", body);
   }
 };
 

package/package.json

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