Report Search

Search reports with various search conditions

Note:

• orbit_entity_id is a required parameter for precise query of specific company reports

• Time range cannot exceed one year

• ECM data queries will return error messages

• report_type supports single type or type list

Endpoint

POST /v1/company_report/report_search

Parameters

Parameter	Type	Required	Description
orbit_entity_id	string	Yes	Company ID
start_time	string	No	Start time
end_time	string	No	End time
report_type	array<string>	No	Report type
limit	integer	No	Page size, default value is 50
offset	integer	No	Offset for pagination, default 0

Notes:

• Time range cannot exceed one year

• Do not support ECM report types search, ECM types ['10122','10283','10284','10311'] are only supported by [XXXXXX ]

• report_type supports both single type and multiple types in list

Report_Type Options:

Report types list & descriptions are listed in below attachment:

33KB

Orbit Report Type - - 20251018.csv

Open

Example Request

curl -X 'POST'
'https://api.orbitfin.ai/v1/company_report/report_search'
-H 'accept: application/json'
-H 'X-API-KEY: Bearer YOUR_API-KEY'
-H 'Content-Type: application/json'
-d '{ "orbit_entity_id": "1-5065300786", "start_time": "2024-06-01", "end_time": "2024-08-31", "report_type": ["10002"], "limit": 25, "offset": 0 }'

Example Response

{
  "status_code": 200,
  "data": {
    "reports": [
      {
        "id": "f_6Yo8kDJdYK3qawXbLWVYmy",
        "orbit_entity_id": [
          "1-5065300786"
        ],
        "date": "2024-06-04",
        "title": "Annual report - English",
        "lang": "en"
      }
    ],
    "pagination": {
      "total": 1,
      "limit": 25,
      "offset": 0,
      "has_more": false
    }
  },
  "message": "Report search successful"
}

Error Code

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