Skip to main content
GET
/
api
/
entities
/
search
curl "https://worker.rushed.com.br/api/entities/search?q=petro&limit=5" \
  -H "X-API-Key: rsh_live_xxxxxxxxxxxx"

{
  "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"
    }
  ]
}

​
Description

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

​
Headers

​
X-API-Key
string
required
Your Rushed API key

​
Query Parameters

​
q
string
required
Search query (minimum 2 characters)
​
limit
integer
default:"10"
Number of results (1–100)

​
Response

​
success
boolean
required
​
data
array
required
Array of matching entities
curl "https://worker.rushed.com.br/api/entities/search?q=petro&limit=5" \
  -H "X-API-Key: rsh_live_xxxxxxxxxxxx"

{
  "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"
    }
  ]
}