reportify-sdk 0.2.10 → 0.3.0

package/README.md

@@ -49,19 +49,18 @@ const balance = await client.stock.balanceSheet('US:AAPL');
 const cashflow = await client.stock.cashflowStatement('US:AAPL');
 
 // Price data
-const prices = await client.stock.prices('US:AAPL', { limit: 30 });
-const kline = await client.stock.kline('US:TSLA', { interval: '1d', limit: 100 });
+const prices = await client.stock.prices('US:AAPL', { startDate: '2024-01-01' });
 
-// Real-time quotes
-const quotes = await client.stock.quote(['US:AAPL', 'US:MSFT']);
+// Real-time quote
+const quote = await client.stock.quote('US:AAPL');
 
 // Company info
 const overview = await client.stock.overview('US:AAPL');
 const shareholders = await client.stock.shareholders('US:AAPL');
 
 // Screening and calendar
-const stocks = await client.stock.screener({ market: 'US', minMarketCap: 1e10 });
-const earnings = await client.stock.earningsCalendar({ area: 'us', startDate: '2024-01-01' });
+const stocks = await client.stock.screener({ country: 'US', marketCapMoreThan: 1e10 });
+const earnings = await client.stock.earningsCalendar({ market: 'us', startDate: '2024-01-01', endDate: '2024-01-31' });
 ```
 
 ### Timeline
@@ -92,6 +91,108 @@ const summary = await client.docs.summary('doc_id');
 // List and search documents
 const docs = await client.docs.list({ symbols: ['US:AAPL'], pageSize: 10 });
 const chunks = await client.docs.searchChunks('revenue breakdown', { num: 5 });
+
+// Upload documents
+const result = await client.docs.uploadDocs([
+  { url: 'https://example.com/report.pdf', name: 'Annual Report' }
+]);
+```
+
+### Quant (Quantitative Analysis)
+
+```typescript
+// Compute technical indicators
+const rsi = await client.quant.computeIndicators({
+  symbols: ['000001'],
+  formula: 'RSI(14)'
+});
+
+const macd = await client.quant.computeIndicators({
+  symbols: ['000001'],
+  formula: 'MACD()'
+});
+
+// Screen stocks by formula
+const oversold = await client.quant.screen({ formula: 'RSI(14) < 30' });
+const goldenCross = await client.quant.screen({ formula: 'CROSS(MA(5), MA(20))' });
+
+// Get OHLCV data
+const ohlcv = await client.quant.ohlcv({ symbol: '000001', startDate: '2024-01-01' });
+const ohlcvBatch = await client.quant.ohlcvBatch({ symbols: ['000001', '600519'] });
+
+// Backtest strategy
+const result = await client.quant.backtest({
+  startDate: '2023-01-01',
+  endDate: '2024-01-01',
+  symbol: '000001',
+  entryFormula: 'CROSS(MA(5), MA(20))',
+  exitFormula: 'CROSSDOWN(MA(5), MA(20))'
+});
+console.log(`Total Return: ${(result.total_return_pct * 100).toFixed(2)}%`);
+```
+
+### Concepts
+
+```typescript
+// Get latest concepts
+const concepts = await client.concepts.latest();
+concepts.forEach(c => console.log(c.concept_name));
+
+// Get today's concept feeds
+const feeds = await client.concepts.today();
+```
+
+### Channels
+
+```typescript
+// Search channels
+const result = await client.channels.search('Goldman Sachs');
+
+// Get followed channels
+const followings = await client.channels.getFollowings();
+
+// Follow/unfollow a channel
+await client.channels.follow('channel_id');
+await client.channels.unfollow('channel_id');
+```
+
+### Chat
+
+```typescript
+// Chat completion based on documents
+const response = await client.chat.completion(
+  'What are Tesla revenue projections?',
+  {
+    symbols: ['US:TSLA'],
+    mode: 'comprehensive'  // concise, comprehensive, deepresearch
+  }
+);
+console.log(response.message);
+```
+
+### Agent
+
+```typescript
+// Create agent conversation
+const conv = await client.agent.createConversation(11887655289749510);
+
+// Chat with agent
+const response = await client.agent.chat(
+  conv.id,
+  'Analyze NVIDIA latest earnings'
+);
+
+// Get agent-generated file
+const fileContent = await client.agent.getFile('file_id');
+// Save in Node.js: fs.writeFileSync('output.xlsx', Buffer.from(fileContent));
+```
+
+### User
+
+```typescript
+// Get followed companies
+const companies = await client.user.followedCompanies();
+companies.forEach(c => console.log(`${c.symbol}: ${c.name}`));
 ```
 
 ## Error Handling

package/dist/index.d.mts

