介绍

使用 TypeScript/JavaScript SDK 访问 Reportify API

安装

npm

npm install reportify-sdk

快速开始

import { Reportify } from 'reportify-sdk';

// 初始化客户端
const client = new Reportify({ apiKey: 'your-api-key' });

// 搜索文档
const docs = await client.search.all('Tesla earnings', { num: 10 });
docs.forEach(doc => console.log(doc.title));

// 搜索新闻
const news = await client.search.news('Apple iPhone', { symbols: ['US:AAPL'] });

// 获取股票财务数据
const income = await client.stock.incomeStatement('AAPL', { period: 'quarterly' });
console.log(income);

特性

文档搜索

支持多种文档类型搜索：新闻、研报、公告、电话会议纪要等

股票数据

获取财务报表、行情数据，完整类型定义

时间线

获取关注公司、主题、机构的最新动态

知识库

搜索用户上传的私有文档

配置选项

apiKey · string · required

你的 Reportify API 密钥，可在开发者中心获取

baseUrl · string · default: "https://api.reportify.cn"

API 基础 URL，通常不需要修改

timeout · number · default: "30000"

请求超时时间（毫秒）

错误处理

import { 
  Reportify, 
  AuthenticationError, 
  RateLimitError, 
  NotFoundError, 
  APIError 
} from 'reportify-sdk';

try {
  const docs = await client.search.all('Tesla');
} catch (error) {
  if (error instanceof AuthenticationError) {
    console.error('API Key 无效');
  } else if (error instanceof RateLimitError) {
    console.error('请求过于频繁，请稍后重试');
  } else if (error instanceof NotFoundError) {
    console.error('资源不存在');
  } else if (error instanceof APIError) {
    console.error(`API 错误: ${error.message}`);
  }
}

TypeScript 支持

SDK 提供完整的 TypeScript 类型定义：

import type { 
  Document, 
  SearchOptions, 
  IncomeStatement,
  BalanceSheet,
  TimelineItem 
} from 'reportify-sdk';

const options: SearchOptions = {
  num: 10,
  categories: ['news', 'reports'],
  symbols: ['US:TSLA']
};

const docs: Document[] = await client.search.all('Tesla', options);

ESM 和 CommonJS

SDK 同时支持 ES Modules 和 CommonJS：

ESM

import { Reportify } from 'reportify-sdk';

下一步

搜索方法

了解文档搜索功能

股票数据

获取财务报表和行情数据