Skip to content
FxEmbed

List user articles

GET
/2/profile/{handle}/articles
 
curl --request GET \
  --url 'https://api.fxtwitter.com/2/profile/example/articles?count=20&lang=es'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
handle
required
string

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

Query Parameters

Section titled “Query Parameters ”
count
integer
default: 20 >= 1 <= 100

Page size (default 20)

cursor
string

Pagination cursor from prior response

lang
string
Example 
es

Target language (ISO 639-1 or 639-5, e.g. en, es, zh-cn) for inline X translations when available; falls back to translation API if missing

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Articles timeline page

Media type application/json
object
code
required
number
results
required
Array<object>
object
type
required

Discriminator: single post/status (API v2).

string
Allowed values: status
id
required
string
url
required
string
text
required
string
created_at
required
string
created_timestamp
required
number
likes
required
number
reposts
required
number
quotes
required
number
replies
required
number
quote
Any of:
APITwitterStatus (recursive)

Recursive reference — same shape as APITwitterStatus.

object
poll
object
choices
required
Array<object>
object
label
required
string
count
required
number
percentage
required
number
total_votes
required
number
ends_at
required
string
time_left_en
required
string
author
required
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
media
required
object
external
object
type
required
string
Allowed values: video
url
required
string
thumbnail_url
string
height
number
width
number
photos
Array<object>
object
id
string
format
string
type
required
string
Allowed values: photo gif
url
required
string
width
required
number
height
required
number
transcode_url
string
nullable
altText
string
videos
Array<object>
object
id
string
format
string
type
required
string
Allowed values: video gif
url
required
string
width
required
number
height
required
number
thumbnail_url
string
nullable
transcode_url
string
nullable
duration
required
number
filesize
number
formats
required
Array<object>
object
container
string
Allowed values: mp4 webm m3u8
codec
string
Allowed values: h264 hevc vp9 av1
bitrate
number
url
required
string
size
number
height
number
width
number
publisher
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
all
Array
Any of:
object
id
string
format
string
type
required
string
Allowed values: photo gif
url
required
string
width
required
number
height
required
number
transcode_url
string
nullable
altText
string
mosaic
object
id
string
format
string
type
required
string
Allowed values: mosaic_photo
url
required
string
width
required
number
height
required
number
formats
required
object
webp
required
string
jpeg
required
string
broadcast
object
url
required
string
width
required
number
height
required
number
state
required
string
Allowed values: LIVE ENDED
broadcaster
required
object
username
required
string
display_name
required
string
id
required
string
stream
object
url
required
string
title
required
string
source
required
string
orientation
required
string
Allowed values: landscape portrait
broadcast_id
required
string
media_id
required
string
media_key
required
string
is_high_latency
required
boolean
thumbnail
required
object
original
required
object
url
required
string
small
object
url
required
string
medium
object
url
required
string
large
object
url
required
string
x_large
object
url
required
string
raw_text
required
object
text
required
string
display_text_range
required
Array<number>
>= 2 items <= 2 items
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
lang
required
string
nullable
translation
object
text
required
string
source_lang
required
string
source_lang_en
required
string
target_lang
required
string
provider
required
string
possibly_sensitive
required
boolean
replying_to
required
object
screen_name
required

Handle or account id used in permalinks (@user on X).

string
status
required

Parent post id (X: snowflake; Bluesky: record key).

string
url

Permalink to the parent post when known.

string
profile_url

Permalink to the parent author profile when known.

string
display_name

Display name of the parent author when known.

