X X Profile API

Scrape an X profile

curl --request POST \
  --url https://api.stophy.dev/v1/x/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "nasa"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({username: 'nasa'})
};

fetch('https://api.stophy.dev/v1/x/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/x/profile"

payload = { "username": "nasa" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "profileUrl": "<string>",
    "isVerified": true,
    "isProtected": true,
    "userId": "<string>",
    "username": "<string>",
    "name": "<string>",
    "bio": "<string>",
    "location": "<string>",
    "website": "<string>",
    "joinedAt": "2023-11-07T05:31:56Z",
    "followers": 0,
    "following": 0,
    "posts": 0,
    "verifiedType": "<string>",
    "avatarUrl": "<string>",
    "bannerUrl": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

profile

Scrape an X profile

curl --request POST \
  --url https://api.stophy.dev/v1/x/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "nasa"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({username: 'nasa'})
};

fetch('https://api.stophy.dev/v1/x/profile', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/x/profile"

payload = { "username": "nasa" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "profileUrl": "<string>",
    "isVerified": true,
    "isProtected": true,
    "userId": "<string>",
    "username": "<string>",
    "name": "<string>",
    "bio": "<string>",
    "location": "<string>",
    "website": "<string>",
    "joinedAt": "2023-11-07T05:31:56Z",
    "followers": 0,
    "following": 0,
    "posts": 0,
    "verifiedType": "<string>",
    "avatarUrl": "<string>",
    "bannerUrl": "<string>"
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape an X profile. The profile or user is identified by its URL or username.

Request

Exactly one of profileUrl or username is required. A request that sets both, or none, fails with invalidRequest.

This endpoint can be called without an API key, subject to per-address limits. Pagination requires a key.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.x.profile({ username: "nasa" });
console.log(result.data);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.x.profile(username="nasa")
print(result["data"])

curl -X POST https://api.stophy.dev/v1/x/profile \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"username":"nasa"}'

stophy x profile --username nasa

Response

If successful, the response body contains the standard envelope. data contains the profile’s bio, followers, following, post count and join date. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "userId": "11348282",
    "username": "NASA",
    "profileUrl": "https://x.com/NASA",
    "name": "NASA",
    "bio": "Making the seemingly impossible, possible. ✨",
    "location": "Pale Blue Dot",
    "website": "http://www.nasa.gov/",
    "joinedAt": "2007-12-19T20:20:32.000Z",
    "followers": 92329477,
    "following": 115,
    "posts": 74412,
    "isVerified": true,
    "verifiedType": "Government",
    "isProtected": false,
    "avatarUrl": "https://pbs.twimg.com/profile_images/1321163587679784960/0ZxKlEKB_400x400.jpg",
    "bannerUrl": "https://pbs.twimg.com/profile_banners/11348282/1788992290"
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`posts`	integer	The number of posts.

For every field, see the response schema on this page.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

This method is not paginated. A single request returns the complete result.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength

integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json

profileUrl

string

Link to the X profile, like https://x.com/nasa. Send this or username.

username

string

X profile handle, like nasa. Send this or profileUrl.

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

X X Profile API

Request

Response

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Billing

​Pagination

Authorizations

Query Parameters

Body

Response

Request

Response

Billing

Pagination