reportify-sdk 0.2.6 → 0.2.8

package/dist/index.d.mts

@@ -176,9 +176,30 @@ declare class StockModule {
     /**
      * Get company overview including business description, sector, and key metrics
      *
-     * @param symbol - Stock symbol (e.g., "US:AAPL", "HK:0700")
+     * @param options - Query options
+     * @param options.symbols - Stock symbols. You can enter multiple items, separated by commas(,)
+     * @param options.names - Stock names. You can enter multiple items, separated by commas(,)
+     *
+     * @example
+     * ```typescript
+     * // Single stock by symbol
+     * const info = await client.stock.overview({ symbols: 'US:AAPL' });
+     * console.log(info.name, info.sector);
+     *
+     * // Multiple stocks by symbols
+     * const infos = await client.stock.overview({ symbols: 'US:AAPL,US:MSFT' });
+     * for (const info of infos) {
+     *   console.log(info.name);
+     * }
+     *
+     * // Search by name
+     * const info = await client.stock.overview({ names: 'Apple Inc.' });
+     * ```
      */
-    overview(symbol: string): Promise<CompanyOverview>;
+    overview(options: {
+        symbols?: string;
+        names?: string;
+    }): Promise<CompanyOverview | CompanyOverview[]>;
     /**
      * Get list of major shareholders
      *
@@ -793,6 +814,117 @@ declare class QuantModule {
     backtest(params: BacktestParams): Promise<BacktestResult>;
 }
 
+/**
+ * Concepts Module
+ *
+ * Provides access to concept-related data and feeds.
+ */
+
+/**
+ * Concept data structure
+ */
+interface Concept {
+    concept_name: string;
+    concept_desc?: string;
+    concept_keywords?: string[];
+    concept_events?: string[];
+    concept_score?: number;
+    trending_score?: number;
+    published_at?: number;
+    stocks?: ConceptStock[];
+    docs?: ConceptDoc[];
+    [key: string]: unknown;
+}
+/**
+ * Concept stock data
+ */
+interface ConceptStock {
+    symbol: string;
+    name: string;
+    market?: string;
+    [key: string]: unknown;
+}
+/**
+ * Concept document data
+ */
+interface ConceptDoc {
+    id: string;
+    title: string;
+    summary?: string;
+    channel_name?: string;
+    publish_at?: number;
+    [key: string]: unknown;
+}
+/**
+ * Concept feed data structure
+ */
+interface ConceptFeed {
+    concept_name: string;
+    concept_desc?: string;
+    concept_keywords?: string[];
+    gen_count?: number;
+    earliest_at?: number;
+    latest_at?: number;
+    stocks?: ConceptStock[];
+    docs?: ConceptDoc[];
+    events?: ConceptEvent[];
+    [key: string]: unknown;
+}
+/**
+ * Concept event data
+ */
+interface ConceptEvent {
+    event: string;
+    timestamp?: number;
+    [key: string]: unknown;
+}
+/**
+ * Concepts module for accessing concept data and feeds
+ *
+ * This module provides methods to:
+ * - Get latest concepts
+ * - Get today's concept feeds
+ */
+declare class ConceptsModule {
+    private client;
+    constructor(client: Reportify);
+    /**
+     * Get latest concepts
+     *
+     * @param options - Query options
+     * @param options.includeDocs - Whether to include related documents (default: true)
+     *
+     * @example
+     * ```typescript
+     * // Get latest concepts
+     * const concepts = await client.concepts.latest();
+     * for (const concept of concepts) {
+     *   console.log(concept.concept_name);
+     * }
+     *
+     * // Get concepts without documents
+     * const concepts = await client.concepts.latest({ includeDocs: false });
+     * ```
+     */
+    latest(options?: {
+        includeDocs?: boolean;
+    }): Promise<Concept[]>;
+    /**
+     * Get today's concept feeds
+     *
+     * @example
+     * ```typescript
+     * // Get today's concept feeds
+     * const feeds = await client.concepts.today();
+     * for (const feed of feeds) {
+     *   console.log(`${feed.concept_name}: ${feed.gen_count} generations`);
+     *   console.log(`Time range: ${feed.earliest_at} - ${feed.latest_at}`);
+     * }
+     * ```
+     */
+    today(): Promise<ConceptFeed[]>;
+}
+
 /**
  * Reportify Client
  *
@@ -822,6 +954,7 @@ declare class Reportify {
     readonly kb: KBModule;
     readonly docs: DocsModule;
     readonly quant: QuantModule;
+    readonly concepts: ConceptsModule;
     constructor(config: ReportifyConfig);
     /**
      * Make an HTTP request to the API
@@ -870,4 +1003,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 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 };
+export { APIError, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Chunk, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, 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

@@ -176,9 +176,30 @@ declare class StockModule {
     /**
      * Get company overview including business description, sector, and key metrics
      *
-     * @param symbol - Stock symbol (e.g., "US:AAPL", "HK:0700")
+     * @param options - Query options
+     * @param options.symbols - Stock symbols. You can enter multiple items, separated by commas(,)
+     * @param options.names - Stock names. You can enter multiple items, separated by commas(,)
+     *
+     * @example
+     * ```typescript
+     * // Single stock by symbol
+     * const info = await client.stock.overview({ symbols: 'US:AAPL' });
+     * console.log(info.name, info.sector);
+     *
+     * // Multiple stocks by symbols
+     * const infos = await client.stock.overview({ symbols: 'US:AAPL,US:MSFT' });
+     * for (const info of infos) {
+     *   console.log(info.name);
+     * }
+     *
+     * // Search by name
+     * const info = await client.stock.overview({ names: 'Apple Inc.' });
+     * ```
      */
-    overview(symbol: string): Promise<CompanyOverview>;
+    overview(options: {
+        symbols?: string;
+        names?: string;
+    }): Promise<CompanyOverview | CompanyOverview[]>;
     /**
      * Get list of major shareholders
      *
@@ -793,6 +814,117 @@ declare class QuantModule {
     backtest(params: BacktestParams): Promise<BacktestResult>;
 }
 
+/**
+ * Concepts Module
+ *
+ * Provides access to concept-related data and feeds.
+ */
+
+/**
+ * Concept data structure
+ */
+interface Concept {
+    concept_name: string;
+    concept_desc?: string;
+    concept_keywords?: string[];
+    concept_events?: string[];
+    concept_score?: number;
+    trending_score?: number;
+    published_at?: number;
+    stocks?: ConceptStock[];
+    docs?: ConceptDoc[];
+    [key: string]: unknown;
+}
+/**
+ * Concept stock data
+ */
+interface ConceptStock {
+    symbol: string;
+    name: string;
+    market?: string;
+    [key: string]: unknown;
+}
+/**
+ * Concept document data
+ */
+interface ConceptDoc {
+    id: string;
+    title: string;
+    summary?: string;
+    channel_name?: string;
+    publish_at?: number;
+    [key: string]: unknown;
+}
+/**
+ * Concept feed data structure
+ */
+interface ConceptFeed {
+    concept_name: string;
+    concept_desc?: string;
+    concept_keywords?: string[];
+    gen_count?: number;
+    earliest_at?: number;
+    latest_at?: number;
+    stocks?: ConceptStock[];
+    docs?: ConceptDoc[];
+    events?: ConceptEvent[];
+    [key: string]: unknown;
+}
+/**
+ * Concept event data
+ */
+interface ConceptEvent {
+    event: string;
+    timestamp?: number;
+    [key: string]: unknown;
+}
+/**
+ * Concepts module for accessing concept data and feeds
+ *
+ * This module provides methods to:
+ * - Get latest concepts
+ * - Get today's concept feeds
+ */
+declare class ConceptsModule {
+    private client;
+    constructor(client: Reportify);
+    /**
+     * Get latest concepts
+     *
+     * @param options - Query options
+     * @param options.includeDocs - Whether to include related documents (default: true)
+     *
+     * @example
+     * ```typescript
+     * // Get latest concepts
+     * const concepts = await client.concepts.latest();
+     * for (const concept of concepts) {
+     *   console.log(concept.concept_name);
+     * }
+     *
+     * // Get concepts without documents
+     * const concepts = await client.concepts.latest({ includeDocs: false });
+     * ```
+     */
+    latest(options?: {
+        includeDocs?: boolean;
+    }): Promise<Concept[]>;
+    /**
+     * Get today's concept feeds
+     *
+     * @example
+     * ```typescript
+     * // Get today's concept feeds
+     * const feeds = await client.concepts.today();
+     * for (const feed of feeds) {
+     *   console.log(`${feed.concept_name}: ${feed.gen_count} generations`);
+     *   console.log(`Time range: ${feed.earliest_at} - ${feed.latest_at}`);
+     * }
+     * ```
+     */
+    today(): Promise<ConceptFeed[]>;
+}
+
 /**
  * Reportify Client
  *
@@ -822,6 +954,7 @@ declare class Reportify {
     readonly kb: KBModule;
     readonly docs: DocsModule;
     readonly quant: QuantModule;
+    readonly concepts: ConceptsModule;
     constructor(config: ReportifyConfig);
     /**
      * Make an HTTP request to the API
@@ -870,4 +1003,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 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 };
+export { APIError, AuthenticationError, type BacktestParams, type BacktestResult, type BatchOHLCVParams, type Chunk, type CompanyInfo, type CompanyOverview, type Concept, type ConceptDoc, type ConceptEvent, type ConceptFeed, type ConceptStock, ConceptsModule, 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

@@ -22,6 +22,7 @@ var index_exports = {};
 __export(index_exports, {
   APIError: () => APIError,
   AuthenticationError: () => AuthenticationError,
+  ConceptsModule: () => ConceptsModule,
   DocsModule: () => DocsModule,
   KBModule: () => KBModule,
   NotFoundError: () => NotFoundError,
@@ -45,12 +46,37 @@ var StockModule = class {
   /**
    * Get company overview including business description, sector, and key metrics
    *
-   * @param symbol - Stock symbol (e.g., "US:AAPL", "HK:0700")
+   * @param options - Query options
+   * @param options.symbols - Stock symbols. You can enter multiple items, separated by commas(,)
+   * @param options.names - Stock names. You can enter multiple items, separated by commas(,)
+   *
+   * @example
+   * ```typescript
+   * // Single stock by symbol
+   * const info = await client.stock.overview({ symbols: 'US:AAPL' });
+   * console.log(info.name, info.sector);
+   *
+   * // Multiple stocks by symbols
+   * const infos = await client.stock.overview({ symbols: 'US:AAPL,US:MSFT' });
+   * for (const info of infos) {
+   *   console.log(info.name);
+   * }
+   *
+   * // Search by name
+   * const info = await client.stock.overview({ names: 'Apple Inc.' });
+   * ```
    */
-  async overview(symbol) {
-    return this.client.post("/v1/stock/company-overview", {
-      symbol
-    });
+  async overview(options) {
+    if (!options.symbols && !options.names) {
+      throw new Error("Either symbols or names must be provided");
+    }
+    const body = {};
+    if (options.symbols) body.symbols = options.symbols;
+    if (options.names) body.names = options.names;
+    return this.client.post(
+      "/v1/stock/company-overview",
+      body
+    );
   }
   /**
    * Get list of major shareholders
@@ -774,6 +800,56 @@ var QuantModule = class {
   }
 };
 
+// src/concepts.ts
+var ConceptsModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get latest concepts
+   *
+   * @param options - Query options
+   * @param options.includeDocs - Whether to include related documents (default: true)
+   *
+   * @example
+   * ```typescript
+   * // Get latest concepts
+   * const concepts = await client.concepts.latest();
+   * for (const concept of concepts) {
+   *   console.log(concept.concept_name);
+   * }
+   *
+   * // Get concepts without documents
+   * const concepts = await client.concepts.latest({ includeDocs: false });
+   * ```
+   */
+  async latest(options = {}) {
+    const params = new URLSearchParams();
+    if (options.includeDocs !== void 0) {
+      params.append("include_docs", String(options.includeDocs));
+    }
+    const queryString = params.toString();
+    const url = `/v1/concepts/latest${queryString ? `?${queryString}` : ""}`;
+    return this.client.get(url);
+  }
+  /**
+   * Get today's concept feeds
+   *
+   * @example
+   * ```typescript
+   * // Get today's concept feeds
+   * const feeds = await client.concepts.today();
+   * for (const feed of feeds) {
+   *   console.log(`${feed.concept_name}: ${feed.gen_count} generations`);
+   *   console.log(`Time range: ${feed.earliest_at} - ${feed.latest_at}`);
+   * }
+   * ```
+   */
+  async today() {
+    return this.client.get("/v1/concepts/today");
+  }
+};
+
 // src/types.ts
 var ReportifyError = class extends Error {
   statusCode;
@@ -821,6 +897,7 @@ var Reportify = class {
   kb;
   docs;
   quant;
+  concepts;
   constructor(config) {
     if (!config.apiKey) {
       throw new AuthenticationError("API key is required");
@@ -833,6 +910,7 @@ var Reportify = class {
     this.kb = new KBModule(this);
     this.docs = new DocsModule(this);
     this.quant = new QuantModule(this);
+    this.concepts = new ConceptsModule(this);
   }
   /**
    * Make an HTTP request to the API
@@ -854,7 +932,7 @@ var Reportify = class {
         headers: {
           Authorization: `Bearer ${this.apiKey}`,
           "Content-Type": "application/json",
-          "User-Agent": "reportify-sdk-js/0.1.0"
+          "User-Agent": "reportify-sdk-js/0.2.8"
         },
         body: options.body ? JSON.stringify(options.body) : void 0,
         signal: controller.signal
@@ -983,6 +1061,7 @@ var Reportify = class {
 0 && (module.exports = {
   APIError,
   AuthenticationError,
+  ConceptsModule,
   DocsModule,
   KBModule,
   NotFoundError,

package/dist/index.mjs

@@ -9,12 +9,37 @@ var StockModule = class {
   /**
    * Get company overview including business description, sector, and key metrics
    *
-   * @param symbol - Stock symbol (e.g., "US:AAPL", "HK:0700")
+   * @param options - Query options
+   * @param options.symbols - Stock symbols. You can enter multiple items, separated by commas(,)
+   * @param options.names - Stock names. You can enter multiple items, separated by commas(,)
+   *
+   * @example
+   * ```typescript
+   * // Single stock by symbol
+   * const info = await client.stock.overview({ symbols: 'US:AAPL' });
+   * console.log(info.name, info.sector);
+   *
+   * // Multiple stocks by symbols
+   * const infos = await client.stock.overview({ symbols: 'US:AAPL,US:MSFT' });
+   * for (const info of infos) {
+   *   console.log(info.name);
+   * }
+   *
+   * // Search by name
+   * const info = await client.stock.overview({ names: 'Apple Inc.' });
+   * ```
    */
-  async overview(symbol) {
-    return this.client.post("/v1/stock/company-overview", {
-      symbol
-    });
+  async overview(options) {
+    if (!options.symbols && !options.names) {
+      throw new Error("Either symbols or names must be provided");
+    }
+    const body = {};
+    if (options.symbols) body.symbols = options.symbols;
+    if (options.names) body.names = options.names;
+    return this.client.post(
+      "/v1/stock/company-overview",
+      body
+    );
   }
   /**
    * Get list of major shareholders
@@ -738,6 +763,56 @@ var QuantModule = class {
   }
 };
 
+// src/concepts.ts
+var ConceptsModule = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * Get latest concepts
+   *
+   * @param options - Query options
+   * @param options.includeDocs - Whether to include related documents (default: true)
+   *
+   * @example
+   * ```typescript
+   * // Get latest concepts
+   * const concepts = await client.concepts.latest();
+   * for (const concept of concepts) {
+   *   console.log(concept.concept_name);
+   * }
+   *
+   * // Get concepts without documents
+   * const concepts = await client.concepts.latest({ includeDocs: false });
+   * ```
+   */
+  async latest(options = {}) {
+    const params = new URLSearchParams();
+    if (options.includeDocs !== void 0) {
+      params.append("include_docs", String(options.includeDocs));
+    }
+    const queryString = params.toString();
+    const url = `/v1/concepts/latest${queryString ? `?${queryString}` : ""}`;
+    return this.client.get(url);
+  }
+  /**
+   * Get today's concept feeds
+   *
+   * @example
+   * ```typescript
+   * // Get today's concept feeds
+   * const feeds = await client.concepts.today();
+   * for (const feed of feeds) {
+   *   console.log(`${feed.concept_name}: ${feed.gen_count} generations`);
+   *   console.log(`Time range: ${feed.earliest_at} - ${feed.latest_at}`);
+   * }
+   * ```
+   */
+  async today() {
+    return this.client.get("/v1/concepts/today");
+  }
+};
+
 // src/types.ts
 var ReportifyError = class extends Error {
   statusCode;
@@ -785,6 +860,7 @@ var Reportify = class {
   kb;
   docs;
   quant;
+  concepts;
   constructor(config) {
     if (!config.apiKey) {
       throw new AuthenticationError("API key is required");
@@ -797,6 +873,7 @@ var Reportify = class {
     this.kb = new KBModule(this);
     this.docs = new DocsModule(this);
     this.quant = new QuantModule(this);
+    this.concepts = new ConceptsModule(this);
   }
   /**
    * Make an HTTP request to the API
@@ -818,7 +895,7 @@ var Reportify = class {
         headers: {
           Authorization: `Bearer ${this.apiKey}`,
           "Content-Type": "application/json",
-          "User-Agent": "reportify-sdk-js/0.1.0"
+          "User-Agent": "reportify-sdk-js/0.2.8"
         },
         body: options.body ? JSON.stringify(options.body) : void 0,
         signal: controller.signal
@@ -946,6 +1023,7 @@ var Reportify = class {
 export {
   APIError,
   AuthenticationError,
+  ConceptsModule,
   DocsModule,
   KBModule,
   NotFoundError,

package/package.json

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