string
source
required
string
nullable
embed_card
required
string
Allowed values: tweet summary summary_large_image player
provider
required
string
Allowed values: twitter
views
number
nullable
bookmarks
number
nullable
community
object
id
required
string
name
required
string
description
required
string
created_at
required
string
search_tags
required
Array<string>
is_nsfw
required
boolean
topic
required
string
nullable
admin
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
creator
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
join_policy
required
string
Allowed values: Open Closed
invites_policy
required
string
Allowed values: MemberInvitesAllowed MemberInvitesDisabled
is_pinned
required
boolean
article
object
created_at
required
string
modified_at
string
id
required
string
title
required
string
preview_text
required
string
cover_media
required
object
id
required
string
media_key
required
string
media_id
required
string
media_info
required
Any of:
object
__typename
required
string
Allowed values: ApiImage
original_img_height
required
number
original_img_width
required
number
original_img_url
required
string
color_info
required
object
palette
required
Array<object>
object
percentage
required
number
rgb
required
object
red
required
number
green
required
number
blue
required
number
content
required
object
blocks
Array<object>
default:
object
key
required
string
data
required
object
key
additional properties
nullable
entityRanges
required
Array<object>
object
key
required
number
length
required
number
offset
required
number
inlineStyleRanges
required
Array<object>
object
length
required
number
offset
required
number
style
required
string
text
required
string
type
required
string
entityMap
Array
default:
Any of:
object
key
required
string
value
required
object
type
required
string
Allowed values: MARKDOWN
mutability
required
string
Allowed values: Mutable
data
required
object
entityKey
required
string
markdown
required
string
media_entities
required
Array<object>
object
id
required
string
media_key
required
string
media_id
required
string
media_info
required
Any of:
object
__typename
required
string
Allowed values: ApiImage
original_img_height
required
number
original_img_width
required
number
original_img_url
required
string
color_info
required
object
palette
required
Array<object>
object
percentage
required
number
rgb
required
object
red
required
number
green
required
number
blue
required
number
is_note_tweet
required
boolean
community_note
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
reposted_by
required
object
id
required
string
name
required
string
screen_name
required
string
avatar_url
string
nullable
url
string
card
object
url
required
string
title
string
description
string
domain
string
card_name
string
image
object
width
number
height
number
url
string
alt
string
cursor
required
object
top
required
string
nullable
bottom
required
string
nullable
Example 
{
  "results": [
    {
      "type": "status",
      "quote": {
        "type": "tombstone",
        "provider": "twitter",
        "reason": "deleted",
        "author": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        }
      },
      "author": {
        "type": "profile",
        "verification": {
          "type": "organization"
        }
      },
      "media": {
        "external": {
          "type": "video"
        },
        "photos": [
          {
            "type": "photo"
          }
        ],
        "videos": [
          {
            "type": "video",
            "formats": [
              {
                "container": "mp4",
                "codec": "h264"
              }
            ],
            "publisher": {
              "type": "profile",
              "verification": {
                "type": "organization"
              }
            }
          }
        ],
        "all": [
          {
            "type": "photo"
          }
        ],
        "mosaic": {
          "type": "mosaic_photo"
        },
        "broadcast": {
          "state": "LIVE",
          "orientation": "landscape"
        }
      },
      "embed_card": "tweet",
      "provider": "twitter",
      "community": {
        "admin": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        },
        "creator": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        },
        "join_policy": "Open",
        "invites_policy": "MemberInvitesAllowed"
      },
      "article": {
        "cover_media": {
          "media_info": {
            "__typename": "ApiImage"
          }
        },
        "content": {
          "blocks": [],
          "entityMap": []
        },
        "media_entities": [
          {
            "media_info": {
              "__typename": "ApiImage"
            }
          }
        ]
      }
    }
  ]
}

400

Section titled “400 ”

Invalid path or query parameters (e.g. count out of range)

Media type application/json
object
code
required
number
Allowed values: 400
message
required
string
Example 
{
  "code": 400
}

404

Section titled “404 ”

User not found or empty timeline

Media type application/json
object
code
required
number
results
required
Array<object>
object
type
required

Discriminator: single post/status (API v2).

string
Allowed values: status
id
required
string
url
required
string
text
required
string
created_at
required
string
created_timestamp
required
number
likes
required
number
reposts
required
number
quotes
required
number
replies
required
number
quote
Any of:
APITwitterStatus (recursive)

Recursive reference — same shape as APITwitterStatus.

