SocialScrape
Get early access
Docs menu

Get started

Guides

API reference

Resources

X post details

Beta GET /v1/twitter/tweet

GET /v1/twitter/tweet

One public post with its counts, media and, for a quote post, the quoted post (extra.quoted_post). If X will not serve the post page, the answer comes from X's public post widget instead and views, retweet and bookmark counts are missing (extra.source_shape is syndication).

  • Cost: 1 credit
  • Status: Beta. Built and tested against recorded responses; the shape may still gain fields.
  • Cache: Results are kept up to 30 days; send max_age_days to reuse them for free.
  • Timeout: A request still running after about 25 seconds answers 202 with a job to poll (Batch and jobs).

Parameters#

NameTypeRequiredDescription
urlURLone ofPost URL (x.com/<user>/status/<id>). Accepted hosts: x.com, twitter.com.
idstringone ofPost id. Also accepted as tweet_id.

Send at least one of url, id. If you send several, the first listed is used and the rest are ignored.

Every request also accepts:

  • trim: true for a smaller response without null fields and extra.
  • raw: true to also get the platform's original object as raw.
  • max_age_days: accept a cached result up to this many days old, for 0 credits (Caching).

Example request#

Set your key in the environment first (see Authentication).

curl
curl -G "https://api.socialscrape.io/v1/twitter/tweet" \
  -H "x-api-key: $SOCIALSCRAPE_API_KEY" \
  --data-urlencode "url=https://x.com/jack/status/20"
Python
import os
import requests

params = {
    "url": "https://x.com/jack/status/20",
}
res = requests.get(
    "https://api.socialscrape.io/v1/twitter/tweet",
    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},
    params=params,
)
body = res.json()

if body["ok"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
TypeScript
const url = new URL("https://api.socialscrape.io/v1/twitter/tweet");
url.search = new URLSearchParams({
  "url": "https://x.com/jack/status/20"
}).toString();
const res = await fetch(url, {
  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },
});
const body = await res.json();

if (body.ok) {
  console.log(body.data);
} else {
  console.error(body.error.code, body.error.message);
}
n8n
{
  "nodes": [
    {
      "name": "SocialScrape X post details",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [
        0,
        0
      ],
      "parameters": {
        "method": "GET",
        "url": "https://api.socialscrape.io/v1/twitter/tweet",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            {
              "name": "url",
              "value": "https://x.com/jack/status/20"
            }
          ]
        },
        "sendHeaders": true,
        "headerParameters": {
          "parameters": [
            {
              "name": "x-api-key",
              "value": "={{ $env.SOCIALSCRAPE_API_KEY }}"
            }
          ]
        }
      }
    }
  ],
  "connections": {}
}

Example response#

This is a sample from a recorded response. Status 200.

{
  "ok": true,
  "credits_charged": 1,
  "credits_remaining": 4999,
  "cached": false,
  "cached_at": null,
  "request_id": "req_49f7a65c692d50cd451680d6",
  "data": {
    "object": "post",
    "platform": "twitter",
    "id": "20",
    "url": "https://x.com/jack/status/20",
    "type": "tweet",
    "author": {
      "id": "12",
      "handle": "jack",
      "name": "jack",
      "url": "https://x.com/jack",
      "avatar_url": "https://pbs.twimg.com/profile_images/1661201415899951105/azNjKOSH_400x400.jpg",
      "verified": true
    },
    "title": null,
    "text": "just setting up my twttr",
    "published_at": "2006-03-21T20:50:14Z",
    "duration_seconds": null,
    "language": "en",
    "hashtags": null,
    "mentions": null,
    "stats": {
      "views": null,
      "likes": 308827,
      "comments": 18121,
      "shares": 131907,
      "saves": 21986,
      "dislikes": null
    },
    "media": {
      "thumbnail_url": null,
      "video_url": null,
      "audio_url": null,
      "image_urls": null,
      "width": null,
      "height": null
    },
    "song": null,
    "location": null,
    "is_pinned": null,
    "is_sponsored": null,
    "extra": {
      "is_edited": false,
      "quote_count": 7361,
      "retweet_count": 124546
    }
  },
  "cursor": null,
  "has_more": null
}

Response#

A Post object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

CodeHTTPRetryMeaning
invalid_params400noA parameter is missing, unknown or has the wrong type.
unsupported_url400noThe URL is not one this endpoint accepts (wrong platform or form).
not_found404noThe platform says this profile, post or item does not exist.

Every request can also fail with the account and platform errors listed on the Errors page.

Example error:

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "The platform says this profile, post or item does not exist.",
    "retryable": false
  },
  "credits_charged": 0,
  "request_id": "req_aba07f4107889141a048b7fc"
}