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

# List Entities

> Retrieve a paginated list of named entities (companies, people, institutions)

## Description

Returns entities extracted by Rushed's NER (Named Entity Recognition) system. Filter by entity type or stock ticker.

## Headers

<ParamField header="X-API-Key" type="string" required>
  Your Rushed API key
</ParamField>

## Query Parameters

<ParamField query="type" type="string">
  Filter by entity type: `COMPANY`, `PERSON`, `INSTITUTION`, `TICKER`, `LOCATION`, `EVENT`, `PRODUCT`, `LAW`, `MONETARY`, `METRIC`
</ParamField>

<ParamField query="ticker" type="string">
  Filter by stock ticker (e.g., `PETR4`)
</ParamField>

<ParamField query="limit" type="integer" default="20">
  Results per page (1–100)
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Number of results to skip
</ParamField>

## Response

<ResponseField name="success" type="boolean" required />

<ResponseField name="data" type="array" required>
  <Expandable title="Entity object">
    <ResponseField name="id" type="string">UUID</ResponseField>
    <ResponseField name="entityType" type="string">Entity type</ResponseField>
    <ResponseField name="canonicalName" type="string">Primary name</ResponseField>
    <ResponseField name="aliases" type="array">Alternative names</ResponseField>
    <ResponseField name="ticker" type="string">Stock ticker (if applicable)</ResponseField>
    <ResponseField name="cnpj" type="string">Brazilian company registration (if applicable)</ResponseField>
    <ResponseField name="createdAt" type="string">ISO 8601 creation date</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://worker.rushed.com.br/api/entities?type=COMPANY&limit=10" \
    -H "X-API-Key: rsh_live_xxxxxxxxxxxx"
  ```

  ```python Python theme={null}
  import requests
  res = requests.get(
      'https://worker.rushed.com.br/api/entities',
      params={'type': 'COMPANY', 'limit': 10},
      headers={'X-API-Key': 'rsh_live_xxxxxxxxxxxx'}
  )
  ```
</RequestExample>

<ResponseExample>
  ```json 200 — Success theme={null}
  {
    "success": true,
    "data": [
      {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "entityType": "COMPANY",
        "canonicalName": "Petrobras",
        "aliases": ["Petroleo Brasileiro S.A.", "PETR"],
        "ticker": "PETR4",
        "cnpj": "33.000.167/0001-01",
        "createdAt": "2024-11-15T10:30:00Z"
      },
      {
        "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "entityType": "COMPANY",
        "canonicalName": "Vale",
        "aliases": ["Vale S.A.", "CVRD"],
        "ticker": "VALE3",
        "cnpj": "33.592.510/0001-54",
        "createdAt": "2024-11-15T10:31:00Z"
      }
    ],
    "pagination": { "limit": 10, "offset": 0, "total": 1250, "hasMore": true }
  }
  ```
</ResponseExample>