object
poll
object
choices
required
Array<object>
object
label
required
string
count
required
number
percentage
required
number
total_votes
required
number
ends_at
required
string
time_left_en
required
string
author
required
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
media
required
object
external
object
type
required
string
Allowed values: video
url
required
string
thumbnail_url
string
height
number
width
number
photos
Array<object>
object
id
string
format
string
type
required
string
Allowed values: photo gif
url
required
string
width
required
number
height
required
number
transcode_url
string
nullable
altText
string
videos
Array<object>
object
id
string
format
string
type
required
string
Allowed values: video gif
url
required
string
width
required
number
height
required
number
thumbnail_url
string
nullable
transcode_url
string
nullable
duration
required
number
filesize
number
formats
required
Array<object>
object
container
string
Allowed values: mp4 webm m3u8
codec
string
Allowed values: h264 hevc vp9 av1
bitrate
number
url
required
string
size
number
height
number
width
number
publisher
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
all
Array
Any of:
object
id
string
format
string
type
required
string
Allowed values: photo gif
url
required
string
width
required
number
height
required
number
transcode_url
string
nullable
altText
string
mosaic
object
id
string
format
string
type
required
string
Allowed values: mosaic_photo
url
required
string
width
required
number
height
required
number
formats
required
object
webp
required
string
jpeg
required
string
broadcast
object
url
required
string
width
required
number
height
required
number
state
required
string
Allowed values: LIVE ENDED
broadcaster
required
object
username
required
string
display_name
required
string
id
required
string
stream
object
url
required
string
title
required
string
source
required
string
orientation
required
string
Allowed values: landscape portrait
broadcast_id
required
string
media_id
required
string
media_key
required
string
is_high_latency
required
boolean
thumbnail
required
object
original
required
object
url
required
string
small
object
url
required
string
medium
object
url
required
string
large
object
url
required
string
x_large
object
url
required
string
raw_text
required
object
text
required
string
display_text_range
required
Array<number>
>= 2 items <= 2 items
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
lang
required
string
nullable
translation
object
text
required
string
source_lang
required
string
source_lang_en
required
string
target_lang
required
string
provider
required
string
possibly_sensitive
required
boolean
replying_to
required
object
screen_name
required

Handle or account id used in permalinks (@user on X).

string
status
required

Parent post id (X: snowflake; Bluesky: record key).

string
url

Permalink to the parent post when known.

string
profile_url

Permalink to the parent author profile when known.

string
display_name

Display name of the parent author when known.

string
source
required
string
nullable
embed_card
required
string
Allowed values: tweet summary summary_large_image player
provider
required
string
Allowed values: twitter
views
number
nullable
bookmarks
number
nullable
community
object
id
required
string
name
required
string
description
required
string
created_at
required
string
search_tags
required
Array<string>
is_nsfw
required
boolean
topic
required
string
nullable
admin
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
creator
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
join_policy
required
string
Allowed values: Open Closed
invites_policy
required
string
Allowed values: MemberInvitesAllowed MemberInvitesDisabled
is_pinned
required
boolean
article
object
created_at
required
string
modified_at
string
id
required
string
title
required
string
preview_text
required
string
cover_media
required
object
id
required
string
media_key
required
string
media_id
required
string
media_info
required
Any of:
object
__typename
required
string
Allowed values: ApiImage
original_img_height
required
number
original_img_width
required
number
original_img_url
required
string
color_info
required
object
palette
required
Array<object>
object
percentage
required
number
rgb
required
object
red
required
number
green
required
number
blue
required
number
content
required
object
blocks
Array<object>
default:
object
key
required
string
data
required
object
key
additional properties
nullable
entityRanges
required
Array<object>
object
key
required
number
length
required
number
offset
required
number
inlineStyleRanges
required
Array<object>
object
length
required
number
offset
required
number
style
required
string
text
required
string
type
required
string
entityMap
Array
default:
Any of:
object
key
required
string
value
required
object
type
required
string
Allowed values: MARKDOWN
mutability
required
string
Allowed values: Mutable
data
required
object
entityKey
required
string
markdown
required
string
media_entities
required
Array<object>
object
id
required
string
media_key
required
string
media_id
required
string
media_info
required
Any of:
object
__typename
required
string
Allowed values: ApiImage
original_img_height
required
number
original_img_width
required
number
original_img_url
required
string
color_info
required
object
palette
required
Array<object>
object
percentage
required
number
rgb
required
object
red
required
number
green
required
number
blue
required
number
is_note_tweet
required
boolean
community_note
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
reposted_by
required
object
id
required
string
name
required
string
screen_name
required
string
avatar_url
string
nullable
url
string
card
object
url
required
string
title
string
description
string
domain
string
card_name
string
image
object
width
number
height
number
url
string
alt
string
cursor
required
object
top
required
string
nullable
bottom
required
string
nullable
Example 
{
  "results": [
    {
      "type": "status",
      "quote": {
        "type": "tombstone",
        "provider": "twitter",
        "reason": "deleted",
        "author": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        }
      },
      "author": {
        "type": "profile",
        "verification": {
          "type": "organization"
        }
      },
      "media": {
        "external": {
          "type": "video"
        },
        "photos": [
          {
            "type": "photo"
          }
        ],
        "videos": [
          {
            "type": "video",
            "formats": [
              {
                "container": "mp4",
                "codec": "h264"
              }
            ],
            "publisher": {
              "type": "profile",
              "verification": {
                "type": "organization"
              }
            }
          }
        ],
        "all": [
          {
            "type": "photo"
          }
        ],
        "mosaic": {
          "type": "mosaic_photo"
        },
        "broadcast": {
          "state": "LIVE",
          "orientation": "landscape"
        }
      },
      "embed_card": "tweet",
      "provider": "twitter",
      "community": {
        "admin": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        },
        "creator": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        },
        "join_policy": "Open",
        "invites_policy": "MemberInvitesAllowed"
      },
      "article": {
        "cover_media": {
          "media_info": {
            "__typename": "ApiImage"
          }
        },
        "content": {
          "blocks": [],
          "entityMap": []
        },
        "media_entities": [
          {
            "media_info": {
              "__typename": "ApiImage"
            }
          }
        ]
      }
    }
  ]
}

