{ "openapi": "3.0.3", "info": { "title": "StockTwits Ticker Sentiment & Trending Symbol Feed (server mode)", "version": "1.1", "description": "Send one lookup and get the results back in the response. It takes the same input as a normal run: query parameters with GET, or a JSON body with POST. At most 50 results and 240 seconds per request; start a normal run for bigger jobs. Requests run in your own Apify account at the Actor's normal price.", "x-oa-server-mode": "1.1" }, "paths": { "/": { "get": { "operationId": "lookupGet", "summary": "Run one lookup (query parameters)", "parameters": [ { "name": "mode", "in": "query", "required": true, "description": "What to fetch from StockTwits.", "schema": { "type": "string", "enum": [ "symbolMessages", "userMessages", "trendingSymbols", "marketMessages", "symbolSentiment", "symbolOverview", "priceHistory", "search", "conversation", "trendingMessages", "symbolSearch" ], "default": "symbolMessages" }, "example": "symbolMessages" }, { "name": "symbols", "in": "query", "required": false, "description": "Tickers to fetch, e.g. AAPL, TSLA, BTC.X, BRK.B, SHOP.TSX. Accepts $cashtags and StockTwits symbol URLs. Use .X for crypto. (GET: repeat the parameter once per value.)", "schema": { "type": "array", "default": [ "AAPL" ], "items": { "type": "string" }, "maxItems": 5 }, "style": "form", "explode": true, "example": [ "AAPL" ] }, { "name": "usernames", "in": "query", "required": false, "description": "StockTwits usernames without @, or profile URLs, e.g. KirRoyalTrader, https://stocktwits.com/Fibonaccino. (GET: repeat the parameter once per value.)", "schema": { "type": "array", "default": [], "items": { "type": "string" }, "maxItems": 5 }, "style": "form", "explode": true }, { "name": "searchQueries", "in": "query", "required": false, "description": "Company names, tickers, or trader names to search for, e.g. tesla, apple, TraderLion. (GET: repeat the parameter once per value.)", "schema": { "type": "array", "default": [], "items": { "type": "string" }, "maxItems": 3 }, "style": "form", "explode": true }, { "name": "searchType", "in": "query", "required": false, "description": "What to return from each query.", "schema": { "type": "string", "enum": [ "all", "symbols", "users" ], "default": "all" } }, { "name": "streamFilter", "in": "query", "required": false, "description": "All = newest first, Top = StockTwits ranking, Trending = curated high-engagement posts for the ticker (up to 100).", "schema": { "type": "string", "enum": [ "all", "top", "trending" ], "default": "all" } }, { "name": "contentFilter", "in": "query", "required": false, "description": "Keep only messages with this attachment. Videos are rare; All keeps every message.", "schema": { "type": "string", "enum": [ "all", "links", "charts", "videos" ], "default": "all" } }, { "name": "sentimentFilter", "in": "query", "required": false, "description": "Keep posts by the author's self-tagged sentiment. Most posts are untagged; Any keeps all.", "schema": { "type": "string", "enum": [ "any", "bullish", "bearish", "tagged" ], "default": "any" } }, { "name": "onlyPriceTargets", "in": "query", "required": false, "description": "Keep only messages where the author attached a StockTwits price prediction (price target).", "schema": { "type": "boolean", "default": false } }, { "name": "feedType", "in": "query", "required": false, "description": "Trending = market-wide trending posts; Suggested = posts from StockTwits' curated suggested traders; All = public market-wide firehose (deep, chronological).", "schema": { "type": "string", "enum": [ "trending", "suggested", "all" ], "default": "trending" } }, { "name": "trendingAssetClass", "in": "query", "required": false, "description": "Which trending instruments to keep. All includes stocks, ETFs, crypto, ADRs, commodities, and other classes.", "schema": { "type": "string", "enum": [ "all", "stocks", "etf", "crypto", "adr", "commodity" ], "default": "all" } }, { "name": "sentimentRange", "in": "query", "required": false, "description": "Now = current sentiment across 15m, 24h, now, 1D–ALL. Other values return the daily/intraday history for that window.", "schema": { "type": "string", "enum": [ "now", "1D", "1W", "1M", "3M", "6M", "1Y", "5Y", "ALL" ], "default": "now" } }, { "name": "chartZoom", "in": "query", "required": false, "description": "Intraday windows use 5-minute (1D) or 30-minute (1W) bars; other windows use daily/weekly bars.", "schema": { "type": "string", "enum": [ "1D", "1W", "1M", "3M", "6M", "YTD", "1Y", "5Y", "ALL" ], "default": "1M" } }, { "name": "includeUserProfile", "in": "query", "required": false, "description": "Add one profile record per username before that trader's posts.", "schema": { "type": "boolean", "default": false } }, { "name": "includeRelatedSymbols", "in": "query", "required": false, "description": "Add StockTwits' related-industry tickers to each symbol record.", "schema": { "type": "boolean", "default": false } }, { "name": "newerThanMessageId", "in": "query", "required": false, "description": "Only keep messages with an ID greater than this. Useful for incremental scheduled runs.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "olderThanMessageId", "in": "query", "required": false, "description": "Start from messages at or below this ID and page further back.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "messageIds", "in": "query", "required": false, "description": "Message IDs or StockTwits message URLs whose parent + reply thread should be fetched. (GET: repeat the parameter once per value.)", "schema": { "type": "array", "default": [], "items": { "type": "string" }, "maxItems": 20 }, "style": "form", "explode": true }, { "name": "maxItems", "in": "query", "required": false, "description": "Per ticker/username/query/thread for target modes; total for trending and market feeds; max points or bars for history modes.", "schema": { "type": "integer", "default": 30, "minimum": 1, "maximum": 50 }, "example": 3 } ], "responses": { "200": { "description": "The results as a JSON array (at most 50). They are also saved to the run's dataset and billed per result, like a normal run.", "headers": { "X-Item-Count": { "schema": { "type": "integer" }, "description": "Results returned." }, "X-Status-Message": { "schema": { "type": "string" }, "description": "The Actor's last status message, e.g. why nothing was found." } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "example": [ { "messageId": 668680983, "body": "$AAPL Update | 10:30 AM ET \n \nThe 10:25 candle is showing early signs of a potential reversal. \n \nHigher low: $346.80 \nHigher high: $347.33 \nVolume: +6.1% vs...", "createdAt": "2026-11-10T15:33:18Z", "isDiscussion": false, "prices": [ { "symbol": "AAPL", "price": 347.24 } ], "symbols": [ "AAPL" ], "symbol": "AAPL", "cashtags": [ { "symbol": "AAPL", "title": "Apple Inc", "exchange": "NASDAQ", "instrumentClass": "Stock", "watchlistCount": 1000981, "price": 347.24, "sentimentChange": 0.32, "volumeChange": -49.41 } ], "priceAtPost": 347.24, "userId": 4521122, "username": "Invescent", "userDisplayName": "Invescent", "userFollowers": 486, "userFollowing": 1, "userIdeas": 59823, "userJoinDate": "2021-01-05", "userOfficial": false, "userIdentity": "User", "userClassification": [ "plus" ], "userHomeCountry": "US", "userLikeCount": 51, "userWatchlistCount": 72, "userTradeStatus": "PENDING_MFA", "userAvatarUrl": "https://avatars.stocktwits-cdn.com/production/4521122/thumb-1609914640.png", "userAvatarUrlOriginal": "https://avatars.stocktwits.com/production/4521122/thumb-1609914640.png", "stocktwitsUserUrl": "https://stocktwits.com/Invescent", "isReshare": true, "source": "StockTwits Web", "sourceUrl": "https://stocktwits.com", "stocktwitsUrl": "https://stocktwits.com/Invescent/message/668680983", "recordType": "message", "scrapedAt": "2026-11-10T15:34:24.320107+00:00" } ] } } }, "400": { "description": "Invalid, missing or unknown input fields. Nothing ran.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": "invalid_input", "errorDescription": "mode: required" } } } }, "422": { "description": "The Actor could not complete this request (for example, nothing matches). No results were delivered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected failure. Safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The request used up its 240 s budget. The results found so far are in partialItems.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "partialItems": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } ] } } } } } }, "post": { "operationId": "lookupPost", "summary": "Run one lookup (JSON body)", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "symbolMessages", "userMessages", "trendingSymbols", "marketMessages", "symbolSentiment", "symbolOverview", "priceHistory", "search", "conversation", "trendingMessages", "symbolSearch" ], "default": "symbolMessages", "description": "What to fetch from StockTwits." }, "symbols": { "type": "array", "default": [ "AAPL" ], "items": { "type": "string" }, "maxItems": 5, "description": "Tickers to fetch, e.g. AAPL, TSLA, BTC.X, BRK.B, SHOP.TSX. Accepts $cashtags and StockTwits symbol URLs. Use .X for crypto." }, "usernames": { "type": "array", "default": [], "items": { "type": "string" }, "maxItems": 5, "description": "StockTwits usernames without @, or profile URLs, e.g. KirRoyalTrader, https://stocktwits.com/Fibonaccino." }, "searchQueries": { "type": "array", "default": [], "items": { "type": "string" }, "maxItems": 3, "description": "Company names, tickers, or trader names to search for, e.g. tesla, apple, TraderLion." }, "searchType": { "type": "string", "enum": [ "all", "symbols", "users" ], "default": "all", "description": "What to return from each query." }, "streamFilter": { "type": "string", "enum": [ "all", "top", "trending" ], "default": "all", "description": "All = newest first, Top = StockTwits ranking, Trending = curated high-engagement posts for the ticker (up to 100)." }, "contentFilter": { "type": "string", "enum": [ "all", "links", "charts", "videos" ], "default": "all", "description": "Keep only messages with this attachment. Videos are rare; All keeps every message." }, "sentimentFilter": { "type": "string", "enum": [ "any", "bullish", "bearish", "tagged" ], "default": "any", "description": "Keep posts by the author's self-tagged sentiment. Most posts are untagged; Any keeps all." }, "onlyPriceTargets": { "type": "boolean", "default": false, "description": "Keep only messages where the author attached a StockTwits price prediction (price target)." }, "feedType": { "type": "string", "enum": [ "trending", "suggested", "all" ], "default": "trending", "description": "Trending = market-wide trending posts; Suggested = posts from StockTwits' curated suggested traders; All = public market-wide firehose (deep, chronological)." }, "trendingAssetClass": { "type": "string", "enum": [ "all", "stocks", "etf", "crypto", "adr", "commodity" ], "default": "all", "description": "Which trending instruments to keep. All includes stocks, ETFs, crypto, ADRs, commodities, and other classes." }, "sentimentRange": { "type": "string", "enum": [ "now", "1D", "1W", "1M", "3M", "6M", "1Y", "5Y", "ALL" ], "default": "now", "description": "Now = current sentiment across 15m, 24h, now, 1D–ALL. Other values return the daily/intraday history for that window." }, "chartZoom": { "type": "string", "enum": [ "1D", "1W", "1M", "3M", "6M", "YTD", "1Y", "5Y", "ALL" ], "default": "1M", "description": "Intraday windows use 5-minute (1D) or 30-minute (1W) bars; other windows use daily/weekly bars." }, "includeUserProfile": { "type": "boolean", "default": false, "description": "Add one profile record per username before that trader's posts." }, "includeRelatedSymbols": { "type": "boolean", "default": false, "description": "Add StockTwits' related-industry tickers to each symbol record." }, "newerThanMessageId": { "type": "integer", "minimum": 0, "description": "Only keep messages with an ID greater than this. Useful for incremental scheduled runs." }, "olderThanMessageId": { "type": "integer", "minimum": 0, "description": "Start from messages at or below this ID and page further back." }, "messageIds": { "type": "array", "default": [], "items": { "type": "string" }, "maxItems": 20, "description": "Message IDs or StockTwits message URLs whose parent + reply thread should be fetched." }, "maxItems": { "type": "integer", "default": 30, "minimum": 1, "maximum": 50, "description": "Per ticker/username/query/thread for target modes; total for trending and market feeds; max points or bars for history modes." } }, "additionalProperties": false, "required": [ "mode" ] }, "example": { "mode": "symbolMessages", "symbols": [ "AAPL" ], "maxItems": 3 } } } }, "responses": { "200": { "description": "The results as a JSON array (at most 50). They are also saved to the run's dataset and billed per result, like a normal run.", "headers": { "X-Item-Count": { "schema": { "type": "integer" }, "description": "Results returned." }, "X-Status-Message": { "schema": { "type": "string" }, "description": "The Actor's last status message, e.g. why nothing was found." } }, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "example": [ { "messageId": 668680983, "body": "$AAPL Update | 10:30 AM ET \n \nThe 10:25 candle is showing early signs of a potential reversal. \n \nHigher low: $346.80 \nHigher high: $347.33 \nVolume: +6.1% vs...", "createdAt": "2026-11-10T15:33:18Z", "isDiscussion": false, "prices": [ { "symbol": "AAPL", "price": 347.24 } ], "symbols": [ "AAPL" ], "symbol": "AAPL", "cashtags": [ { "symbol": "AAPL", "title": "Apple Inc", "exchange": "NASDAQ", "instrumentClass": "Stock", "watchlistCount": 1000981, "price": 347.24, "sentimentChange": 0.32, "volumeChange": -49.41 } ], "priceAtPost": 347.24, "userId": 4521122, "username": "Invescent", "userDisplayName": "Invescent", "userFollowers": 486, "userFollowing": 1, "userIdeas": 59823, "userJoinDate": "2021-01-05", "userOfficial": false, "userIdentity": "User", "userClassification": [ "plus" ], "userHomeCountry": "US", "userLikeCount": 51, "userWatchlistCount": 72, "userTradeStatus": "PENDING_MFA", "userAvatarUrl": "https://avatars.stocktwits-cdn.com/production/4521122/thumb-1609914640.png", "userAvatarUrlOriginal": "https://avatars.stocktwits.com/production/4521122/thumb-1609914640.png", "stocktwitsUserUrl": "https://stocktwits.com/Invescent", "isReshare": true, "source": "StockTwits Web", "sourceUrl": "https://stocktwits.com", "stocktwitsUrl": "https://stocktwits.com/Invescent/message/668680983", "recordType": "message", "scrapedAt": "2026-11-10T15:34:24.320107+00:00" } ] } } }, "400": { "description": "Invalid, missing or unknown input fields. Nothing ran.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "example": { "error": "invalid_input", "errorDescription": "mode: required" } } } }, "422": { "description": "The Actor could not complete this request (for example, nothing matches). No results were delivered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected failure. Safe to retry.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The request used up its 240 s budget. The results found so far are in partialItems.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Error" }, { "type": "object", "properties": { "partialItems": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } } } } ] } } } } } } } }, "components": { "schemas": { "Item": { "type": "object", "description": "One result, the same record a normal run saves to its dataset.", "properties": { "messageId": { "type": "integer" }, "body": { "type": "string" }, "createdAt": { "type": "string" }, "isDiscussion": { "type": "boolean" }, "prices": { "type": "array", "items": { "type": "object" } }, "symbols": { "type": "array", "items": { "type": "string" } }, "symbol": { "type": "string" }, "cashtags": { "type": "array", "items": { "type": "object" } }, "priceAtPost": { "type": "number" }, "userId": { "type": "integer" }, "username": { "type": "string" }, "userDisplayName": { "type": "string" }, "userFollowers": { "type": "integer" }, "userFollowing": { "type": "integer" }, "userIdeas": { "type": "integer" }, "userJoinDate": { "type": "string" }, "userOfficial": { "type": "boolean" }, "userIdentity": { "type": "string" }, "userClassification": { "type": "array", "items": { "type": "string" } }, "userHomeCountry": { "type": "string" }, "userLikeCount": { "type": "integer" }, "userWatchlistCount": { "type": "integer" }, "userTradeStatus": { "type": "string" }, "userAvatarUrl": { "type": "string" }, "userAvatarUrlOriginal": { "type": "string" }, "stocktwitsUserUrl": { "type": "string" }, "isReshare": { "type": "boolean" }, "source": { "type": "string" }, "sourceUrl": { "type": "string" }, "stocktwitsUrl": { "type": "string" }, "recordType": { "type": "string" }, "scrapedAt": { "type": "string" } }, "example": { "messageId": 668680983, "body": "$AAPL Update | 10:30 AM ET \n \nThe 10:25 candle is showing early signs of a potential reversal. \n \nHigher low: $346.80 \nHigher high: $347.33 \nVolume: +6.1% vs...", "createdAt": "2026-11-10T15:33:18Z", "isDiscussion": false, "prices": [ { "symbol": "AAPL", "price": 347.24 } ], "symbols": [ "AAPL" ], "symbol": "AAPL", "cashtags": [ { "symbol": "AAPL", "title": "Apple Inc", "exchange": "NASDAQ", "instrumentClass": "Stock", "watchlistCount": 1000981, "price": 347.24, "sentimentChange": 0.32, "volumeChange": -49.41 } ], "priceAtPost": 347.24, "userId": 4521122, "username": "Invescent", "userDisplayName": "Invescent", "userFollowers": 486, "userFollowing": 1, "userIdeas": 59823, "userJoinDate": "2021-01-05", "userOfficial": false, "userIdentity": "User", "userClassification": [ "plus" ], "userHomeCountry": "US", "userLikeCount": 51, "userWatchlistCount": 72, "userTradeStatus": "PENDING_MFA", "userAvatarUrl": "https://avatars.stocktwits-cdn.com/production/4521122/thumb-1609914640.png", "userAvatarUrlOriginal": "https://avatars.stocktwits.com/production/4521122/thumb-1609914640.png", "stocktwitsUserUrl": "https://stocktwits.com/Invescent", "isReshare": true, "source": "StockTwits Web", "sourceUrl": "https://stocktwits.com", "stocktwitsUrl": "https://stocktwits.com/Invescent/message/668680983", "recordType": "message", "scrapedAt": "2026-11-10T15:34:24.320107+00:00" } }, "Error": { "type": "object", "required": [ "error", "errorDescription" ], "properties": { "error": { "type": "string", "enum": [ "invalid_input", "request_failed", "internal_error", "timeout", "busy", "not_found", "method_not_allowed", "payload_too_large" ] }, "errorDescription": { "type": "string" } } } }, "securitySchemes": { "apifyToken": { "type": "http", "scheme": "bearer", "description": "Your Apify API token (Apify Console, Settings, API and integrations)." } } }, "servers": [ { "url": "https://dataspryva--stocktwits-ticker-sentiment-and-trending-symbol.apify.actor" } ], "security": [ { "apifyToken": [] } ] }