API Documentation
Programmatic access for ticker sentiment, attention, and technical analysis. 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 responseShow
{
"ticker": {
"id": 142,
"symbol": "NVDA",
"company_name": "NVIDIA Corporation",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Semiconductors",
"market_cap": 3280000000000,
"avg_dollar_volume": 6130300000,
"sentiment_score": 64.2,
"sentiment_tier": "bullish",
"attention_score": 78.1,
"attention_tier": "high",
"sentiment_change_24h": 1.4,
"sentiment_change_7d": -0.8,
"mention_count": 42,
"news_mention_count": 30,
"social_mention_count": 12,
"bullish_count": 22,
"bearish_count": 8,
"neutral_count": 12,
"fair_value_score": 75,
"fair_value_label": "undervalued",
"fair_value_metric": "pe"
},
"fair_value": {
"score": 75,
"label": "undervalued",
"metric": "pe",
"pe_ratio": 38.2,
"sector_median_pe": 52.1,
"sector": "Technology"
},
"insider_activity": {
"label": "net_buying",
"window_days": 90,
"buy_count": 2,
"sell_count": 0,
"buy_value": 420000,
"sell_value": 0,
"total_transactions_on_file": 5
},
"sentiment_history": [
{
"date": "2026-07-12",
"sentiment_score": 64.2,
"mention_count": 42,
"attention_score": 78.1
}
],
"sentiment_breakdown": {
"news": 84.1,
"social": 50.0,
"technical": 65.0
},
"technical_analysis": {
"short_term": {
"key": "short",
"label": "Short-term",
"window": 5,
"score": 48.5,
"bias": "neutral",
"return_pct": -2.2,
"sma_diff_pct": -1.1,
"reason": "-2.2% over 5d, -1.1% vs SMA5",
"sufficient_history": true
},
"medium_term": {
"key": "medium",
"label": "Medium-term",
"window": 50,
"score": 35.0,
"bias": "bearish",
"return_pct": -4.6,
"sma_diff_pct": -3.0,
"reason": "-4.6% over 50d, -3.0% vs SMA50",
"sufficient_history": true
},
"long_term": {
"key": "long",
"label": "Long-term",
"window": 200,
"score": 72.0,
"bias": "bullish",
"return_pct": 10.9,
"sma_diff_pct": 3.4,
"reason": "+10.9% over 200d, +3.4% vs SMA200",
"sufficient_history": true
},
"signals": [
{ "key": "short", "label": "Short-term", "window": 5, "score": 48.5, "bias": "neutral", "return_pct": -2.2, "sma_diff_pct": -1.1, "reason": "-2.2% over 5d, -1.1% vs SMA5", "sufficient_history": true },
{ "key": "medium", "label": "Medium-term", "window": 50, "score": 35.0, "bias": "bearish", "return_pct": -4.6, "sma_diff_pct": -3.0, "reason": "-4.6% over 50d, -3.0% vs SMA50", "sufficient_history": true },
{ "key": "long", "label": "Long-term", "window": 200, "score": 72.0, "bias": "bullish", "return_pct": 10.9, "sma_diff_pct": 3.4, "reason": "+10.9% over 200d, +3.4% vs SMA200", "sufficient_history": true }
],
"momentum": {
"period": 14,
"value": 58.3,
"condition": "neutral",
"reason": "RSI 58.3 — neutral momentum",
"sufficient_history": true
}
}
}Plan Limits
| Plan | API Access | Rate Limit | Monthly Quota |
|---|---|---|---|
| Basic | No API access | N/A | N/A |
| Pro | No API access | N/A | N/A |
| Developer | Included | 2 req/sec | 100,000 credits/month |
| Developer Plus | Included | 2 req/sec | 200,000 credits/month |
Endpoint Catalog
GET/api/leaderboards
Top trending, top sentiment, top daily stock picks, and today's price movers.
5 credits / request
Request example
curl -X GET "https://www.sentimentick.com/api/leaderboards" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"trending": [
{ "id": 3, "symbol": "NVDA", "company_name": "NVIDIA Corporation", "exchange": "NASDAQ", "sector": "Technology", "industry": "Semiconductors", "sentiment_score": 66, "sentiment_tier": "bullish", "attention_score": 82, "attention_tier": "very_high", "sentiment_change_24h": -1.1, "sentiment_change_7d": 2.4, "mention_count": 140, "news_mention_count": 30, "social_mention_count": 110, "bullish_count": 40, "bearish_count": 20, "neutral_count": 10 }
],
"top_sentiment": [
{ "id": 5, "symbol": "MSFT", "company_name": "Microsoft Corporation", "exchange": "NASDAQ", "sector": "Technology", "industry": "Software", "sentiment_score": 71, "sentiment_tier": "bullish", "attention_score": 74, "attention_tier": "high", "sentiment_change_24h": 2.3, "sentiment_change_7d": 5.1, "mention_count": 32, "news_mention_count": 28, "social_mention_count": 4, "bullish_count": 20, "bearish_count": 5, "neutral_count": 7 }
],
"top_daily": [
{ "id": 12, "symbol": "TEVA", "company_name": "Teva Pharmaceutical", "exchange": "NYSE", "sector": "Healthcare", "industry": "Pharmaceuticals", "sentiment_score": 82, "sentiment_tier": "very_bullish", "attention_score": 41, "attention_tier": "moderate", "sentiment_change_24h": 4.2, "sentiment_change_7d": 6.8, "mention_count": 6, "news_mention_count": 6, "social_mention_count": 0, "bullish_count": 5, "bearish_count": 0, "neutral_count": 1 }
],
"movers": [
{ "symbol": "CWBC", "company_name": "Community West Bancshares", "sector": "Finance", "market_cap": 704865406, "pct_change": 67.64, "last_price": 25.95, "prev_close": 15.48, "sentiment_score": 56.7 }
]
}GET/api/tickers
Ticker ranking, filtering, and discovery across the full market.
20 credits / request
Query parameters
- limitoptionalOptional. Page size. Default 50. Maximum 200 — requests above that are rejected.
- offsetoptionalOptional. Skip this many rows. Default 0. Use with limit to iterate all tickers.
- searchoptionalOptional. Matches ticker symbol or company name.
- exchangeoptionalOptional. Filter by exchange (e.g. NASDAQ, NYSE).
- sectoroptionalOptional. Filter by sector.
- industryoptionalOptional. Filter by industry.
- asset_typeoptionalOptional. Filter by asset type (default equity).
- market_cap_tieroptionalOptional. One of: mega, large, mid, small.
- sentiment_tieroptionalOptional. One of: very_bullish, bullish, neutral, bearish, very_bearish.
- attention_tieroptionalOptional. One of: very_high, high, moderate, low.
- fair_value_tieroptionalOptional. One of: undervalued, fairly_valued, overvalued. Only matches tickers where Fair Value has actually been computed (sector-relative P/E, or P/S when the ticker is unprofitable).
- volume_tieroptionalOptional. One of: high (≥$100M/day), moderate ($20M–$100M/day), low ($1M–$20M/day), minimal (<$1M/day). Based on average daily dollar volume (close × volume) over the most recent 20 trading days.
- movers_tieroptionalOptional. One of: gainers, losers. Based on today's live price % change vs. previous close (refreshed every 5 minutes during market hours). Tickers with no snapshot yet don't match either tier.
Request example
curl -X GET "https://www.sentimentick.com/api/tickers?limit=50&offset=0&sentiment_tier=bullish" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"total": 3000,
"limit": 50,
"offset": 0,
"tickers": [
{
"id": 91,
"symbol": "AAPL",
"company_name": "Apple Inc.",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Consumer Electronics",
"market_cap": 3400000000000,
"asset_type": "equity",
"sentiment_score": 58,
"sentiment_tier": "bullish",
"attention_score": 69,
"attention_tier": "moderate",
"mention_count": 40,
"social_mention_count": 10,
"news_mention_count": 30,
"bullish_count": 22,
"bearish_count": 8,
"neutral_count": 10,
"fair_value_score": 75,
"fair_value_label": "undervalued",
"fair_value_metric": "pe",
"avg_dollar_volume": 245900000,
"pct_change_today": 1.85
}
]
}GET/api/ticker/{symbol}
Ticker-level intelligence — score, technicals, history, and insider activity.
5 credits / request
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
{
"ticker": {
"id": 142,
"symbol": "NVDA",
"company_name": "NVIDIA Corporation",
"exchange": "NASDAQ",
"sector": "Technology",
"industry": "Semiconductors",
"market_cap": 3280000000000,
"avg_dollar_volume": 6130300000,
"sentiment_score": 64.2,
"sentiment_tier": "bullish",
"attention_score": 78.1,
"attention_tier": "high",
"sentiment_change_24h": 1.4,
"sentiment_change_7d": -0.8,
"mention_count": 42,
"news_mention_count": 30,
"social_mention_count": 12,
"bullish_count": 22,
"bearish_count": 8,
"neutral_count": 12,
"fair_value_score": 75,
"fair_value_label": "undervalued",
"fair_value_metric": "pe"
},
"fair_value": {
"score": 75,
"label": "undervalued",
"metric": "pe",
"pe_ratio": 38.2,
"sector_median_pe": 52.1,
"sector": "Technology"
},
"insider_activity": {
"label": "net_buying",
"window_days": 90,
"buy_count": 2,
"sell_count": 0,
"buy_value": 420000,
"sell_value": 0,
"total_transactions_on_file": 5
},
"sentiment_history": [
{ "date": "2026-07-12", "sentiment_score": 64.2, "mention_count": 42, "attention_score": 78.1 }
],
"sentiment_breakdown": { "news": 84.1, "social": 50.0, "technical": 65.0 },
"technical_analysis": {
"short_term": {
"key": "short",
"label": "Short-term",
"window": 5,
"score": 48.5,
"bias": "neutral",
"return_pct": -2.2,
"sma_diff_pct": -1.1,
"reason": "-2.2% over 5d, -1.1% vs SMA5",
"sufficient_history": true
},
"medium_term": {
"key": "medium",
"label": "Medium-term",
"window": 50,
"score": 35.0,
"bias": "bearish",
"return_pct": -4.6,
"sma_diff_pct": -3.0,
"reason": "-4.6% over 50d, -3.0% vs SMA50",
"sufficient_history": true
},
"long_term": {
"key": "long",
"label": "Long-term",
"window": 200,
"score": 72.0,
"bias": "bullish",
"return_pct": 10.9,
"sma_diff_pct": 3.4,
"reason": "+10.9% over 200d, +3.4% vs SMA200",
"sufficient_history": true
},
"signals": [
{ "key": "short", "label": "Short-term", "window": 5, "score": 48.5, "bias": "neutral", "return_pct": -2.2, "sma_diff_pct": -1.1, "reason": "-2.2% over 5d, -1.1% vs SMA5", "sufficient_history": true },
{ "key": "medium", "label": "Medium-term", "window": 50, "score": 35.0, "bias": "bearish", "return_pct": -4.6, "sma_diff_pct": -3.0, "reason": "-4.6% over 50d, -3.0% vs SMA50", "sufficient_history": true },
{ "key": "long", "label": "Long-term", "window": 200, "score": 72.0, "bias": "bullish", "return_pct": 10.9, "sma_diff_pct": 3.4, "reason": "+10.9% over 200d, +3.4% vs SMA200", "sufficient_history": true }
],
"momentum": {
"period": 14,
"value": 58.3,
"condition": "neutral",
"reason": "RSI 58.3 — neutral momentum",
"sufficient_history": true
}
},
"sentiment_backtest": {
"forward_trading_days": 5,
"bullish": { "occurrences": 11, "sufficient_data": true, "avg_return_pct": 1.8, "median_return_pct": 1.2, "hit_rate_pct": 63.6 },
"bearish": { "occurrences": 4, "sufficient_data": false },
"strength_label": "moderate",
"strength_score": 63.6,
"computed_at": "2026-08-06T13:00:21.064584"
},
"sentiment_percentile": {
"percentile": 72,
"days_of_history": 30,
"current_score": 64.2
}
}GET/api/ticker/{symbol}/news
Per-ticker news and sentiment feed, with source attribution and a link to the original article.
10 credits / request
Query parameters
- limitoptionalOptional. Page size. Default 20. Maximum 100 — requests above that are rejected.
- offsetoptionalOptional. Skip this many rows. Default 0. Use with limit to iterate all news.
Request example
curl -X GET "https://www.sentimentick.com/api/ticker/NVDA/news?limit=20&offset=0" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"symbol": "NVDA",
"total": 214,
"limit": 20,
"offset": 0,
"news": [
{
"title": "Nvidia Reports Record Quarterly Revenue, Beats Estimates",
"source": "CNBC",
"author": null,
"copyright": "© CNBC",
"source_type": "news",
"published_at": "2026-08-06T14:32:00Z",
"sentiment_label": "bullish",
"sentiment_tier": "bullish",
"sentiment_score": 82,
"url": "https://www.cnbc.com/2026/08/06/nvidia-q2-earnings.html"
}
]
}GET/api/ticker/{symbol}/insider
Paginated SEC Form 4 insider activity.
10 credits / request
Query parameters
- limitoptionalOptional. Page size. Default 20. Maximum 100 — requests above that are rejected.
- offsetoptionalOptional. Skip this many rows. Default 0. Use with limit to iterate all transactions.
- window_daysoptionalOptional. Trailing window in days. Default 90. Maximum 365.
Request example
curl -X GET "https://www.sentimentick.com/api/ticker/NVDA/insider?limit=20&offset=0" \ -H "X-API-KEY: st_your_key_here" \ -H "Accept: application/json"
Response example
{
"symbol": "NVDA",
"label": "net_buying",
"window_days": 90,
"buy_count": 2,
"sell_count": 0,
"buy_value": 420000,
"sell_value": 0,
"total": 5,
"limit": 20,
"offset": 0,
"transactions": [
{
"filer_name": "Jane Smith",
"role": "Officer",
"transaction_code": "P",
"acquired_disposed_code": "A",
"shares": 4000,
"price_per_share": 105.5,
"value": 422000,
"transaction_date": "2026-08-01",
"is_10b5_1_plan": false,
"is_qualifying_signal": true
}
]
}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."
}