X (Twitter) Profile API reference
Follower, following and post counts for a public X account. Takes a public URL, returns one object, 1 credit a call.
This named API keeps X fields in X's own vocabulary. For a higher-level product page, see X (Twitter) Profile API.
Endpoint
GET /v1/x/profile
Authorization: Bearer sv_live_... `POST` is also accepted with the same parameters in the request body. Send the key in the `Authorization` header, never in the query string.
Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
url | string | yes | Public X URL matching this API's input. |
Sample Request
This is a copyable request shape. Replace the sample values with the public X target or parameters your workflow uses.
curl -G 'https://api.sourcevine.io/v1/x/profile' \
-H 'Authorization: Bearer sv_live_...' \
--data-urlencode 'url=https://x.com/X' Sample Response
A response this API returned, against the target above. Your values depend on the resource you ask about and when you ask.
{
"data": {
"url": "https://x.com/X",
"name": "X",
"cached": false,
"handle": "X",
"userId": "783214",
"verified": true,
"avatarUrl": "https://pbs.twimg.com/profile_images/1955359038532653056/OSHY3ewP_normal.jpg",
"fetchedAt": "2026-09-02T07:08:41Z",
"followers": 60737966,
"following": 1,
"tweetCount": 15715,
"cacheAgeSeconds": null,
"sourceTimestamp": null
},
"success": true,
"available": true
} Fields
| Field | Type | Notes |
|---|---|---|
url | string | Canonical public X profile URL. |
handle | string | Public X handle. |
userId | string | Platform user id. |
name | string | null | Display name as X publishes it. |
followers | integer | null | Public follower count. |
tweetCount | integer | null | Public post count when reported. |
fetchedAt | ISO datetime | When Sourcevine read the public page. |
sourceTimestamp | ISO datetime | null | The platform timestamp when it is available. |
cached | boolean | True when this answer repeats an identical request made moments earlier. |
cacheAgeSeconds | integer | Seconds since the reading was taken. |
Availability States
| Status | Charged | Client behavior |
|---|---|---|
available | yes for live reads | Use data. |
not_found | yes | Store the state and stop polling. |
private | yes | Store the state and stop polling. |
unsupported | no | Fix the URL or call the matching API. |
upstream_unavailable | no | Retry later with backoff. |
Unavailable resources return `success: true`, `available: false`, `availability`, and `data: null`. API or authentication failures return `success: false` with an `error` object.
Billing
A call costs 1 credit. A deleted, private or empty resource is charged like any lookup and says so. An unsupported URL or a read we could not complete is not charged. The `X-Credits-Charged` response header is the source of truth for what happened on that request.
Successful responses include `fetchedAt`, the time we read the platform.
What This API Does Not Return
- No contact or bio fields: Bios, email addresses, phone numbers, postal addresses and messenger handles are outside the response contract.
- No private data: Private accounts, restricted content and unavailable resources return typed availability instead of guessed data.
- No identity matching: Sourcevine does not claim that two profiles on different platforms belong to the same person.
Related
- X API hub
- X (Twitter) Profile API product page
- Quickstart
- Credits and billing
- X (Twitter) Post Stats API reference
- X (Twitter) Timeline API reference
- X (Twitter) Search API reference
- X (Twitter) Replies API reference
Last updated 1 September 2026