@@ -567,7 +567,7 @@ declare class DocsModule {
     /**
      * Query documents by symbols
      *
-     * @param symbols - Required: Stock symbols
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Filter options
      */
     queryBySymbols(symbols: string[], options?: {
@@ -1409,7 +1409,7 @@ declare class SearchModule {
      * Search company filings
      *
      * @param query - Search query string
-     * @param symbols - Required: Stock symbols to filter by
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Search options
      */
     filings(query: string, symbols: string[], options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
@@ -1417,7 +1417,7 @@ declare class SearchModule {
      * Search earnings call transcripts and slides
      *
      * @param query - Search query string
-     * @param symbols - Required: Stock symbols to filter by
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Search options including fiscal year/quarter filters
      */
     conferenceCalls(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;
@@ -1425,7 +1425,7 @@ declare class SearchModule {
      * Search earnings financial reports
      *
      * @param query - Search query string
-     * @param symbols - Required: Stock symbols to filter by
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Search options including fiscal year/quarter filters
      */
     earningsPack(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;

package/dist/index.d.ts

@@ -567,7 +567,7 @@ declare class DocsModule {
     /**
      * Query documents by symbols
      *
-     * @param symbols - Required: Stock symbols
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Filter options
      */
     queryBySymbols(symbols: string[], options?: {
@@ -1409,7 +1409,7 @@ declare class SearchModule {
      * Search company filings
      *
      * @param query - Search query string
-     * @param symbols - Required: Stock symbols to filter by
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Search options
      */
     filings(query: string, symbols: string[], options?: Omit<SearchOptions, 'symbols' | 'categories' | 'industries' | 'channelIds'>): Promise<Document[]>;
@@ -1417,7 +1417,7 @@ declare class SearchModule {
      * Search earnings call transcripts and slides
      *
      * @param query - Search query string
-     * @param symbols - Required: Stock symbols to filter by
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Search options including fiscal year/quarter filters
      */
     conferenceCalls(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;
@@ -1425,7 +1425,7 @@ declare class SearchModule {
      * Search earnings financial reports
      *
      * @param query - Search query string
-     * @param symbols - Required: Stock symbols to filter by
+     * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
      * @param options - Search options including fiscal year/quarter filters
      */
     earningsPack(query: string, symbols: string[], options?: EarningsSearchOptions): Promise<Document[]>;

package/dist/index.js

@@ -468,7 +468,7 @@ var DocsModule = class {
   /**
    * Query documents by symbols
    *
-   * @param symbols - Required: Stock symbols
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Filter options
    */
   async queryBySymbols(symbols, options = {}) {
@@ -1474,7 +1474,7 @@ var SearchModule = class {
    * Search company filings
    *
    * @param query - Search query string
-   * @param symbols - Required: Stock symbols to filter by
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Search options
    */
   async filings(query, symbols, options = {}) {
@@ -1492,7 +1492,7 @@ var SearchModule = class {
    * Search earnings call transcripts and slides
    *
    * @param query - Search query string
-   * @param symbols - Required: Stock symbols to filter by
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Search options including fiscal year/quarter filters
    */
   async conferenceCalls(query, symbols, options = {}) {
@@ -1512,7 +1512,7 @@ var SearchModule = class {
    * Search earnings financial reports
    *
    * @param query - Search query string
-   * @param symbols - Required: Stock symbols to filter by
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Search options including fiscal year/quarter filters
    */
   async earningsPack(query, symbols, options = {}) {
@@ -1664,7 +1664,7 @@ var Reportify = class {
         headers: {
           Authorization: `Bearer ${this.apiKey}`,
           "Content-Type": "application/json",
-          "User-Agent": "reportify-sdk-js/0.2.10"
+          "User-Agent": "reportify-sdk-js/0.3.0"
         },
         body: options.body ? JSON.stringify(options.body) : void 0,
         signal: controller.signal
@@ -1725,7 +1725,7 @@ var Reportify = class {
       headers: {
         Authorization: `Bearer ${this.apiKey}`,
         "Content-Type": "application/json",
-        "User-Agent": "reportify-sdk-typescript/0.2.10"
+        "User-Agent": "reportify-sdk-typescript/0.3.0"
       }
     });
     if (!response.ok) {

package/dist/index.mjs

@@ -426,7 +426,7 @@ var DocsModule = class {
   /**
    * Query documents by symbols
    *
-   * @param symbols - Required: Stock symbols
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Filter options
    */
   async queryBySymbols(symbols, options = {}) {
@@ -1432,7 +1432,7 @@ var SearchModule = class {
    * Search company filings
    *
    * @param query - Search query string
-   * @param symbols - Required: Stock symbols to filter by
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Search options
    */
   async filings(query, symbols, options = {}) {
@@ -1450,7 +1450,7 @@ var SearchModule = class {
    * Search earnings call transcripts and slides
    *
    * @param query - Search query string
-   * @param symbols - Required: Stock symbols to filter by
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Search options including fiscal year/quarter filters
    */
   async conferenceCalls(query, symbols, options = {}) {
@@ -1470,7 +1470,7 @@ var SearchModule = class {
    * Search earnings financial reports
    *
    * @param query - Search query string
-   * @param symbols - Required: Stock symbols to filter by
+   * @param symbols - Stock symbols in market:ticker format (required, e.g., US:AAPL, HK:00700, SH:600519, SZ:000001)
    * @param options - Search options including fiscal year/quarter filters
    */
   async earningsPack(query, symbols, options = {}) {
@@ -1622,7 +1622,7 @@ var Reportify = class {
         headers: {
           Authorization: `Bearer ${this.apiKey}`,
           "Content-Type": "application/json",
-          "User-Agent": "reportify-sdk-js/0.2.10"
+          "User-Agent": "reportify-sdk-js/0.3.0"
         },
         body: options.body ? JSON.stringify(options.body) : void 0,
         signal: controller.signal
@@ -1683,7 +1683,7 @@ var Reportify = class {
       headers: {
         Authorization: `Bearer ${this.apiKey}`,
         "Content-Type": "application/json",
-        "User-Agent": "reportify-sdk-typescript/0.2.10"
+        "User-Agent": "reportify-sdk-typescript/0.3.0"
       }
     });
     if (!response.ok) {

package/package.json

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