Get user profile

GET

/2/profile/{handle}

curl --request GET \
  --url 'https://api.fxtwitter.com/2/profile/X?about_account=1'

• FxTwitter API host

Returns profile fields for a user. Optional about_account / aboutAccount (truthy) adds about_account on the user when available.

Parameters

Path Parameters

handle

required

string

Example

X

Username without @, or numeric user id as id:<rest_id> (e.g. id:783214). Case-insensitive id: prefix.

Query Parameters

about_account

string

Example

1

If truthy, include about_account on author when available

aboutAccount

string

Alias for about_account

Responses

200

Profile (check code)

Media type application/json

object

code

required

number

message

required

string

user

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

id

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

id

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

reason

Set to suspended when the user is suspended; omitted for plain not found.

string

Allowed values: suspended

id

Numeric user id when the upstream payload includes it.

string

Example

{
  "user": {
    "type": "profile",
    "verification": {
      "type": "organization"
    }
  },
  "reason": "suspended"
}

400

Invalid path or query parameters

Media type application/json

object

code

required

number

Allowed values: 400

message

required

string

Example

{
  "code": 400
}

404

User not found, suspended (reason: suspended, message: User is suspended), or unavailable

Media type application/json

object

code

required

number

message

required

string

user

object

type

required

Discriminator: full user profile (API v2).

string

Allowed values: profile

id

required

string

name

required

string

screen_name

required

string

avatar_url

required

string

nullable

banner_url

required

string

nullable

description

required

string

raw_description

required

object

text

required

string

facets

required

Array<object>

object

type

required

Facet kind: e.g. url, mention, hashtag, bold, media, custom_emoji (Mastodon custom emoji image)

string

indices

required

Start and end UTF-16 indices

Array<number>

>= 2 items <= 2 items

original

string

replacement

string

display

string

id

string

location

required

string

url

required

string

protected

required

boolean

followers

required

number

following

required

number

statuses

required

number

media_count

required

number

likes

required

number

joined

required

string

website

required

object

url

required

string

display_url

required

string

birthday

object

day

number

month

number

year

number

verification

object

verified

required

boolean

type

required

string

nullable

Allowed values: organization government individual

verified_at

string

nullable

identity_verified

boolean

verified_by

string

about_account

object

based_in

string

nullable

location_accurate

boolean

created_country_accurate

boolean

nullable

source

string

nullable

username_changes

object

count

required

number

last_changed_at

required

string

nullable

profile_embed

boolean

reason

Set to suspended when the user is suspended; omitted for plain not found.

string

Allowed values: suspended

id

Numeric user id when the upstream payload includes it.

string

Example

{
  "user": {
    "type": "profile",
    "verification": {
      "type": "organization"
    }
  },
  "reason": "suspended"
}