Twitter/X Posts
Structured X (Twitter) data: send usernames. Cursor-paginated, 1 credit per successful call.
Overview
Section titled “Overview”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).
Request
Section titled “Request”curl -G "https://api.scrapier.io/api/v2/twitter-post/" \ -H "X-API-Key: YOUR_API_KEY" \ --data-urlencode "usernames=elonmusk" \ --max-time 210const params = new URLSearchParams({ usernames: "elonmusk" });
const res = await fetch(`https://api.scrapier.io/api/v2/twitter-post/?${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}`);
console.log(body.data.tweets);import requests
resp = requests.get( "https://api.scrapier.io/api/v2/twitter-post/", headers={"X-API-Key": "YOUR_API_KEY"}, params={"usernames": "elonmusk"}, timeout=210,)body = resp.json()if not resp.ok: raise RuntimeError(body.get("error") or body.get("detail"))
print(body["data"]["tweets"])curl -X POST "https://api.scrapier.io/api/v2/twitter-post/" \ -H "X-API-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"usernames":"elonmusk"}' \ --max-time 210Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
X-API-Key header | string | yes | — | Your API key from the dashboard. |
usernames | string | yes | e.g. elonmusk | X/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. |
cursor | string | no | — | 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
| Name | Type | Default | Description |
|---|---|---|---|
use_proxy | boolean | true | Route the request through Scrapier's residential proxy pool. Default: true. Leave as is unless support tells you otherwise. |
raw_data | boolean | false | When 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. |
Response
Section titled “Response”{ "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 }}Bad input. The exact message varies by endpoint.
{ "success": false, "error": "…"}Balance below the endpoint’s price.
{ "error": "Insufficient credits. Buy more to scrape more.", "balance": 1, "required": 2}Invalid or unknown API key.
{ "detail": "Authentication service unavailable or invalid API key."}Throttled — wait for Retry-After.
{ "detail": "Request was throttled. Expected available in N seconds."}Sample from the live catalog; arrays trimmed to 3 items. Results are in data.tweets.
Response fields
Section titled “Response fields”| Field | Type | Example | Description |
|---|---|---|---|
usernames | string | https://x.com/elonmusk/status/158534198467946… | — |
page | integer | 1 | — |
page_size | integer | 1 | — |
tweets | array | [1 item] | The results. |
next_cursor | null | null | Pass back as cursor for the next page. null on the last page. |
tweets[].biography | string | — | |
tweets[].bookmarks | integer | 16000 | — |
tweets[].date_posted | string | 2022-10-26T18:45:58.000Z | — |
tweets[].description | string | Entering Twitter HQ – let that sink in! https… | — |
tweets[].external_url | null | null | — |
tweets[].followers | integer | 241733278 | — |
tweets[].following | integer | 1300 | — |
tweets[].hashtags | null | null | — |
tweets[].id | string | 1585341984679469056 | — |
tweets[].input | object | {…} | — |
tweets[].is_verified | boolean | true | — |
tweets[].likes | integer | 1221559 | — |
tweets[].name | string | Elon Musk | — |
tweets[].photos | null | null | — |
tweets[].posts_count | integer | 98000 | — |
tweets[].profile_image_link | string | https://pbs.twimg.com/profile_images/example_… | — |
tweets[].quoted_post | object | {…} | — |
tweets[].quotes | integer | 70000 | — |
tweets[].replies | integer | 160000 | — |
tweets[].reposts | integer | 200000 | — |
tweets[].tagged_users | null | null | — |
tweets[].url | string | https://x.com/elonmusk/status/158534198467946… | — |
tweets[].user_posted | string | elonmusk | — |
tweets[].videos | array | [1 item] | — |
tweets[].views | null | null | — |
tweets[].input_username | string | https://x.com/elonmusk/status/158534198467946… | — |
Pagination
Section titled “Pagination”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 };}import requests
URL = "https://api.scrapier.io/api/v2/twitter-post/"HEADERS = {"X-API-Key": "YOUR_API_KEY"}params = {"usernames": "elonmusk"}items = []
for _ in range(10): # each page is one billed call resp = requests.get(URL, headers=HEADERS, params=params, timeout=210) resp.raise_for_status() data = resp.json()["data"] items.extend(data.get("tweets") or []) if not data.get("next_cursor"): # None = last page break params = {"cursor": data["next_cursor"]}Errors
Section titled “Errors”Failed calls are free. Branch on the HTTP status and read the message from error (or detail). Full details in Errors.
| Status | Meaning | Retry? | Charged? |
|---|---|---|---|
400 | Bad or missing input. | No — fix the params | No |
401 / 403 | Missing, invalid or revoked API key. | No — fix the key | No |
402 | Out of credits (body has balance). | No — top up | No |
404 | Unknown endpoint slug. | No — check the slug | No |
429 / 503 | Busy or throttled. | Yes — after Retry-After | No |
5xx | Target site or upstream failure, or timeout. | Yes — with backoff | No |
- Nothing special: send the inputs, read the result.
Related
Section titled “Related”- X/Twitter Video Transcript — Structured X (Twitter) data: send
urls. Single lookup, 2 credits per successful call. - Twitter/X Profile Tweets — Structured X (Twitter) data: send
usernames. Cursor-paginated, 1 credit per successful call.