500

Section titled “500 ”

Upstream or processing error

Media type application/json
object
code
required
number
results
required
Array<object>
object
type
required

Discriminator: single post/status (API v2).

string
Allowed values: status
id
required
string
url
required
string
text
required
string
created_at
required
string
created_timestamp
required
number
likes
required
number
reposts
required
number
quotes
required
number
replies
required
number
quote
Any of:
APITwitterStatus (recursive)

Recursive reference — same shape as APITwitterStatus.

object
poll
object
choices
required
Array<object>
object
label
required
string
count
required
number
percentage
required
number
total_votes
required
number
ends_at
required
string
time_left_en
required
string
author
required
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
media
required
object
external
object
type
required
string
Allowed values: video
url
required
string
thumbnail_url
string
height
number
width
number
photos
Array<object>
object
id
string
format
string
type
required
string
Allowed values: photo gif
url
required
string
width
required
number
height
required
number
transcode_url
string
nullable
altText
string
videos
Array<object>
object
id
string
format
string
type
required
string
Allowed values: video gif
url
required
string
width
required
number
height
required
number
thumbnail_url
string
nullable
transcode_url
string
nullable
duration
required
number
filesize
number
formats
required
Array<object>
object
container
string
Allowed values: mp4 webm m3u8
codec
string
Allowed values: h264 hevc vp9 av1
bitrate
number
url
required
string
size
number
height
number
width
number
publisher
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
all
Array
Any of:
object
id
string
format
string
type
required
string
Allowed values: photo gif
url
required
string
width
required
number
height
required
number
transcode_url
string
nullable
altText
string
mosaic
object
id
string
format
string
type
required
string
Allowed values: mosaic_photo
url
required
string
width
required
number
height
required
number
formats
required
object
webp
required
string
jpeg
required
string
broadcast
object
url
required
string
width
required
number
height
required
number
state
required
string
Allowed values: LIVE ENDED
broadcaster
required
object
username
required
string
display_name
required
string
id
required
string
stream
object
url
required
string
title
required
string
source
required
string
orientation
required
string
Allowed values: landscape portrait
broadcast_id
required
string
media_id
required
string
media_key
required
string
is_high_latency
required
boolean
thumbnail
required
object
original
required
object
url
required
string
small
object
url
required
string
medium
object
url
required
string
large
object
url
required
string
x_large
object
url
required
string
raw_text
required
object
text
required
string
display_text_range
required
Array<number>
>= 2 items <= 2 items
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
lang
required
string
nullable
translation
object
text
required
string
source_lang
required
string
source_lang_en
required
string
target_lang
required
string
provider
required
string
possibly_sensitive
required
boolean
replying_to
required
object
screen_name
required

