Entities
Get Entity by Ticker
Look up an entity by its stock ticker symbol
GET
/
api
/
entities
/
by-ticker
/
{ticker}
curl "https://worker.rushed.com.br/api/entities/by-ticker/PETR4" \
-H "X-API-Key: rsh_live_xxxxxxxxxxxx"
const res = await fetch(
'https://worker.rushed.com.br/api/entities/by-ticker/PETR4',
{ headers: { 'X-API-Key': 'rsh_live_xxxxxxxxxxxx' } }
);
const { data } = await res.json();
console.log(data.canonicalName); // "Petrobras"
{
"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"
}
}
{
"success": false,
"error": "Not found",
"statusCode": 404
}
Description
Returns the entity associated with a stock ticker symbol. Useful for quick lookups when you know the ticker (e.g., PETR4, VALE3, ITUB4).Headers
string
required
Your Rushed API key
Path Parameters
string
required
Stock ticker symbol (e.g.,
PETR4, VALE3, BBDC4)curl "https://worker.rushed.com.br/api/entities/by-ticker/PETR4" \
-H "X-API-Key: rsh_live_xxxxxxxxxxxx"
const res = await fetch(
'https://worker.rushed.com.br/api/entities/by-ticker/PETR4',
{ headers: { 'X-API-Key': 'rsh_live_xxxxxxxxxxxx' } }
);
const { data } = await res.json();
console.log(data.canonicalName); // "Petrobras"
{
"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"
}
}
{
"success": false,
"error": "Not found",
"statusCode": 404
}
⌘I
curl "https://worker.rushed.com.br/api/entities/by-ticker/PETR4" \
-H "X-API-Key: rsh_live_xxxxxxxxxxxx"
const res = await fetch(
'https://worker.rushed.com.br/api/entities/by-ticker/PETR4',
{ headers: { 'X-API-Key': 'rsh_live_xxxxxxxxxxxx' } }
);
const { data } = await res.json();
console.log(data.canonicalName); // "Petrobras"
{
"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"
}
}
{
"success": false,
"error": "Not found",
"statusCode": 404
}