Get Report List by Question

Endpoint

POST /v1/ai_chat/get_report_list_by_question_and_related_info

Description

This API provide the ability to query a list of reports by providing keywords and related information. User can ask question along with relevant context to retrieve matching report data. Provide the ability for user to find the reports as needs quickly.

Parameters

Parameter	Type	Required	Description
keywords	String	Yes	The search keywords entered by the user, which are used to match report content.
report_type_list	array<string>	No	A list of report types
start_date	String	No	The start date for the search, formatted as 'YYYY-MM-DD'.
end_date	String	No	The end date for the search, formatted as 'YYYY-MM-DD'.
market	array<string>	No	A list of markets
sector_list	array<string>	No	A list of sectors
exchange_list	array<string>	No	A list of exchanges
country_list	array<string>	No	A list of countries

Options of Array Parameters:

market: [ { value: "0-1000000000", label: "Less than 1B" }, { value: "1000000000-100000000000", label: "1B - 100B" }, { value: "100000000000-500000000000", label: "100B - 500B" }, { value: "500000000000-9999999999999", label: "More than 500B" }, ]

exchange_list, country_list and sector_list options are attached as below documents:

28KB

exchange.json

Open

23KB

country.json

Open

13KB

sectors.json

Open

Example Request

curl -X 'POST' \
  'https://api.orbitfin.ai/v1/ai_chat/get_report_list_by_question_and_related_info' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: Bearer YOUR_API-KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "report_type_list": [],
  "start_date": "2025-10-24",
  "end_date": "2025-10-24",
  "market": [],
  "sector_list": [],
  "exchange_list": [],
  "country_list": [],
  "keywords": "AAPL"
}'

Example Response

{
  "status_code": 200,
  "data": {
    "table_data": [],
    "total_data": {
      "total_company": 0,
      "total_document": 0,
      "total_document_type": 0,
      "dataset": 0,
      "max_score": 0,
      "min_score": 0,
      "latest_report_date": "-",
      "oldest_report_date": "-"
    }
  },
  "message": "success"
}

Error Code

Code	Description
400	Insufficient user balance.
401	Unauthorized access. Invalid API key.