Skip to main content

​
search.all()

搜索所有类型的文档。 
const docs = await client.search.all('Tesla earnings', {
  num: 10,
  categories: ['news', 'reports'],
  symbols: ['US:TSLA'],
  startDatetime: '2024-01-01',
  endDatetime: '2024-12-31'
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
options.numnumber否10返回结果数量，最大 100
options.categoriesstring[]否-文档类别过滤，可选值：news, reports, filings, transcripts, socials
options.symbolsstring[]否-股票代码列表，格式为 market:ticker（如 US:AAPL、HK:00700、SH:600519、SZ:000001）
options.industriesstring[]否-行业过滤
options.channelIdsstring[]否-渠道 ID 过滤
options.startDatetimestring否-开始时间，格式：YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS
options.endDatetimestring否-结束时间，格式：YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS
返回值： Promise<Document[]> - 文档列表

​
search.news()

搜索新闻文章。 
const news = await client.search.news('Apple iPhone', {
  num: 10,
  symbols: ['US:AAPL']
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
options.numnumber否10返回结果数量
options.symbolsstring[]否-股票代码过滤
options.channelIdsstring[]否-渠道 ID 过滤
options.startDatetimestring否-开始时间
options.endDatetimestring否-结束时间
返回值： Promise<Document[]> - 新闻文档列表

​
search.reports()

搜索研究报告。 
const reports = await client.search.reports('semiconductor analysis', {
  num: 10,
  symbols: ['US:NVDA'],
  startDatetime: '2024-01-01'
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
options.numnumber否10返回结果数量
options.symbolsstring[]否-股票代码过滤
options.industriesstring[]否-行业过滤
options.channelIdsstring[]否-渠道 ID 过滤
options.startDatetimestring否-开始时间
options.endDatetimestring否-结束时间
返回值： Promise<Document[]> - 研究报告列表

​
search.filings()

搜索公司公告和财报。 
const filings = await client.search.filings('10-K annual report', ['US:AAPL'], {
  num: 20,
  startDatetime: '2024-01-01'
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
symbolsstring[]是-股票代码列表
options.numnumber否10返回结果数量
options.startDatetimestring否-开始时间
options.endDatetimestring否-结束时间
返回值： Promise<Document[]> - 公告/财报列表

​
search.conferenceCalls()

Search for earnings-related conference call transcripts and presentation slides. Query is optional - if not provided, returns documents in reverse chronological order; if provided, sorts by relevance (note sort_by parameter). 
// With query - results sorted by relevance
const calls = await client.search.conferenceCalls(['US:AAPL', 'US:MSFT'], {
  query: 'AI strategy',
  num: 10,
  fiscalYear: '2025',
  fiscalQuarter: 'Q4'
});

// Without query - results sorted by date descending
const latestCalls = await client.search.conferenceCalls(['US:AAPL', 'US:MSFT'], {
  fiscalYear: '2025'
});
参数：
参数类型必填默认值说明
querystring否-搜索关键词（可选）。不提供时按时间倒序返回；提供时默认按相关性排序。
symbolsstring[]是-股票代码列表
options.numnumber否10返回结果数量
options.startDatetimestring否-开始时间（YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS）
options.endDatetimestring否-结束时间（YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS）
options.fiscalYearstring否-财年筛选，如 2025、2026
options.fiscalQuarterstring否-财季筛选，如 Q1、Q2、Q3、Q4
options.sortBystring否date_desc排序方式：date_desc（时间倒序）、relevance（相关性排序）、date_asc（时间正序）
返回值： Promise<Document[]> - 电话会议记录列表

​
search.earningsPack()

Search for earnings-related documents submitted to exchanges, including quarterly reports, semi-annual reports, and annual reports. Query is optional - if not provided, returns documents in reverse chronological order; if provided, sorts by relevance (note sort_by parameter). 
// With query - results sorted by relevance
const docs = await client.search.earningsPack(['US:AAPL', 'US:TSLA'], {
  query: 'revenue growth',
  num: 10,
  fiscalYear: '2025',
  fiscalQuarter: 'Q4'
});

// Without query - results sorted by date descending
const latestDocs = await client.search.earningsPack(['US:AAPL', 'US:TSLA'], {
  fiscalYear: '2025'
});
参数：
参数类型必填默认值说明
querystring否-搜索关键词（可选）。不提供时按时间倒序返回；提供时默认按相关性排序。
symbolsstring[]是-股票代码列表
options.numnumber否10返回结果数量
options.startDatetimestring否-开始时间（YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS）
options.endDatetimestring否-结束时间（YYYY-MM-DD 或 YYYY-MM-DD HH:MM:SS）
options.fiscalYearstring否-财年筛选，如 2025、2026
options.fiscalQuarterstring否-财季筛选，如 Q1、Q2、Q3、Q4
options.sortBystring否date_desc排序方式：date_desc（时间倒序）、relevance（相关性排序）、date_asc（时间正序）
返回值： Promise<Document[]> - 财报相关文档列表

​
search.minutes()

搜索电话会议和投资者关系（IR）会议。 
const minutes = await client.search.minutes('board meeting', {
  symbols: ['US:AAPL'],
  num: 10
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
options.numnumber否10返回结果数量
options.symbolsstring[]否-股票代码过滤
options.startDatetimestring否-开始时间
options.endDatetimestring否-结束时间
返回值： Promise<Document[]> - 会议纪要列表

​
search.socials()

搜索社交媒体内容。 
const socials = await client.search.socials('Tesla stock', {
  symbols: ['US:TSLA'],
  num: 10
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
options.numnumber否10返回结果数量
options.symbolsstring[]否-股票代码过滤
options.channelIdsstring[]否-渠道 ID 过滤
options.startDatetimestring否-开始时间
options.endDatetimestring否-结束时间
返回值： Promise<Document[]> - 社交媒体文档列表

​
search.webpages()

搜索网页内容。 
const pages = await client.search.webpages('AI technology', {
  num: 20,
  startDatetime: '2024-01-01'
});
参数：
参数类型必填默认值说明
querystring是-搜索关键词
options.numnumber否10返回结果数量
options.startDatetimestring否-开始时间
options.endDatetimestring否-结束时间
返回值： Promise<Document[]> - 网页内容列表

​
类型定义

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[];
  industries?: string[];
  channelIds?: string[];
  startDatetime?: string;
  endDatetime?: string;
}

interface EarningsSearchOptions {
  num?: number;
  startDatetime?: string;
  endDatetime?: string;
  fiscalYear?: string;
  fiscalQuarter?: string;
}