POST https://xquik.com/api/v1/x/analysis/market-signals
2 credits per analyzed post · All plans from $0.00012/credit · Supports guest paid reads
POST /api/v1/x/analysis/market-signals.
The summary counts bullish and bearish posts per cashtag. Name the asset in
analysis.targets.
Name the asset
Put the asset inanalysis.targets, with its ticker and other names as
aliases. A post mentions the target when its text contains the name or an
alias. Letter case does not matter.relevance says whether a post discusses the target as an asset, position,
or price. Posts about the wider market, competitors, or suppliers do not
count. Neither does a ticker in a list of tags.
Filter rows on relevance before you count stances. The snippets keep posts
from 0.5.Read the market answers
results[].answers holds each decision by question ID.stance classifies the author’s own view, not quoted views or ads.conviction judges how firmly the text states the stance, not engagement or
follower counts. A post with no stance on the target scores 0. The score can
have decimals. For example, 1.6 is between a reasoned view and a firm call.
The answers describe what posts say, not whether claims are true. They are not
investment advice.Read the signal per cashtag
analysisSummary.cashtags lists up to 20 cashtags, most posts first. Each entry
has rows, the category counts in choices, and signal.
signal holds bullish and bearish post counts and a score from -1 to
1. The score is bullish minus bearish posts, divided by the cashtag’s posts.
results[].cashtags lists the cashtags in each post’s text, in upper case. A
post with 2 cashtags counts toward both.
analysisSummary.targets counts the posts that mention each target, with their
category counts.Pick the posts to analyze
SendtweetIds, texts, a page, or a search, never more than 1. See pick the posts to analyze for each source.query takes cashtags and operators, such as $NVDA lang:en. Send username
to read 1 trader’s or analyst’s posts.Compare with an earlier answer
Send theresults of an earlier call as baseline to see what changed. The comparison costs nothing extra. See compare with an earlier answer for an example.Budget the analysis
Each analyzed post costs 2 credits. Each text intexts costs the same. Posts in unanalyzed cost nothing. See budget the analysis for each reason.Body
See body parameters for every field. Common ones aretweetIds, texts, query, username, and limit.Headers
Response
200 OK
400 Invalid input
{ "error": "invalid_input", "message": "Send tweetIds, texts, or a search such as query or username." }
The body names no posts or names more than 1 source. A body with an invalid field gets the same error.
The message says what to send instead. The request costs nothing.401 Unauthenticated
Anonymous requests getWWW-Authenticate: Bearer and a guest wallet checkout action. This is not a Payment challenge.
Missing or invalid API key. Check the x-api-key header value.402 Payment required
Full account keys can receiveno_subscription, subscription_inactive, no_credits, or insufficient_credits with account payment options. Guest keys receive only the guest top-up action.
The failed request creates no checkout. Ask the user to confirm before calling any checkout or top-up route.403 Protected account
{ "error": "x_account_protected" }
A search that needs a protected author returns this. Choose a public account.
The request costs nothing.502 X API unavailable
The read service returned an error. Retry after a short delay.503 Service busy
Xquik is busy. Wait for theRetry-After header, then send the request again.
The request costs nothing.429 Rate limit exceeded
You exceeded your tier rate limit. Wait for theRetry-After header before retrying.424 Dependency failed
The normalized v1 response contract can return 424 when the read service is unavailable.Stock & crypto sentiment API questions
How do I get the sentiment of a stock or coin on X?
Search its cashtag inquery and name it in analysis.targets. Each row in
results holds the post’s stance. analysisSummary.cashtags counts
bullish and bearish posts.What does the cashtag score mean?
signal.score is bullish minus bearish posts, divided by the cashtag’s posts.
1 means every post is bullish, and -1 means every post is bearish.How do I drop spam and shilling?
Skip rows whosecontent is promotion, and keep rows with high relevance.
That drops signal groups, ads, and tickers used as tags.Does it work for crypto?
Yes. Name the coin inanalysis.targets, such as Bitcoin with the alias
BTC. Cashtags like $BTC count in analysisSummary.cashtags.How much do market signals cost?
Each analyzed post costs 2 credits. Posts inunanalyzed and refused requests
cost nothing.Does this replace X’s official API?
No. This page documents Xquik, an independent third-party service. It does not document X’s official API.Next steps. Sentiment analysis reads the general attitude of posts. Search Tweets previews the posts a query returns.
Response examples
- 400
{ "error": "invalid_input", "message": "Invalid input. Check the request body." } - 401
{ "error": "unauthenticated", "message": "Authentication required." } - 402
{ "error": "insufficient_credits", "message": "Insufficient credits. Top up or subscribe to continue." } - 403
{ "error": "api_key_paused", "message": "This API key is paused. Resume it at dashboard.xquik.com/api-keys to use it again." } - 424
{ "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." } - 429
{ "error": "rate_limit_exceeded", "message": "Too many requests. Try again later.", "retryAfter": 60 } - 502
{ "error": "x_api_unavailable", "message": "X data source temporarily unavailable. Try again later." } - 503
{ "error": "x_api_unavailable", "message": "Xquik is busy right now. Retry shortly." }