/stocktwits/symbols

POST /api/stocktwits/symbols

Price: 1 credit

Get a symbol with its community message stream

How to use it

Get a stock or crypto symbol's Stocktwits stream by ticker. Returns the symbol (name, exchange, region, watchlist count) plus community messages, each with text, author, cashtags, links, bullish/bearish sentiment, and reply count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• symbol string required — Ticker symbol (examples: "AAPL", "TSLA", "NVDA"; minLength: 1)
• filter string nullable — Restrict the stream to a message subset (one of: "top", "links", "charts")
• count integer required — Max number of messages to return (examples: 30; min: 1)

Response

• @type string (default: "StocktwitsSymbolStream")
• id integer required
• symbol string required
• name string nullable
• exchange string nullable
• region string nullable
• instrument_class string nullable
• image string nullable
• watchlist_count integer nullable
• messages array (default: [])
  • @type string (default: "StocktwitsMessage")
  • id integer required
  • text string nullable
  • created_at string nullable
  • source string nullable
  • sentiment string nullable
  • user object nullable
    • @type string (default: "StocktwitsUser")
    • id integer required
    • alias string required
    • name string nullable
    • image string nullable
    • identity string nullable
    • home_country string nullable
    • joined_at string nullable
    • follower_count integer nullable
    • following_count integer nullable
    • idea_count integer nullable
    • watchlist_stock_count integer nullable
    • like_count integer nullable
    • is_official boolean (default: false)
  • symbols array (default: [])
    • @type string (default: "StocktwitsSymbol")
    • id integer required
    • symbol string required
    • name string nullable
    • exchange string nullable
    • region string nullable
    • instrument_class string nullable
    • image string nullable
    • watchlist_count integer nullable
  • mentioned_users array (default: [])
  • links array (default: [])
    • @type string (default: "StocktwitsLink")
    • url string nullable
    • description string nullable
    • image string nullable
    • created_at string nullable
    • source string nullable
  • media array (default: [])
    • @type string (default: "StocktwitsMedia")
    • type string nullable
    • url string nullable
    • thumb string nullable
    • width integer nullable
    • height integer nullable
    • provider string nullable
  • prices array (default: [])
    • @type string (default: "StocktwitsMessagePrice")
    • symbol string required
    • price string nullable
  • reply_count integer nullable
  • reshare_count integer nullable
  • is_reshare boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Symbol not found. Verify the ticker. Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.