Docs
View as Markdown

x.thread

stable 2 credits may need a pack

The conversation thread around a tweet (author's self-thread / replies chain).

GET /v1/x/thread

What you get#

A list of X (Twitter) results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

Also known as: /twitter/tweet/replies on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

  • 2 credits for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
idstringyes(required)Tweet (status) idmax 20 chars; must match [0-9]{1,20}; trimmed

Request#

curl "https://api.onekey.dev/v1/x/thread?id=1519781379172495360" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real X (Twitter) response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "1519781379172495360",
        "text": "Our mission remains just as important as ever: to deliver an open platform that serves the public conversation. We’re continuing to innovate on the Twitter API v2 and invest in our developer community 🧵\n\nhttps://blog.twitter.com/developer/en_us/topics/community/2022/innovating-on-the-twitter-api-v2-and-investing-in-our-community",
        "url": "https://x.com/XDevelopers/status/1519781379172495360",
        "createdAt": "2022-04-28T20:51:31Z",
        "language": "en"
      },
      "author": {
        "id": "2244994945",
        "username": "XDevelopers",
        "displayName": "Developers",
        "avatarUrl": "https://pbs.twimg.com/profile_images/1683501992314798080/xl1POYLw_200x200.jpg",
        "followers": 698374,
        "verified": true
      },
      "engagement": {
        "likes": 111,
        "comments": 6,
        "shares": 37,
        "views": null,
        "bookmarks": 9,
        "quotes": 5
      }
    },
    {
      "content": {
        "id": "1519781381693353984",
        "text": "Catch up on recent launches and build with the core elements of the Twitter experience:\n🔖 New Bookmarks endpoints\n💬 New Quote Tweets lookup endpoints\n🔼 New sort_order parameter on search endpoints, and improvements to the Likes and Retweets endpoints",
        "url": "https://x.com/XDevelopers/status/1519781381693353984",
        "createdAt": "2022-04-28T20:51:32Z",
        "language": "en"
      },
      "author": {
        "id": "2244994945",
        "username": "XDevelopers",
        "displayName": "Developers",
        "avatarUrl": "https://pbs.twimg.com/profile_images/1683501992314798080/xl1POYLw_200x200.jpg",
        "followers": 698374,
        "verified": true
      },
      "engagement": {
        "likes": 6,
        "comments": 1,
        "shares": 4,
        "views": null,
        "bookmarks": 1,
        "quotes": 0
      }
    }
  ],
  "metadata": {
    "platform": "x",
    "endpoint": "thread",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 2,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
idcontent.id-
textcontent.text-
urlcontent.urlsafeUrl
created_timestampcontent.createdAttoIsoDate
langcontent.language-
author.idauthor.id-
author.screen_nameauthor.username-
author.nameauthor.displayName-
author.avatar_urlauthor.avatarUrlsafeUrl
author.followersauthor.followerstoNumber
author.verification.verifiedauthor.verifiedtoBoolean
likesengagement.likestoNumber
repliesengagement.commentstoNumber
repostsengagement.sharestoNumber
viewsengagement.viewstoNumber
bookmarksengagement.bookmarkstoNumber
quotesengagement.quotestoNumber

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).