Skip to main content
GET
cURL
Get user info by screen name Always HTTP 200. A handle that does not exist returns status: "error" with msg: "user not found". A suspended or otherwise unavailable account returns status: "success" with data: {"unavailable": true, "message": ..., "unavailableReason": "Suspended"} (reason passed through from X; compare case-insensitively) and no other profile fields.

Authorizations

X-API-Key
string
header
required

Query Parameters

userName
string<string>

The screen name of the user

Response

User info

data
object
status
enum<string>

Status of the request.success or error

Available options:
success,
error
msg
string

Message of the request.error message