Skip to main content
POST
/
v1
/
search
Search Docs
curl --request POST \
  --url https://api.reportify.cn/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "folder_ids": [],
  "categories": [
    "financials",
    "transcripts",
    "reports",
    "news",
    "filings",
    "socials"
  ],
  "markets": [],
  "institutions": [],
  "symbols": [],
  "tags": {},
  "start_date": "<string>",
  "end_date": "<string>",
  "min_score": 123,
  "extended_filters": [
    {}
  ],
  "page_num": 1,
  "page_size": 10,
  "mode": "smart",
  "sort": "smart",
  "should_highlight": false
}
'
{
  "total_count": 0,
  "total_page": 0,
  "page_num": 1,
  "page_size": 10,
  "docs": []
}

​
文档搜索

URL: /v1/search
方法: POST
描述: 根据指定条件搜索文档

​
请求参数

参数名类型描述
querystr搜索关键词。
modestr搜索模式，支持 smart，semantic，keywords。
sortstr排序方式，支持 smart，latest。
folder_idsarray[str]指定的文件夹 ID 列表，如 ["2046915273103380480", "2046522679340961792"]。
categoriesarray文档类别（默认不包含 files），可选值有 financials，transcripts，reports，filings，news, socials，files。
institutionsarray指定机构筛选，如 Morgan Stanley，Seeking Alpha。
languagestr搜索语言，支持值为 all，chinese，english。暂未支持
marketsarray市场区域，默认包括所有市场。可选值有 sz, sh，hk，us。
symbolsarray股票代码筛选，如 SH:000001，HK:00700，US:AAPL。
tagsdict标签数组。
  keystr标签类型（如 industry, company, person, event）。
  valuearray标签内容数组。
page_numint当前页码，默认值为 1。
page_sizeint每页条目数，默认值为 10。
start_datestr开始日期，格式为 YYYY-MM-DD。
end_datestr结束日期，格式为 YYYY-MM-DD。
说明：
  • 当 categories 为 files 时，可以通过指定 tags 参数来筛选上传的文件（上传时制定了相应的 tags）。

​
响应参数

参数名类型描述
page_numint当前页码。
page_sizeint每页条目数。
total_pageint总页数。
total_countint总条目数。
docsarray文档数组，每个文档包含以下字段：
  idstr文档唯一 ID。
  titlestr文档标题。
  urlstr文档网页链接。
  institutionstr发布机构。
  authorstr作者。
  published_atstr发布时间，格式为 YYYY-MM-DDTHH:MM:SS.000Z。
  categorystr文档类别（financials, transcripts, reports, filings, news, socials, files）。
  marketstr市场区域（cn, hk, us）。
  symbolstr股票代码。
  company_namestr公司名称。
  logostr公司 Logo 链接。
  summarystr文档摘要。暂未支持
  tagsdict标签数组。
    keystr标签类型（如 industry, company, person, event）。
    valuearray标签内容数组。
  metadatasdict元数据数组，包含以下字段：
    keystr元数据类型（如 periods, entities）。
    valuearray元数据内容数组。

​
请求示例

cURL 
curl -X POST https://api.reportify.cn/v1/search \
-H "Authorization: Bearer 447460****09c9" \
-H "Content-Type: application/json" \
-d '{
    "query": "Tesla",
    "language": "english",
    "categories": ["financials", "reports"],
    "markets": ["us"],
    "institutions": ["Morgan Stanley"],
    "symbols": ["TSLA"],
    "tags": ["AI"],
    "start_date": "2023-12-01",
    "end_date": "2023-12-31",
    "mode": "smart",
    "sort": "latest",
    "page": 1,
    "page_num": 10
}'
Python 
import requests

url = "https://api.reportify.cn/v1/search"
headers = {
    "Authorization": "Bearer 447460****09c9",
    "Content-Type": "application/json"
}
payload = {
    "query": "Tesla",
    "language": "english",
    "categories": ["financials", "reports"],
    "markets": ["us"],
    "institutions": ["Morgan Stanley"],
    "symbols": ["TSLA"],
    "tags": ["AI"],
    "start_date": "2023-12-01",
    "end_date": "2023-12-31",
    "mode": "smart",
    "sort": "latest",
    "page": 1,
    "page_num": 10
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

​
响应示例

{
  "page": 1,
  "page_num": 10,
  "total_page": 5,
  "total_count": 50,
  "docs": [
    {
      "id": "1046895208953942016",
      "title": "Tesla Q4 Earnings Report",
      "url": "https://reportify.cn/financials/1046895208953942016",
      "file_url": "https://files.reportify.cn/media/production/TSLA5a08ddfbb97bd6486fff7a3875e7fe28_20241024183012.pdf",
      "media_url": "https://files.reportify.cn/media/production/s_4728833_9e25b61b62960211e6040eb2b81b352c.mp3",
      "institution": "Morgan Stanley",
      "author": "Jane Doe",
      "published_at": "2023-12-31T00:00:00.000Z",
      "category": "reports",
      "type": "research_report_company",
      "market": "us",
      "symbol": "TSLA",
      "company_name": "Tesla Inc.",
      "logo": "https://files.reportify.cn/logo/TSLA.svg",
      "summary": "This report covers Tesla's earnings in Q4...",
      "tags": {
        "industry": [
          "AI",
          "EV"
        ],
        "company": [
          "Tesla"
        ]
      },
      "metadatas": {
        "periods": "Q4 2023",
        "entities": [
          "Tesla Inc.",
          "TSLA"
        ]
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
query
string
​
folder_ids
string[]
​
categories
enum<string>[]

An enumeration.

Available options:
financials,
transcripts,
reports,
news,
files,
filings,
socials
​
markets
enum<string>[]

An enumeration.

Available options:
cn,
hk,
us
​
institutions
string[]
​
symbols
string[]
​
tags
Tags · object
​
start_date
string
​
end_date
string
​
min_score
number
​
extended_filters
Extended Filters · object[]
​
page_num
integer
default:1
​
page_size
integer
default:10
​
mode
enum<string>
default:smart

An enumeration.

Available options:
smart,
semantic,
keywords
​
sort
enum<string>
default:smart

An enumeration.

Available options:
smart,
latest
​
should_highlight
boolean
default:false

Response

Successful Response

​
total_count
integer
default:0
​
total_page
integer
default:0
​
page_num
integer
default:1
​
page_size
integer
default:10
​
docs
(OAIDoc · object | OAIDocDetail · object)[]