Analyze a single X post: POST /tools/tweet-analyzer

What this endpoint answers

Breaks one post down: raw metrics, engagement rate against views (or followers when view counts are missing), a 0-100 virality score with a grade, the composition of engagement by interaction type, amplification and save rates, and a sample of the accounts that retweeted it with their combined reach.

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: 2 twitterapi.io calls per request (the post, then its retweeters). Metered as a live call.
Returns 503 not_configured when TWITTERAPI_IO_KEY is unset, 404 not_found for a deleted or protected post, and 502 upstream_error when the upstream fails.
engagement_basis tells you the denominator. Older posts often have no view count, and the rate then falls back to followers, which is not comparable across posts.
retweeters.top is a sample of the first page, not the full amplifier list.

Parameters

This endpoint takes no path or query parameters.

Request body

tweetstringrequired
Numeric post id or a full x.com/<user>/status/<id> URL. Also accepted as `tweet_url` or `tweet_id`.

Example request body

{
  "tweet": "https://x.com/naval/status/1002103360646823936"
}

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

curl -X POST "https://crmsolid.com/data-api/v2/tools/tweet-analyzer" \
  -H "Authorization: Bearer psk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"tweet":"https://x.com/naval/status/1002103360646823936"}'

JavaScript

const res = await fetch("https://crmsolid.com/data-api/v2/tools/tweet-analyzer", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "tweet": "https://x.com/naval/status/1002103360646823936"
  }),
});

if (!res.ok) {
  const { error } = await res.json();
  throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}

const { data, meta } = await res.json();

Python

import json
import os

import requests

body = json.loads("""
{
  "tweet": "https://x.com/naval/status/1002103360646823936"
}
""")

res = requests.post(
    "https://crmsolid.com/data-api/v2/tools/tweet-analyzer",
    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.

Post id: 1002103360646823936
Post url: https://x.com/naval/status/1002103360646823936
Post text: How to Get Rich (without getting lucky):
Post created at: 5/31/2018, 1:52:11 PM
Author id: 745273
Author handle: naval
Author name: Naval
Author avatar url: https://pbs.twimg.com/profile_images/1256841238298292232/ycqwaMI2.jpg
Author followers: 2,418,702
Author verified: yes
Metrics likes: 128,400
Metrics retweets: 34,120
Metrics replies: 4,210
Metrics quotes: 2,840
Metrics views: 18,400,000
Metrics bookmarks: 61,200
Metrics total engagement: 230,770
Engagement rate: 1.254
Engagement basis: views
Virality score: 94
Virality grade: viral
Composition like share: 55.6
Composition retweet share: 14.8
Composition reply share: 1.8
Composition quote share: 1.2
Composition bookmark share: 26.5
Amplification rate: 16
Save rate: 26.5

200 POST /tools/tweet-analyzer

{
  "data": {
    "post": {
      "id": "1002103360646823936",
      "url": "https://x.com/naval/status/1002103360646823936",
      "text": "How to Get Rich (without getting lucky):",
      "created_at": "2018-05-31T13:52:11.000Z"
    },
    "author": {
      "id": "745273",
      "handle": "naval",
      "name": "Naval",
      "avatar_url": "https://pbs.twimg.com/profile_images/1256841238298292232/ycqwaMI2.jpg",
      "followers": 2418702,
      "verified": true
    },
    "metrics": {
      "likes": 128400,
      "retweets": 34120,
      "replies": 4210,
      "quotes": 2840,
      "views": 18400000,
      "bookmarks": 61200,
      "total_engagement": 230770
    },
    "engagement_rate": 1.254,
    "engagement_basis": "views",
    "virality_score": 94,
    "virality_grade": "viral",
    "composition": {
      "like_share": 55.6,
      "retweet_share": 14.8,
      "reply_share": 1.8,
      "quote_share": 1.2,
      "bookmark_share": 26.5
    },
    "amplification_rate": 16,
    "save_rate": 26.5,
    "views_per_follower": 7.6,
    "retweeters": {
      "sampled": 100,
      "combined_reach": 4820140,
      "top": [
        {
          "handle": "balajis",
          "name": "Balaji",
          "avatar_url": "https://pbs.twimg.com/profile_images/1626469429208670209/kL0Kbn8L.jpg",
          "followers": 1042800,
          "verified": true
        }
      ]
    }
  },
  "meta": {
    "request_id": "req_9f2c41a8b3d5",
    "generated_at": "2026-08-23T09:14:02.317Z",
    "took_ms": 42,
    "cache_age_s": 0
  }
}

The meta block

request_idstringrequired
Unique id for this request. Quote it in a support ticket.
generated_atstringrequired
Server time the response was produced.
took_msintegerrequired
Milliseconds spent server-side.
pagePageoptional
sourcestringoptional
Which backend served the payload, for endpoints with more than one.
cache_age_sintegeroptional
Age of the underlying data in seconds. 0 for live reads.

When it fails

POST /tools/tweet-analyzer documents 7 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.

401Unauthorizedunauthorized | invalid_key
No key was presented, or the key is unknown, revoked or expired.
402PaymentRequiredpayment_required | subscription_inactive
The 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.
403Forbiddenforbidden_scope | forbidden_ip
The 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.
422InvalidRequestinvalid_request
A parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.
429RateLimitedrate_limited | quota_exceeded
Either 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.
500InternalErrorinternal_error
Something failed on our side. Internals are never leaked; quote the request id.
503Unavailableupstream_timeout | upstream_error | not_configured
The 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.

X

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.

The rest of the Tools group

The analysis tools behind the public free-tool pages, callable directly: valuation, follower audit, scoring and the rest. Metered like a live call, because each run costs compute or an upstream fetch.

Other groups

Accounts Directory X People Live scrape Insights Trends Identity Graph Watch Research Leads

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.

Get a key All 127 endpoints Full reference What the Data API is

Reference path: /data-api/reference/tools-tweet-analyzer