API Documentation
Programmatic access for sentiment, attention, sector market rollups, and source-backed evidence. Start here to make your first request quickly and integrate with confidence.
Base URL and first request
Base URL: https://www.sentimentick.com/api
curl -X GET "https://www.sentimentick.com/api/ticker/NVDA" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Example response
{
"symbol": "NVDA",
"attention_score": 78,
"sentiment_score": 64,
"sector": "Technology",
"industry": "Semiconductors"
}Plan Limits
| Plan | API Access | Rate Limit | Monthly Quota |
|---|---|---|---|
| Basic | No API access | N/A | N/A |
| Pro | Included | 1 req/sec | 100,000 reqs/month |
| Enterprise | Included | Custom | Custom monthly quota/SLA |
Endpoint Catalog
GET/api/public/market-preview
Public market snapshot for landing experiences.
Request example
curl -X GET "https://www.sentimentick.com/api/public/market-preview" \ -H "Accept: application/json"
Response example
{
"trending_tickers": [
{ "symbol": "NVDA", "attention_score": 82, "sentiment_score": 66 }
],
"top_sentiment": [
{ "symbol": "MSFT", "attention_score": 74, "sentiment_score": 71 }
]
}GET/api/tickers
Ticker ranking and discovery endpoints (plan-gated fields may apply).
Request example
curl -X GET "https://www.sentimentick.com/api/tickers?limit=20" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"items": [
{ "symbol": "AAPL", "attention_score": 69, "sentiment_score": 58 },
{ "symbol": "TSLA", "attention_score": 67, "sentiment_score": 52 }
],
"total": 200
}GET/api/ticker/{symbol}
Ticker-level intelligence and related metrics.
Request example
curl -X GET "https://www.sentimentick.com/api/ticker/NVDA" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"symbol": "NVDA",
"attention_score": 78,
"sentiment_score": 64,
"sector": "Technology",
"industry": "Semiconductors"
}GET/api/market
Market overview with sector rollups (sentiment, attention, mentions).
Request example
curl -X GET "https://www.sentimentick.com/api/market" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"sector_count": 11,
"avg_sentiment": 54.2,
"total_mentions": 12840,
"sectors": [
{ "name": "Technology", "ticker_count": 142, "avg_sentiment": 61.3 }
]
}GET/api/market/sectors/{sector}
Sector drill-down with industries and 7-day sentiment history.
Request example
curl -X GET "https://www.sentimentick.com/api/market/sectors/Technology" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"sector": { "name": "Technology", "ticker_count": 142 },
"industries": [{ "name": "Semiconductors", "avg_sentiment": 63.1 }]
}GET/api/ticker/{symbol}/evidence
Source-backed evidence feed for research workflows.
Request example
curl -X GET "https://www.sentimentick.com/api/ticker/NVDA/evidence" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"symbol": "NVDA",
"evidence": [
{
"source": "news",
"title": "Semiconductor demand commentary",
"published_at": "2026-05-27T10:14:00Z",
"sentiment_score": 8.5
}
]
}Errors and retry guidance
- Use JSON requests/responses with UTF-8 encoding.
- Common statuses:
200,400,401,403,404,429,500. - Handle
429with retry/backoff and monitor monthly quota usage.
401 example
{
"detail": "Invalid API key"
}429 example
{
"detail": "Rate limit exceeded. Retry later."
}