Tools
LiveSensitiveSpends creditsSee who is mentioning an X account
/data-api/v2/tools/mention-checker- Scope
- tools:use
- Freshness
- live read
- Group
- Tools
- Platforms
- 1 of 7
What this endpoint answers
Pulls recent public mentions of a handle and aggregates them: how many, from how many distinct accounts, how many of those are verified, the combined follower reach behind them, and the single highest-engagement mention and highest-reach mentioner.
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. Metered as a live call.
- Returns 503 not_configured when TWITTERAPI_IO_KEY is unset and 502 upstream_error when the upstream fails.
- Only recent public mentions are visible to the upstream. An account with no recent mentions returns 422 invalid_request rather than an empty success, so a silent zero is never mistaken for a working query.
- combined_reach sums the mentioners' follower counts. It double counts overlapping audiences and is an upper bound, not impressions.
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/mention-checker" \
-H "Authorization: Bearer psk_live_..." \
-H "Content-Type: application/json" \
-d '{"handle":"elonmusk"}'
const res = await fetch("https://crmsolid.com/data-api/v2/tools/mention-checker", {
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/mention-checker",
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
- supabase
- Profile twitter id
- 1225654873178435584
- Profile name
- Supabase
- Profile avatar url
- https://pbs.twimg.com/profile_images/1visible/supabase.jpg
- Profile verified
- yes
- Profile followers
- 182,400
- Totals mentions
- 48
- Totals unique mentioners
- 41
- Totals verified mentioners
- 12
- Totals combined reach
- 2,140,800
- Totals total engagement
- 9,420
- Totals avg engagement
- 196
- Biggest reach handle
- vercel
- Top mention id
- 1798412008841203712
- Top mention text
- Shipped our whole auth layer on @supabase in a weekend.
- Top mention url
- https://x.com/vercel/status/1798412008841203712
- Top mention created at
- 8/21/2026, 4:04:33 PM
- Top mention author handle
- vercel
- Top mention author name
- Vercel
- Top mention author avatar url
- https://pbs.twimg.com/profile_images/1767351110131445760/9nAA4mQ0.jpg
- Top mention author followers
- 412,903
- Top mention author verified
- yes
- Top mention metrics likes
- 2,140
- Top mention metrics retweets
- 188
- Top mention metrics replies
- 96
- Top mention metrics views
- 184,000
- Top mention metrics total engagement
- 2,424
{
"data": {
"profile": {
"handle": "supabase",
"twitter_id": "1225654873178435584",
"name": "Supabase",
"avatar_url": "https://pbs.twimg.com/profile_images/1visible/supabase.jpg",
"verified": true,
"followers": 182400
},
"totals": {
"mentions": 48,
"unique_mentioners": 41,
"verified_mentioners": 12,
"combined_reach": 2140800,
"total_engagement": 9420,
"avg_engagement": 196
},
"biggest_reach_handle": "vercel",
"top_mention": {
"id": "1798412008841203712",
"text": "Shipped our whole auth layer on @supabase in a weekend.",
"url": "https://x.com/vercel/status/1798412008841203712",
"created_at": "2026-08-21T16:04:33.000Z",
"author": {
"handle": "vercel",
"name": "Vercel",
"avatar_url": "https://pbs.twimg.com/profile_images/1767351110131445760/9nAA4mQ0.jpg",
"followers": 412903,
"verified": true
},
"metrics": {
"likes": 2140,
"retweets": 188,
"replies": 96,
"views": 184000,
"total_engagement": 2424
}
},
"top_mentioner": null,
"mentions": []
},
"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/mention-checker 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-mention-checker