> ## 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.

# Search Entities

> Search entities by name, alias, or ticker

## Description

Full-text search across entity names, aliases, and tickers. Useful for autocomplete and entity lookup.

## Headers

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

## Query Parameters

<ParamField query="q" type="string" required>
  Search query (minimum 2 characters)
</ParamField>

<ParamField query="limit" type="integer" default="10">
  Number of results (1–100)
</ParamField>

## Response

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

<ResponseField name="data" type="array" required>
  Array of matching entities
</ResponseField>

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

<ResponseExample>
  ```json 200 — Success theme={null}
  {
    "success": true,
    "data": [
      {
        "id": "a1b2c3d4-...",
        "entityType": "COMPANY",
        "canonicalName": "Petrobras",
        "aliases": ["Petroleo Brasileiro S.A."],
        "ticker": "PETR4"
      },
      {
        "id": "c3d4e5f6-...",
        "entityType": "COMPANY",
        "canonicalName": "Petro Rio",
        "aliases": ["PetroReconcavo"],
        "ticker": "PRIO3"
      }
    ]
  }
  ```
</ResponseExample>