Skip to content

Structured X (Twitter) data: send usernames. Cursor-paginated, 1 credit per successful call.

GET · POST1 credit / successful callCursor-paginated
GEThttps://api.scrapier.io/api/v2/twitter-post/Open in Playground

Call GET /api/v2/twitter-post/ with usernames. The results are in data.tweets; send data.next_cursor back as cursor to get the next page. 1 optional parameter refines the call (see Parameters).

Terminal window
curl -G "https://api.scrapier.io/api/v2/twitter-post/" \
-H "X-API-Key: YOUR_API_KEY" \
--data-urlencode "usernames=elonmusk" \
--max-time 210
NameTypeRequiredDefaultDescription
X-API-Key headerstringyes—Your API key from the dashboard.
usernamesstringyese.g. elonmuskX/Twitter post URL or post id (returns that one post), or username / profile URL / numeric user ID (latest posts, ~20 per page). Required on first call; ignored when cursor is supplied.
cursorstringno—Pagination cursor returned in the previous response's next_cursor. Pass it back unchanged to fetch the next page. When next_cursor is null, you have reached the last page.
Advanced
NameTypeDefaultDescription
use_proxybooleantrueRoute the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise.
raw_databooleanfalseWhen true, the response carries the full raw upstream payload(s) the scraper received (GraphQL / JSON API bodies, HTML, embedded JSON-LD -- exactly as the platform returned them) under raw_responses, in place of the formatted items. When false (default) you get the formatted output. Pagination (cursor / next_cursor) works the same in both modes.
{
"success": true,
"data": {
"usernames": "https://x.com/elonmusk/status/1585341984679469056",
"page": 1,
"page_size": 1,
"tweets": [
{
"biography": "",
"bookmarks": 16000,
"date_posted": "2022-10-26T18:45:58.000Z",
"description": "Entering Twitter HQ – let that sink in! https://t.co/D68z4K2wq7",
"external_url": null,
"followers": 241733278,
"following": 1300,
"hashtags": null,
"id": "1585341984679469056",
"input": {
"url": "https://x.com/elonmusk/status/1585341984679469056/"
},
"is_verified": true,
"likes": 1221559,
"name": "Elon Musk",
"photos": null,
"posts_count": 98000,
"profile_image_link": "https://pbs.twimg.com/profile_images/example_normal.jpg",
"quoted_post": {
"date_posted": null,
"description": null,
"post_id": null,
"profile_id": null,
"profile_name": null,
"url": null,
"videos": null
},
"quotes": 70000,
"replies": 160000,
"reposts": 200000,
"tagged_users": null,
"url": "https://x.com/elonmusk/status/1585341984679469056",
"user_posted": "elonmusk",
"videos": [
"https://video.twimg.com/ext_tw_video/1585341912877146112/pu/vid/1920x1080/example.mp4?tag=14"
],
"views": null,
"input_username": "https://x.com/elonmusk/status/1585341984679469056"
}
],
"next_cursor": null
}
}

Sample from the live catalog; arrays trimmed to 3 items. Results are in data.tweets.

FieldTypeExampleDescription
usernamesstringhttps://x.com/elonmusk/status/158534198467946…—
pageinteger1—
page_sizeinteger1—
tweetsarray[1 item]The results.
next_cursornullnullPass back as cursor for the next page. null on the last page.
tweets[].biographystring—
tweets[].bookmarksinteger16000—
tweets[].date_postedstring2022-10-26T18:45:58.000Z—
tweets[].descriptionstringEntering Twitter HQ – let that sink in! https…—
tweets[].external_urlnullnull—
tweets[].followersinteger241733278—
tweets[].followinginteger1300—
tweets[].hashtagsnullnull—
tweets[].idstring1585341984679469056—
tweets[].inputobject{…}—
tweets[].is_verifiedbooleantrue—
tweets[].likesinteger1221559—
tweets[].namestringElon Musk—
tweets[].photosnullnull—
tweets[].posts_countinteger98000—
tweets[].profile_image_linkstringhttps://pbs.twimg.com/profile_images/example_…—
tweets[].quoted_postobject{…}—
tweets[].quotesinteger70000—
tweets[].repliesinteger160000—
tweets[].repostsinteger200000—
tweets[].tagged_usersnullnull—
tweets[].urlstringhttps://x.com/elonmusk/status/158534198467946…—
tweets[].user_postedstringelonmusk—
tweets[].videosarray[1 item]—
tweets[].viewsnullnull—
tweets[].input_usernamestringhttps://x.com/elonmusk/status/158534198467946…—

Pass data.next_cursor back as cursor until it is null. Required inputs are ignored once a cursor is sent. Each page is one billed call. More in Pagination.

const url = "https://api.scrapier.io/api/v2/twitter-post/";
let params = { usernames: "elonmusk" };
const items = [];
for (let page = 0; page < 10; page++) { // each page is one billed call
const res = await fetch(`${url}?${new URLSearchParams(params)}`, {
headers: { "X-API-Key": "YOUR_API_KEY" },
signal: AbortSignal.timeout(210_000),
});
const body = await res.json();
if (!res.ok) throw new Error(body.error ?? body.detail ?? `HTTP ${res.status}`);
const data = body.data;
items.push(...(data.tweets ?? []));
if (!data.next_cursor) break; // null = last page
params = { cursor: data.next_cursor };
}

Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.

StatusMeaningRetry?Charged?
400Bad or missing input.No — fix the paramsNo
401 / 403Missing, invalid or revoked API key.No — fix the keyNo
402Out of credits (body has balance).No — top upNo
404Unknown endpoint slug.No — check the slugNo
429 / 503Busy or throttled.Yes — after Retry-AfterNo
5xxTarget site or upstream failure, or timeout.Yes — with backoffNo
  • Nothing special: send the inputs, read the result.