API ReferenceSocial Sentiment
X/Twitter sentiment
/api/v3/research/x_sentiment- Plan
- Pro and up
- Price
- 1,000 credits per call
- MCP tool
research_x_ sentiment
Real-time X/Twitter sentiment narrative. Pass ticker=NVDA for a focused fintwit read on a name, or query=... for a free-form social-media question. Returns a model-written narrative (is_model_output true) and any source URLs it grounded against; grounded says whether the model searched X. There is no structured bullish/bearish ratio, and prices, moves and counts in the text are not checked against market data: quote numbers from the market-data tools. Use when you want the vibe on a name right now (retail sentiment, breaking rumours, unusual social activity), not the news article list. When the provider does not answer it returns 503 upstream_unavailable (error_code social_sentiment_unavailable; not billed). Pro and above, 1,000 credits a call: each answer runs a live grounded search, and a repeat of the same ticker or query within 5 minutes is served from that answer and billed the same.
Parameters
Query
tickerstringOptionalOptional ticker for ticker-targeted sentiment. Send at least one of ticker or query: the call is refused without it.
querystringOptionalOptional free-form query. Pass ticker OR query — at least one is required. Send at least one of ticker or query: the call is refused without it.
Response
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see LLM Research). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.
A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.
Errors
No error is billed. The body is { "ok": false, "error", "detail", "request_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed. |
401 unauthorized | Missing or invalid API key. |
402 plan_required | Your plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed. |
403 scope_denied | This API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed. |
404 unknown_ticker | No data source lists this ticker, active or delisted: the market-data listing and the security master both say it does not exist. param names the parameter. Not billed. Best-effort: it is answered only when the route itself found nothing, and after 20 lookups of new symbols per API key per minute the route's own answer stands. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The request ran past the server's time budget; retry. Not billed. |
This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.