# Bulk Entity Lookup

Search for multiple companies with advanced filters.

#### Endpoint

```
POST /v1/company_report/company_search_batch
```

#### Parameters

| Parameter        | Type    | Required | Description                                                                                                                                                                                                |
| ---------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **mic**          | string  | No       | Exchange code (e.g., XNAS, XLON)                                                                                                                                                                           |
| country\_iso     | string  | No       | Country code (e.g., US, GB, JP)                                                                                                                                                                            |
| market\_cap\_usd | dict    | No       | Market cap range {"min": 1000000, "max": 10000000}                                                                                                                                                         |
| industry\_id     | string  | No       | Industry classification ID (e.g., "123")                                                                                                                                                                   |
| limit            | integer | No       | Number of results (default: 20, max: 100)                                                                                                                                                                  |
| offset           | integer | No       | Pagination offset (default: 0)                                                                                                                                                                             |
| order            | string  | No       | <p>Sort order</p><ul><li>market\_cap\_desc: Market cap descending (default)</li><li>market\_cap\_asc: Market cap ascending</li><li>name\_asc: Name ascending</li><li>name\_desc: Name descending</li></ul> |

#### Example Request

bash

```bash
curl -X 'POST' \
  'https://api.orbitfin.ai/v1/company_report/company_search_batch' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "mic": "",
  "country_iso": "",
  "market_cap_usd": {"min": 1000000, "max": 10000000},
  "industry_id": "",
  "limit": 50,
  "offset": 0,
  "order": "market_cap_desc"
}'
```

#### Response

json

```json
{
  "status_code": 200,
  "data": {
    "companies": [
      {
        "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",
        "country_iso": "CA",
        "mic": "XTSE",
        "market_cap_usd": 4595372833264.54,
        "primary_industry_id": "1-4294952838",
        "primary_business_sector_id": "1-4294952722",
        "primary_economic_sector_id": "1-4294952723",
        "lei": "549300S4KLFTLO7GSQ80",
        "cik": "0001045810",
        "primary_isin": "CA67080A1093",
        "primary_ticker": "NVDA"
      }
    ],
    "pagination": {
      "total": 77961,
      "limit": 50,
      "offset": 0,
      "has_more": true
    }
  },
  "message": "Batch search successful"
}
```

## Response Fields

### Success Response Structure

#### Top-Level Fields

| Field         | Type    | Description                                                            |
| ------------- | ------- | ---------------------------------------------------------------------- |
| `status_code` | integer | HTTP status code of the response (200 for success)                     |
| `data`        | object  | Container object holding the search results and pagination information |
| `message`     | string  | message                                                                |

#### Data Object

| Field        | Type   | Description                                            |
| ------------ | ------ | ------------------------------------------------------ |
| `companies`  | array  | Array of company objects matching the search criteria  |
| `pagination` | object | Pagination metadata for navigating through result sets |

#### Company Object (`data.companies[]`)

| Field                        | Type   | Description                                                                            |
| ---------------------------- | ------ | -------------------------------------------------------------------------------------- |
| `orbit_entity_id`            | string | Unique identifier for the company entity in the Orbit system                           |
| `name`                       | string | Official registered name of the company                                                |
| `png_logo_path`              | string | URL to the company's logo image in PNG format                                          |
| `country_iso`                | string | ISO 3166-1 alpha-2 country code where the primary listing is located                   |
| `mic`                        | string | Market Identifier Code (MIC) of the primary exchange where the company is listed       |
| `market_cap_usd`             | number | Current market capitalization in US dollars                                            |
| `primary_industry_id`        | string | Unique identifier for the company's primary industry classification                    |
| `primary_business_sector_id` | string | Unique identifier for the company's primary business sector                            |
| `primary_economic_sector_id` | string | Unique identifier for the company's primary economic sector                            |
| `lei`                        | string | Legal Entity Identifier (LEI) - a 20-character unique identifier for legal entities    |
| `cik`                        | string | Central Index Key (CIK) assigned by the U.S. Securities and Exchange Commission        |
| `primary_isin`               | string | Primary ISIN (International Securities Identification Number) for the company's equity |
| `primary_ticker`             | string | Primary stock ticker symbol for the company's equity                                   |

#### Pagination Object (`data.pagination`)

| Field      | Type    | Description                                                                |
| ---------- | ------- | -------------------------------------------------------------------------- |
| `total`    | integer | Total number of companies matching the search criteria across all pages    |
| `limit`    | integer | Maximum number of results returned per page (default: 50)                  |
| `offset`   | integer | Number of results skipped from the beginning (used for pagination)         |
| `has_more` | boolean | Indicates whether additional results are available beyond the current page |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.orbitfin.ai/orbit-api-reference/api/bulk-entity-lookup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.