X (Twitter)

Profile

An account's profile: name, bio, link, location, followers, following, post count and when it joined. A protected account's profile too, with private true.

GET/v1/twitter/profile1 credit

Headers

Get your API key

x-api-key*stringrequiredheader

Your API key, made in the dashboard.

Parameters

handlestringoptionalquery

An X handle, with or without the @. Give handle, user_id or url.

example: NASA

user_idstringoptionalquery

An account's id, such as a post's author_id. Give handle, user_id or url.

urlstringoptionalquery

A profile's link: x.com/<handle> or twitter.com/<handle>, with anything after it. Give handle, user_id or url.

max 300 chars

Response fields

dataobject

The result: one object, or a list for the endpoints that return several.

data.idstring

X's id for the account: digits, written as text.

data.handlestring

The handle, without the @.

data.urlstring

The profile's link.

data.namestringnullable

The display name.

data.biostringnullable

The bio.

data.linksstring[]nullable

The website link on the profile.

data.locationstringnullable

Where the account says it is.

data.picturestringnullable

The profile picture's link, 400x400.

data.bannerstringnullable

The header image's link.

data.verifiedbooleannullable

Whether it has a checkmark.

data.verified_typestringnullable

Business for a gold checkmark, Government for a grey one; null for a blue one or none.

data.privatebooleannullable

Whether its posts are protected: only the followers it approves see them.

data.followersintegernullable

Followers.

data.followingintegernullable

Accounts it follows.

data.tweetsintegernullable

Posts, its replies and reposts included.

data.created_atstringnullable

When it joined X.

format: date-time

pageobjectnullable

Paging, for the endpoints that page; null for the others.

page.next_cursorstringnullable

Send it as the cursor parameter, with the same other parameters, for the next page. Null on the last page.

page.has_morebooleanoptional

Whether another page follows.

default: false

metaobject

About this call.

meta.platformstring

The platform: reddit, threads, tiktok or youtube.

meta.endpointstring

The endpoint's name, such as channel_videos.

meta.paramsobject

The call's parameters, defaults included. Parameters without a value, and the cursor, are left out.

meta.request_idstring

This call's id. Quote it when you report a problem.

meta.api_versionstring

The API version that answered.

meta.fetched_atstring

When the data was fetched from the platform (UTC).

format: date-time

meta.cachedbooleanoptional

Whether it came from our cache; fetched_at says how old it is.

default: false

Code example

curl -X GET 'https://api.socialparse.dev/v1/twitter/profile?handle=NASA' \  -H 'x-api-key: YOUR_API_KEY'

Responses

Successful Response

{  "data": {    "id": "string",    "handle": "string",    "url": "string",    "name": "string",    "bio": "string",    "links": [      "string"    ],    "location": "string",    "picture": "string",    "banner": "string",    "verified": true,    "verified_type": "string",    "private": true,    "followers": 0,    "following": 0,    "tweets": 0,    "created_at": "2019-08-24T14:15:22Z"  },  "page": {    "next_cursor": "string",    "has_more": false  },  "meta": {    "platform": "string",    "endpoint": "string",    "params": {      "property1": "string",      "property2": "string"    },    "request_id": "string",    "api_version": "string",    "fetched_at": "2019-08-24T14:15:22Z",    "cached": false  }}

Live

A live room's details: its title, whether it is live, viewers, likes and host. An ended room answers too.

Profile tweets

An account's latest posts, without its replies and reposts: the 5 its profile shows logged out, its pinned post first. There is no next page. A protected account answers LOGIN_REQUIRED.