Single Entity Lookup

Use this endpoint to search for companies by name, permanent identifier, ISIN code, or ticker symbol.

Endpoint

POST /v1/company_report/company_search

Authentication

This endpoint requires API key authentication via the request header.

Request Headers

Header
Value
Required
Description

Content-Type

application/json

Yes

Specifies the media type of the request

X-API-KEY

{your_api_key}

Yes

Your unique API authentication key

Query Parameters

You can search using any one of the following parameters:

Parameter
Type
Required
Description

name

string

No

Full or partial name of the company

perm_id

string

No

Permanent identifier of the company

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 "Content-Type: application/json" \
  -H "X-API-Key: <your_api_key>" \
  -d '{
    "name": "NAME",
    "ticker": "TICKER",
    "perm_id": "PERMID_ID",
    "isin": "ISIN"
  }'

Response

Success Response (200 OK)

{
  "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"
        }
      ]
    }
  ],
  "message": "Search successful"
}

Response Fields

Field
Type
Description

status_code

integer

HTTP status code of the response

data

array

Array of company objects matching the search criteria

data[].orbit_entity_id

string

Unique identifier for the company entity

data[].name

string

Official registered name of the company

data[].png_logo_path

string

URL to the company's logo image

data[].children

array

List of securities associated with the company

data[].children[].isin

string

ISIN code for the specific security

data[].children[].ticker

string

Ticker symbol for the specific security

message

string

message

Last updated