Handle or account id used in permalinks (@user on X).

string
status
required

Parent post id (X: snowflake; Bluesky: record key).

string
url

Permalink to the parent post when known.

string
profile_url

Permalink to the parent author profile when known.

string
display_name

Display name of the parent author when known.

string
source
required
string
nullable
embed_card
required
string
Allowed values: tweet summary summary_large_image player
provider
required
string
Allowed values: twitter
views
number
nullable
bookmarks
number
nullable
community
object
id
required
string
name
required
string
description
required
string
created_at
required
string
search_tags
required
Array<string>
is_nsfw
required
boolean
topic
required
string
nullable
admin
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
creator
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
join_policy
required
string
Allowed values: Open Closed
invites_policy
required
string
Allowed values: MemberInvitesAllowed MemberInvitesDisabled
is_pinned
required
boolean
article
object
created_at
required
string
modified_at
string
id
required
string
title
required
string
preview_text
required
string
cover_media
required
object
id
required
string
media_key
required
string
media_id
required
string
media_info
required
Any of:
object
__typename
required
string
Allowed values: ApiImage
original_img_height
required
number
original_img_width
required
number
original_img_url
required
string
color_info
required
object
palette
required
Array<object>
object
percentage
required
number
rgb
required
object
red
required
number
green
required
number
blue
required
number
content
required
object
blocks
Array<object>
default:
object
key
required
string
data
required
object
key
additional properties
nullable
entityRanges
required
Array<object>
object
key
required
number
length
required
number
offset
required
number
inlineStyleRanges
required
Array<object>
object
length
required
number
offset
required
number
style
required
string
text
required
string
type
required
string
entityMap
Array
default:
Any of:
object
key
required
string
value
required
object
type
required
string
Allowed values: MARKDOWN
mutability
required
string
Allowed values: Mutable
data
required
object
entityKey
required
string
markdown
required
string
media_entities
required
Array<object>
object
id
required
string
media_key
required
string
media_id
required
string
media_info
required
Any of:
object
__typename
required
string
Allowed values: ApiImage
original_img_height
required
number
original_img_width
required
number
original_img_url
required
string
color_info
required
object
palette
required
Array<object>
object
percentage
required
number
rgb
required
object
red
required
number
green
required
number
blue
required
number
is_note_tweet
required
boolean
community_note
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
reposted_by
required
object
id
required
string
name
required
string
screen_name
required
string
avatar_url
string
nullable
url
string
card
object
url
required
string
title
string
description
string
domain
string
card_name
string
image
object
width
number
height
number
url
string
alt
string
cursor
required
object
top
required
string
nullable
bottom
required
string
nullable
Example 
{
  "results": [
    {
      "type": "status",
      "quote": {
        "type": "tombstone",
        "provider": "twitter",
        "reason": "deleted",
        "author": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        }
      },
      "author": {
        "type": "profile",
        "verification": {
          "type": "organization"
        }
      },
      "media": {
        "external": {
          "type": "video"
        },
        "photos": [
          {
            "type": "photo"
          }
        ],
        "videos": [
          {
            "type": "video",
            "formats": [
              {
                "container": "mp4",
                "codec": "h264"
              }
            ],
            "publisher": {
              "type": "profile",
              "verification": {
                "type": "organization"
              }
            }
          }
        ],
        "all": [
          {
            "type": "photo"
          }
        ],
        "mosaic": {
          "type": "mosaic_photo"
        },
        "broadcast": {
          "state": "LIVE",
          "orientation": "landscape"
        }
      },
      "embed_card": "tweet",
      "provider": "twitter",
      "community": {
        "admin": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        },
        "creator": {
          "type": "profile",
          "verification": {
            "type": "organization"
          }
        },
        "join_policy": "Open",
        "invites_policy": "MemberInvitesAllowed"
      },
      "article": {
        "cover_media": {
          "media_info": {
            "__typename": "ApiImage"
          }
        },
        "content": {
          "blocks": [],
          "entityMap": []
        },
        "media_entities": [
          {
            "media_info": {
              "__typename": "ApiImage"
            }
          }
        ]
      }
    }
  ]
}