---
title: "Compare directory"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sureshake.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sureshake API › directory-public

`GET /v2/directory/compare`

## Authentication

Requires one of the following:

- 
- `BearerAuth`, http, header `Authorization`

## Query parameters

- `subjects` (`directory-compare.query.subjects`; string, optional)
  - minLength 1; maxLength 1500
- `subject` (`directory-compare.query.subject`; string, optional)
  - minLength 1; maxLength 255
- `industry` (`directory-compare.query.industry`; string, optional)
  - one of `"venture_capital"`, `"private_equity"`, `"asset_management"`, `"banking"`, `"insurance"`, `"fintech"`, `"software"`, `"information_technology"`, `"artificial_intelligence"`, `"cybersecurity"`, `"healthcare"`, `"biotechnology"`, `"pharmaceuticals"`, `"medical_devices"`, `"real_estate"`, `"construction"`, `"manufacturing"`, `"energy"`, `"renewable_energy"`, `"telecommunications"`, `"media_entertainment"`, `"retail"`, `"ecommerce"`, `"consumer_goods"`, `"food_beverage"`, `"hospitality"`, `"transportation_logistics"`, `"automotive"`, `"aerospace_defense"`, `"agriculture"`, `"education"`, `"professional_services"`, `"legal"`, `"marketing_advertising"`, `"nonprofit"`, `"government"`, `"other"`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.sureshake.com/v2/directory/compare
```

### TypeScript

```typescript
const url = 'https://api.sureshake.com/v2/directory/compare';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.sureshake.com/v2/directory/compare"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

Default Response

#### Example

```json
{
  "data": {
    "columns": [
      {
        "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
        "slug": "string",
        "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
        "name": "string",
        "role": "subject",
        "tier": "reference",
        "publicIssuer": true,
        "financials": {
          "source": "sec_filing",
          "sourceLabel": "string",
          "fiscalYear": 0,
          "periodEnd": "string",
          "currency": "string",
          "revenue": 0,
          "revenueGrowth": 0,
          "grossMargin": 0,
          "ebitdaMargin": 0,
          "leverage": 0
        },
        "employees": {
          "count": 0,
          "min": 0,
          "max": 0,
          "source": "organization"
        },
        "filings": {
          "reportsPublished": 0,
          "publicReports": 0,
          "timestampedFilings": 0
        }
      }
    ],
    "peerSelection": {
      "mode": "explicit",
      "industry": "venture_capital",
      "description": "string"
    },
    "industries": [
      {
        "value": "venture_capital",
        "label": "string"
      }
    ],
    "reads": [
      {
        "heading": "string",
        "body": "string"
      }
    ],
    "computedAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}
```

