Live scrape
LiveSensitiveLive X profiles, batched
/data-api/v2/scrape/x/users- Scope
- scrape:live
- Freshness
- live read
- Group
- Live scrape
- Platforms
- 1 of 7
What this endpoint answers
Up to 25 handles in one call, fetched with bounded concurrency and returned with a per-handle verdict. One bad handle never fails the batch.
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 scrape:live scope (Live scrape): Read from the platform itself rather than from the catalog: a profile or channel on any of the seven platforms, and on X the whole content layer - timelines, posts, replies, quotes, threads, followers, search, lists and communities.
Good to know
- One request is one live call against your rate limit however many handles it carries, which is the reason to batch rather than loop over /scrape/x/user. The upstream work is real per handle, so use it to be efficient, not to evade the limit.
- Concurrency is capped at 5 because the upstream pool is shared with the marketplace's own listing flow; pushing harder only queues behind yourself.
- The batch always uses the burst cache. If you need guaranteed-fresh reads, call /scrape/x/user with fresh=1 per handle and accept the slower pace.
- The envelope stays 200 whenever the request was well formed, even if every handle failed. Branch on results[].ok, not on the status code.
Parameters
This endpoint takes no path or query parameters.
Request body
handlesstring[]requiredArray of X handles, at most 25. Duplicates are collapsed.
{
"handles": [
"elonmusk",
"nasa",
"handle_that_does_not_exist"
]
}
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/scrape/x/users" \
-H "Authorization: Bearer psk_live_..." \
-H "Content-Type: application/json" \
-d '{"handles":["elonmusk","nasa","handle_that_does_not_exist"]}'
const res = await fetch("https://crmsolid.com/data-api/v2/scrape/x/users", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"handles": [
"elonmusk",
"nasa",
"handle_that_does_not_exist"
]
}),
});
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("""
{
"handles": [
"elonmusk",
"nasa",
"handle_that_does_not_exist"
]
}
""")
res = requests.post(
"https://crmsolid.com/data-api/v2/scrape/x/users",
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.
- Requested
- 3
- Succeeded
- 2
- Failed
- 1
- Results
- 2 items
{
"data": {
"requested": 3,
"succeeded": 2,
"failed": 1,
"results": [
{
"handle": "elonmusk",
"ok": true,
"profile": {
"user_id": "44196397",
"handle": "elonmusk",
"display_name": "Elon Musk",
"bio": "",
"followers": 221384902,
"following": 1102,
"tweets": 79431,
"is_verified": true,
"avatar_url": "https://pbs.twimg.com/profile_images/1936002956/elon_400x400.jpg",
"header_url": "https://pbs.twimg.com/profile_banners/44196397/1739948056/1500x500",
"account_age_days": 6290,
"created_at": "2009-06-02T20:12:29.000Z",
"source": "xlookup"
}
},
{
"handle": "handle_that_does_not_exist",
"ok": false,
"error": {
"code": "not_found",
"message": "No X account with that handle."
}
}
]
},
"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 /scrape/x/users 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/scrape-x-users