Single Entity Lookup
Endpoint
POST /v1/company_report/company_searchTry it out in API Playground →
Request
Headers
Content-Type
string
Yes
application/json
X-API-KEY
string
Yes
your-api-key
Request Body Parameters
name
string
No
Full or partial name of the company
lei
string
No
LEI (Legal Entity Identifier) is a unique 20-character code that identifies legal entities. Use this parameter in your API request to specify the entity you want to query.
isin
string
No
ISIN (International Securities Identification Number) code of the company's equity
ticker
string
No
Stock ticker symbol of the company's equity
Note: At least one parameter must be provided. You can use multiple parameters to refine your search.
Example Request
curl -X 'POST' \
'https://api.orbitfin.ai/v1/company_report/company_search' \
-H 'accept: application/json' \
-H 'X-API-KEY: <your-api-key>' \
-H 'Content-Type: application/json' \
-d '{
"name": "NVIDIA",
"ticker": "NVDA",
"lei": "",
"isin": "US67066G1040"
}'Response
Response Fields
Top-Level Fields
status_code
integer
HTTP status code (200 for success)
data
array
Array of company objects matching the search criteria
detail
string/null
Additional error details (null on success)
message
string
Response status message
Company Object (data[])
orbit_entity_id
string
Unique identifier for the company entity
name
string
Official registered name of the company
png_logo_path
string
URL to the company's logo image
children
array
List of securities associated with the company
Security Object (data[].children[])
isin
string
ISIN code for the specific security
ticker
string
Ticker symbol for the specific security
Example Response
{
"status_code": 200,
"data": [
{
"orbit_entity_id": "1-4295914405",
"name": "NVIDIA CORP",
"png_logo_path": "https://ot-cdn.s3.us-west-2.amazonaws.com/company-logos/v1/c820079af1c24e5c97dd511bcee95163.png",
"children": [
{
"isin": "ARBCOM460184",
"ticker": "NVDAm"
},
{
"isin": "BRNVDCBDR008",
"ticker": "NVDC34"
},
{
"isin": "CA67080A1093",
"ticker": "NVDA"
},
{
"isin": "US67066G1040",
"ticker": "NVDA"
}
]
}
],
"detail": null,
"message": "Search successful"
}Error Handling
All endpoints follow the standard error response format. When an error occurs, the API returns an appropriate HTTP status code along with a structured error response.
For detailed information about error codes, response formats, and troubleshooting guidelines, please refer to Appendix A: Error Code Reference.
Last updated