Skip to main content

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.

​
1. Get your API key

Sign in to the Rushed Dashboard and create an API key. Your key looks like: 
rsh_live_xxxxxxxxxxxxxxxxxxxx

​
2. Fetch your first articles

curl "https://worker.rushed.com.br/api/articles?limit=5" \
  -H "X-API-Key: YOUR_API_KEY"
Response: 
{
  "success": true,
  "data": [
    {
      "id": "550e8400-...",
      "title": "Petrobras announces record dividend payout",
      "publishedAt": "2026-03-28T14:30:00Z",
      "primarySector": "FIN",
      "primaryTopic": "DIV",
      "contentType": "BREAKING",
      "urgencyLevel": "HIGH",
      "isBreaking": true,
      "language": "en"
    }
  ],
  "pagination": { "limit": 5, "offset": 0, "total": 1847, "hasMore": true }
}

​
3. Add filters

# Finance sector articles from today
curl "https://worker.rushed.com.br/api/articles?primarySector=FIN&publishedAfter=2026-03-28T00:00:00Z" \
  -H "X-API-Key: YOUR_API_KEY"

# Only breaking news
curl "https://worker.rushed.com.br/api/articles/breaking?limit=10" \
  -H "X-API-Key: YOUR_API_KEY"

# Articles about technology M&A
curl "https://worker.rushed.com.br/api/articles?primarySector=TEC&primaryTopic=M%26A" \
  -H "X-API-Key: YOUR_API_KEY"

​
4. Request enrichments

Use the include parameter to get sentiment, entities, market impact, and more: 
curl "https://worker.rushed.com.br/api/articles?include=sentiment,entities&limit=3" \
  -H "X-API-Key: YOUR_API_KEY"
Now each article includes: 
{
  "title": "Petrobras announces record dividend payout",
  "primarySector": "FIN",
  "sentimentScore": 0.82,
  "sentimentLabel": "MUITO_POSITIVO",
  "entities": [
    {
      "canonicalName": "Petrobras",
      "ticker": "PETR4",
      "mentionCount": 12,
      "prominenceScore": 0.95,
      "isInTitle": true
    }
  ]
}
Some modules require a Pro plan. See Include Fields for the full list.

​
5. Search articles

curl "https://worker.rushed.com.br/api/articles/search?q=petrobras+dividendos&include=translations" \
  -H "X-API-Key: YOUR_API_KEY"

​
6. Look up entities

# Search for a company
curl "https://worker.rushed.com.br/api/entities/search?q=petrobras" \
  -H "X-API-Key: YOUR_API_KEY"

# Get by stock ticker
curl "https://worker.rushed.com.br/api/entities/by-ticker/PETR4" \
  -H "X-API-Key: YOUR_API_KEY"

# Get articles mentioning an entity
curl "https://worker.rushed.com.br/api/entities/{entityId}/articles?include=sentiment" \
  -H "X-API-Key: YOUR_API_KEY"

​
Next steps