x.user

stable Standard may need a pack

Public profile for an X handle: followers, following, bio, avatar.

GET /v1/x/user

What you get#

One X (Twitter) record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also works with: URL lookup (x.com/{handle}, twitter.com/{handle}) · Creator card as the X (Twitter) profile leg · Computed block (language). Any batch can include it.

What it costs#

Standard · 1 credit 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#

Name	Type	Required	Default	What it is	Constraints
`handle`	string	yes	(required)	X handle without @, e.g. jack	max 15 chars; must match `[A-Za-z0-9_]{1,15}`; trimmed, leading @ removed

Request#

curl "https://api.onekey.dev/v1/x/user?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": "12",
      "username": "jack",
      "displayName": "jack",
      "followers": 12354902,
      "following": 3,
      "url": "https://x.com/jack",
      "avatarUrl": "https://pbs.twimg.com/profile_images/1661201415899951105/azNjKOSH_normal.jpg",
      "verified": true
    },
    "content": {
      "text": "no state is the best state"
    },
    "ext": {
      "joinedText": "Tue Mar 21 20:50:14 +0000 2006",
      "location": ""
    },
    "engagement": {
      "comments": 30997,
      "likes": 40668
    }
  },
  "metadata": {
    "platform": "x",
    "endpoint": "user",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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 path	Onekey field	Transform
`user.id`	`author.id`	-
`user.screen_name`	`author.username`	-
`user.name`	`author.displayName`	-
`user.followers`	`author.followers`	`toNumber`
`user.following`	`author.following`	`toNumber`
`user.url`	`author.url`	`safeUrl`
`user.avatar_url`	`author.avatarUrl`	`safeUrl`
`user.verification.verified`	`author.verified`	`toBoolean`
`user.description`	`content.text`	-
`user.joined`	`ext.joinedText`	-
`user.statuses`	`engagement.comments`	`toNumber`
`user.likes`	`engagement.likes`	`toNumber`
`user.location`	`ext.location`	-

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours 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 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).