Docs
View as Markdown

x.followers

stable 2 credits may need a pack

Followers of an X user (first page).

GET /v1/x/followers

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/user/followers 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
handlestringyes(required)X handle without @, e.g. jackmax 15 chars; must match [A-Za-z0-9_]{1,15}; trimmed, leading @ removed

Request#

curl "https://api.onekey.dev/v1/x/followers?handle=jack" \
  -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": [
    {
      "author": {
        "id": "1337780902680809474",
        "username": "DocumentingBTC",
        "displayName": "Documenting ₿itcoin 📄",
        "followers": 1125537,
        "following": 1957,
        "url": "https://x.com/DocumentingBTC",
        "avatarUrl": "https://pbs.twimg.com/profile_images/1369025687743500288/-4tdBSu5_normal.jpg",
        "verified": true
      },
      "content": {
        "text": "The ₿est of ₿itcoin"
      }
    },
    {
      "author": {
        "id": "13418472",
        "username": "willywoo",
        "displayName": "Willy Woo",
        "followers": 1239681,
        "following": 343,
        "url": "https://x.com/willywoo",
        "avatarUrl": "https://pbs.twimg.com/profile_images/1714708774710374400/-3BGVJUc_normal.jpg",
        "verified": true
      },
      "content": {
        "text": "#Bitcoin analysis since 2016... onchain data, market structure, research... I only post here, all other channels especially Telegram are scams."
      }
    }
  ],
  "metadata": {
    "platform": "x",
    "endpoint": "followers",
    "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
idauthor.id-
screen_nameauthor.username-
nameauthor.displayName-
followersauthor.followerstoNumber
followingauthor.followingtoNumber
urlauthor.urlsafeUrl
avatar_urlauthor.avatarUrlsafeUrl
descriptioncontent.text-
verification.verifiedauthor.verifiedtoBoolean

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).