- `data` (`directory-compare.response.200.data`; object, required)
  - `columns` (`directory-compare.response.200.data.columns`; array<object>, required)
    - `listingId` (`directory-compare.response.200.data.columns.listingId`; string, required)
      - format `uuid`
    - `slug` (`directory-compare.response.200.data.columns.slug`; string, required)
    - `entityId` (`directory-compare.response.200.data.columns.entityId`; string, required)
      - format `uuid`
    - `name` (`directory-compare.response.200.data.columns.name`; string, required)
    - `role` (`directory-compare.response.200.data.columns.role`; string, required)
      - one of `"subject"`, `"peer"`
    - `tier` (`directory-compare.response.200.data.columns.tier`; string, required)
      - one of `"reference"`, `"managed"`, `"managed_public_filings"`
    - `publicIssuer` (`directory-compare.response.200.data.columns.publicIssuer`; boolean, required)
    - `financials` (`directory-compare.response.200.data.columns.financials`; object, required)
      - `source` (`directory-compare.response.200.data.columns.financials.source`; string, required, nullable)
        - one of `"sec_filing"`, `"sureshake_filing"`
      - `sourceLabel` (`directory-compare.response.200.data.columns.financials.sourceLabel`; string, required, nullable)
      - `fiscalYear` (`directory-compare.response.200.data.columns.financials.fiscalYear`; integer, required, nullable)
      - `periodEnd` (`directory-compare.response.200.data.columns.financials.periodEnd`; string, required, nullable)
      - `currency` (`directory-compare.response.200.data.columns.financials.currency`; string, required, nullable)
      - `revenue` (`directory-compare.response.200.data.columns.financials.revenue`; number, required, nullable)
      - `revenueGrowth` (`directory-compare.response.200.data.columns.financials.revenueGrowth`; number, required, nullable)
      - `grossMargin` (`directory-compare.response.200.data.columns.financials.grossMargin`; number, required, nullable)
      - `ebitdaMargin` (`directory-compare.response.200.data.columns.financials.ebitdaMargin`; number, required, nullable)
      - `leverage` (`directory-compare.response.200.data.columns.financials.leverage`; number, required, nullable)
    - `employees` (`directory-compare.response.200.data.columns.employees`; object, required)
      - `count` (`directory-compare.response.200.data.columns.employees.count`; integer, required, nullable)
      - `min` (`directory-compare.response.200.data.columns.employees.min`; integer, required, nullable)
      - `max` (`directory-compare.response.200.data.columns.employees.max`; integer, required, nullable)
      - `source` (`directory-compare.response.200.data.columns.employees.source`; string, required, nullable)
        - one of `"organization"`, `"corpus"`
    - `filings` (`directory-compare.response.200.data.columns.filings`; object, required)
      - `reportsPublished` (`directory-compare.response.200.data.columns.filings.reportsPublished`; integer, required)
        - min 0
      - `publicReports` (`directory-compare.response.200.data.columns.filings.publicReports`; integer, required)
        - min 0
      - `timestampedFilings` (`directory-compare.response.200.data.columns.filings.timestampedFilings`; integer, required)
        - min 0
  - `peerSelection` (`directory-compare.response.200.data.peerSelection`; object, required)
    - `mode` (`directory-compare.response.200.data.peerSelection.mode`; string, required)
      - one of `"explicit"`, `"industry"`
    - `industry` (`directory-compare.response.200.data.peerSelection.industry`; string, required, nullable)
      - one of `"venture_capital"`, `"private_equity"`, `"asset_management"`, `"banking"`, `"insurance"`, `"fintech"`, `"software"`, `"information_technology"`, `"artificial_intelligence"`, `"cybersecurity"`, `"healthcare"`, `"biotechnology"`, `"pharmaceuticals"`, `"medical_devices"`, `"real_estate"`, `"construction"`, `"manufacturing"`, `"energy"`, `"renewable_energy"`, `"telecommunications"`, `"media_entertainment"`, `"retail"`, `"ecommerce"`, `"consumer_goods"`, `"food_beverage"`, `"hospitality"`, `"transportation_logistics"`, `"automotive"`, `"aerospace_defense"`, `"agriculture"`, `"education"`, `"professional_services"`, `"legal"`, `"marketing_advertising"`, `"nonprofit"`, `"government"`, `"other"`
    - `description` (`directory-compare.response.200.data.peerSelection.description`; string, required)
  - `industries` (`directory-compare.response.200.data.industries`; array<object>, required)
    - `value` (`directory-compare.response.200.data.industries.value`; string, required)
      - one of `"venture_capital"`, `"private_equity"`, `"asset_management"`, `"banking"`, `"insurance"`, `"fintech"`, `"software"`, `"information_technology"`, `"artificial_intelligence"`, `"cybersecurity"`, `"healthcare"`, `"biotechnology"`, `"pharmaceuticals"`, `"medical_devices"`, `"real_estate"`, `"construction"`, `"manufacturing"`, `"energy"`, `"renewable_energy"`, `"telecommunications"`, `"media_entertainment"`, `"retail"`, `"ecommerce"`, `"consumer_goods"`, `"food_beverage"`, `"hospitality"`, `"transportation_logistics"`, `"automotive"`, `"aerospace_defense"`, `"agriculture"`, `"education"`, `"professional_services"`, `"legal"`, `"marketing_advertising"`, `"nonprofit"`, `"government"`, `"other"`
    - `label` (`directory-compare.response.200.data.industries.label`; string, required)
  - `reads` (`directory-compare.response.200.data.reads`; array<object>, required)
    - `heading` (`directory-compare.response.200.data.reads.heading`; string, required)
    - `body` (`directory-compare.response.200.data.reads.body`; string, required)
  - `computedAt` (`directory-compare.response.200.data.computedAt`; string, required)
    - format `date-time`
- `meta` (`directory-compare.response.200.meta`; object, optional)
  - `timestamp` (`directory-compare.response.200.meta.timestamp`; string, required)
    - format `date-time`

### 400

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.400.error`; object, required)
  - `code` (`directory-compare.response.400.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.400.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.400.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.400.error.traceId`; string, optional) — Unique ID for log correlation

### 401

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.401.error`; object, required)
  - `code` (`directory-compare.response.401.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.401.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.401.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.401.error.traceId`; string, optional) — Unique ID for log correlation

### 403

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.403.error`; object, required)
  - `code` (`directory-compare.response.403.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.403.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.403.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.403.error.traceId`; string, optional) — Unique ID for log correlation

### 404

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.404.error`; object, required)
  - `code` (`directory-compare.response.404.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.404.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.404.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.404.error.traceId`; string, optional) — Unique ID for log correlation

### 409

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.409.error`; object, required)
  - `code` (`directory-compare.response.409.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.409.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.409.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.409.error.traceId`; string, optional) — Unique ID for log correlation

### 429

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.429.error`; object, required)
  - `code` (`directory-compare.response.429.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.429.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.429.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.429.error.traceId`; string, optional) — Unique ID for log correlation

### 500

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.500.error`; object, required)
  - `code` (`directory-compare.response.500.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.500.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.500.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.500.error.traceId`; string, optional) — Unique ID for log correlation

### 503

Default Response

#### Example

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}
```

- `error` (`directory-compare.response.503.error`; object, required)
  - `code` (`directory-compare.response.503.error.code`; string, required) — Machine-readable error code (e.g., NOT_FOUND)
  - `message` (`directory-compare.response.503.error.message`; string, required) — Human-readable error message
  - `details` (`directory-compare.response.503.error.details`; unknown, optional) — Optional structured error details
  - `traceId` (`directory-compare.response.503.error.traceId`; string, optional) — Unique ID for log correlation


Source: https://docs.sureshake.com/reference/directory-compare/index.md