Skip to main content
搜索所有类型的文档。
const docs = await client.search('Tesla earnings', {
  num: 10,
  categories: ['news', 'reports'],
  symbols: ['US:TSLA'],
  startDate: '2024-01-01',
  endDate: '2024-12-31'
});
query
string
required
搜索关键词
options.num
number
default:"10"
返回结果数量,最大 100
options.categories
string[]
文档类别过滤,可选值:news, reports, filings, transcripts, socials
options.symbols
string[]
股票代码过滤,格式:市场:代码,如 US:AAPL, HK:0700, CN:600519
options.startDate
string
开始日期,格式:YYYY-MM-DD
options.endDate
string
结束日期,格式:YYYY-MM-DD
返回值
Promise<Document[]>
文档列表

searchNews()

搜索新闻文章。
const news = await client.searchNews('Apple iPhone', {
  num: 10,
  symbols: ['US:AAPL']
});
query
string
required
搜索关键词
options.num
number
default:"10"
返回结果数量
options.symbols
string[]
股票代码过滤
options.startDate
string
开始日期
options.endDate
string
结束日期

searchReports()

搜索研究报告。
const reports = await client.searchReports('semiconductor analysis', {
  num: 10
});

searchFilings()

搜索公司公告和财报。
const filings = await client.searchFilings('10-K annual report', {
  symbols: ['US:AAPL']
});

searchTranscripts()

搜索财报电话会议纪要。
const transcripts = await client.searchTranscripts('guidance revenue', {
  symbols: ['US:TSLA']
});

类型定义

interface Document {
  docId: string;
  title: string;
  summary: string;
  category: 'news' | 'reports' | 'filings' | 'transcripts' | 'socials';
  publishedAt: number;  // 毫秒时间戳
  channelName: string;
  companies: Array<{
    name: string;
    stocks: Array<{ symbol: string; market: string; ticker: string }>;
  }>;
  url?: string;
}

interface SearchOptions {
  num?: number;
  categories?: string[];
  symbols?: string[];
  startDate?: string;
  endDate?: string;
}