Sign in

v1

latestOpenAPI 3.1.0MIT2026-08-0453113564.4 KB
X/Twitter Stocks

Stock Sentiment

Returns detailed X/Twitter data for a specific ticker.

Includes:

  • buzz_score: normalized X/Twitter activity score for the selected period
  • trend: activity momentum over the current 3 UTC days vs previous 3 UTC days using mentions, likes and author breadth; not price movement or Grok rank movement. For from/to, anchors at to (or now when to is today)
  • sentiment_score, bullish_pct, bearish_pct: directional sentiment signals
  • mentions, unique_tweets, total_upvotes: volume and engagement signals
  • daily_trend: daily X/Twitter activity and sentiment values
  • top_tweets: representative high-engagement tweets from the selected period

Returns 200 with found: false when the ticker is supported but this service has no qualifying data in the requested window. Returns 404 only when the ticker is unsupported.

get/x/stocks/v1/stock/{ticker}

Path parameters

tickerstring required

Stock ticker symbol (e.g., TSLA, $AAPL, BRK.A)

Example:TSLA

Stock ticker symbol (e.g., TSLA, $AAPL, BRK.A)

Query parameters

fromstring date nullable

Start date in YYYY-MM-DD. Inclusive UTC date.

Start date in YYYY-MM-DD. Inclusive UTC date.

tostring date nullable

End date in YYYY-MM-DD. Inclusive UTC date. Omit to use the current UTC date.

End date in YYYY-MM-DD. Inclusive UTC date. Omit to use the current UTC date.

daysinteger

Deprecated v1 compatibility shorthand. Prefer from and to for reproducible UTC date windows.

Deprecated v1 compatibility shorthand. Prefer from and to for reproducible UTC date windows.

Response

Successful Response

tickerstring required

Stock ticker symbol

company_namestring nullable

Company name from ticker_reference

foundboolean

Legacy v1 data-availability flag. true means this service has qualifying data for this asset/window. false means the asset is supported, but this service has no qualifying data for the requested window. Planned for removal in v2.

buzz_scorenumber nullable

V5.5 buzz score from real tweet data using HHI-based author diversity when author_distribution is available, else scaled unique_authors (null if not found)

mentionsinteger nullable

Total tweet mentions within the selected period

sentiment_scorenumber nullable

Average sentiment score from tweet analysis (-1 to +1)

positive_countinteger nullable

Deprecated. Prefer bullish_pct with mentions for public analysis; retained for v1 compatibility.

negative_countinteger nullable

Deprecated. Prefer bearish_pct with mentions for public analysis; retained for v1 compatibility.

neutral_countinteger nullable

Deprecated. Prefer bullish_pct, bearish_pct and mentions for public analysis; retained for v1 compatibility.

total_upvotesinteger nullable

Total likes across all tweet mentions

unique_tweetsinteger nullable

Number of unique tweets (distinct tweet_id)

trend'rising' | 'falling' | 'stable' nullable

Activity momentum over the current 3 UTC days vs previous 3 UTC days using mentions, likes and author breadth; not price movement or Grok rank movement. For from/to, anchors at to (or now when to is today).

bullish_pctinteger nullable

Percentage of bullish tweet mentions

bearish_pctinteger nullable

Percentage of bearish tweet mentions

period_daysinteger nullable

Analysis period in days

Example response

{
  "ticker": "TSLA",
  "company_name": "Tesla, Inc.",
  "found": true,
  "buzz_score": 72.5,
  "mentions": 156,
  "sentiment_score": 0.35,
  "total_upvotes": 2847,
  "unique_tweets": 42,
  "trend": "rising",
  "bullish_pct": 45,
  "bearish_pct": 12,
  "period_days": 7,
  "daily_trend": [
    {
      "date": "2025-12-28",
      "mentions": 42,
      "sentiment_score": 0.15,
      "buzz_score": 52.3,
      "bullish_pct": 60,
      "bearish_pct": 25
    },
    {
      "date": "2025-12-27",
      "mentions": 38,
      "sentiment_score": 0.22,
      "buzz_score": 48.1,
      "bullish_pct": 55,
      "bearish_pct": 18
    }
  ],
  "top_tweets": [
    {
      "text_snippet": "$TSLA breaking out! 🚀",
      "sentiment_score": 0.85,
      "sentiment_label": "positive",
      "likes": 1247,
      "retweets": 89,
      "views": 52340,
      "author": "stockguru",
      "created_at": "2025-12-28T14:32:00Z"
    }
  ],
  "top_authors": [
    {
      "author": "stockguru",
      "mentions": 24,
      "sentiment_score": 0.41,
      "buzz_score": 61.8,
      "count": 24
    }
  ]
}