Tools
LiveSensitiveSpends creditsScore an X account against the ranking signals
/data-api/v2/tools/algorithm-score- Scope
- tools:use
- Freshness
- live read
- Group
- Tools
- Platforms
- 1 of 7
What this endpoint answers
Grades an account 0-100 on the five behaviours X's ranking model rewards: bookmark power, conversation spark, virality factor, reach efficiency and account authority. Each category returns its score, the raw measurement behind it and how that measurement should be read.
This is a live read: it goes to the platform at request time, returns cache_age_s = 0, and is metered against a separate live-per-minute bucket on top of your tier. It needs the tools:use scope (Tools): Run the analysis tools: valuation, follower audit, scoring, and more.
Good to know
- Costs money: this endpoint bills twitterapi.io credits per call. Metered as a live call.
- Returns 503 not_configured when TWITTERAPI_IO_KEY is unset, and 502 upstream_error when the credit pool is exhausted or the upstream fails. It never returns an empty 200.
- Ignores NEXT_PUBLIC_USE_MOCK_DATA: the X tools always read live data and have no mock path.
- The website's captcha and per-visitor daily caps do not apply here; your API key's tier limits do.
- A category can come back with metric.kind = "unavailable" when the upstream did not return the inputs for it (view counts are the usual gap). Its score is then excluded rather than guessed.
- This is a model of the public ranking signals, not X's actual ranker.
Parameters
This endpoint takes no path or query parameters.
Request body
handlestringrequiredX handle. Accepts a bare name, @name, or a profile URL. Also accepted as `username`.
{
"handle": "elonmusk"
}
Call it
Authenticate with a bearer token or the x-api-key header. Keys are server-to-server credentials. Never embed one in front-end code - call the API from your own backend and forward the result.
curl -X POST "https://crmsolid.com/data-api/v2/tools/algorithm-score" \
-H "Authorization: Bearer psk_live_..." \
-H "Content-Type: application/json" \
-d '{"handle":"elonmusk"}'
const res = await fetch("https://crmsolid.com/data-api/v2/tools/algorithm-score", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"handle": "elonmusk"
}),
});
if (!res.ok) {
const { error } = await res.json();
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const { data, meta } = await res.json();
import json
import os
import requests
body = json.loads("""
{
"handle": "elonmusk"
}
""")
res = requests.post(
"https://crmsolid.com/data-api/v2/tools/algorithm-score",
headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
json=body,
timeout=30,
)
res.raise_for_status()
payload = res.json()
data, meta = payload["data"], payload["meta"]
Keys look like psk_live_... for production keys, psk_test_... for test keys and are minted in the panel.
What comes back
Success is { data, meta }. Failure is { error: { code, message, request_id } }. The body below is the spec's own example: the values in it are illustrative readings, not live numbers.
- Profile handle
- dhh
- Profile twitter id
- 5943622
- Profile name
- DHH
- Profile avatar url
- https://pbs.twimg.com/profile_images/1734635298264395776/8Xw2fPQK.jpg
- Profile verified
- yes
- Profile followers
- 582,104
- Profile following
- 412
- Profile total posts
- 54,120
- Profile created at
- 5/14/2007, 2:12:44 AM
- Profile account age days
- 6,976
- Overall score
- 71
- Tier name
- Amplified
- Tier min
- 70
- Tier max
- 84
- Tier description
- The algorithm actively pushes this account beyond its follower base.
- Categories
- 3 items
- Averages avg views
- 214,000
- Averages avg likes
- 3,120
- Averages avg bookmarks
- 180
- Averages avg replies
- 304
- Averages avg retweets
- 288
- Averages avg quotes
- 61
- Posts analyzed
- 20
- Checked at
- 8/23/2026, 9:20:41 AM
{
"data": {
"profile": {
"handle": "dhh",
"twitter_id": "5943622",
"name": "DHH",
"avatar_url": "https://pbs.twimg.com/profile_images/1734635298264395776/8Xw2fPQK.jpg",
"verified": true,
"followers": 582104,
"following": 412,
"total_posts": 54120,
"created_at": "2007-05-14T02:12:44.000Z",
"account_age_days": 6976
},
"overall_score": 71,
"tier": {
"name": "Amplified",
"min": 70,
"max": 84,
"description": "The algorithm actively pushes this account beyond its follower base."
},
"categories": [
{
"key": "bookmark_power",
"score": 64,
"value": 0.084,
"metric": {
"kind": "rate",
"fraction_digits": 3
},
"label": "Bookmark power",
"description": "Bookmarks per view. The strongest single quality signal X tracks."
},
{
"key": "conversation_spark",
"score": 82,
"value": 0.142,
"metric": {
"kind": "rate",
"fraction_digits": 3
},
"label": "Conversation spark",
"description": "Replies per view. Rewarded heavily; reply chains extend distribution."
},
{
"key": "account_authority",
"score": 88,
"value": 22,
"metric": {
"kind": "score",
"out_of": 25
},
"label": "Account authority",
"description": "Age, verification and follower-to-following ratio combined."
}
],
"averages": {
"avg_views": 214000,
"avg_likes": 3120,
"avg_bookmarks": 180,
"avg_replies": 304,
"avg_retweets": 288,
"avg_quotes": 61
},
"posts_analyzed": 20,
"checked_at": "2026-08-23T09:20:41.204Z"
},
"meta": {
"request_id": "req_9f2c41a8b3d5",
"generated_at": "2026-08-23T09:14:02.317Z",
"took_ms": 42,
"cache_age_s": 0
}
}
The meta block
request_idstringrequiredUnique id for this request. Quote it in a support ticket.
generated_atstringrequiredServer time the response was produced.
took_msintegerrequiredMilliseconds spent server-side.
pagePageoptionalsourcestringoptionalWhich backend served the payload, for endpoints with more than one.
cache_age_sintegeroptionalAge of the underlying data in seconds. 0 for live reads.
When it fails
POST /tools/algorithm-score documents 7 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.
- 401Unauthorized
unauthorized | invalid_keyNo key was presented, or the key is unknown, revoked or expired.
- 402PaymentRequired
payment_required | subscription_inactiveThe key is valid but the plan behind it cannot serve the call: the included requests are spent and overage is switched off, capped or unfunded (payment_required), or the billing period lapsed and was not renewed (subscription_inactive). Retrying does not help; paying does. The X-Plan-* headers on this response say how far past the line you are.
Carries X-Plan, X-Plan-Limit, X-Plan-Overage, X-Plan-Period-End, X-Plan-Remaining.
- 403Forbidden
forbidden_scope | forbidden_ipThe key is valid but not allowed to make this call: it lacks the scope, or the request came from an address outside the key's allowlist.
- 422InvalidRequest
invalid_requestA parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.
- 429RateLimited
rate_limited | quota_exceededEither the burst ceiling for the current minute or the daily quota is spent. Distinguish with the code: rate_limited clears within the minute, quota_exceeded does not clear until 00:00 UTC.
Carries Retry-After, X-Quota-Limit, X-Quota-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Request-Id.
- 500InternalError
internal_errorSomething failed on our side. Internals are never leaked; quote the request id.
- 503Unavailable
upstream_timeout | upstream_error | not_configuredThe request could not be served right now. BRANCH ON error.code, not on the status: 'upstream_timeout' means a source was too slow (this is what a catalog query hitting its 15-second statement timeout returns, so it is reachable from any endpoint that reads the corpus, not only the live-scrape ones) and the same call is worth retrying with backoff - narrowing it with a smaller limit, a filtered scope or a less popular account makes it far less likely; 'upstream_error' means a source was unreachable, so back off further; 'not_configured' means the capability has no backing service in this deployment, and retrying will never help.
Every response carries X-Request-Id and meta.request_id. Quote it in support requests.
Coverage and limits
This endpoint covers X. Rate limits come from the tier on your key.
| Tier | Requests a minute | Requests a day | Live reads a minute |
|---|---|---|---|
| free | 30 | 1,000 | 5 |
| standard | 120 | 25,000 | 20 |
| pro | 600 | 250,000 | 60 |
| unlimited | 6,000 | 10,000,000 | 600 |
Live reads count against the live column as well as the ordinary one, so a burst of them runs out of the live bucket first. Every response reports where you stand in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and the X-Plan headers.
Start calling it
A key takes a minute to mint in the panel, no card. The reference covers authentication, the envelope, scopes, rate limits and every error code in one page.
Reference path: /data-api/reference/tools-algorithm-score