Get Bookmarks

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

string

required

The ID of the authenticated source User for whom to return results. Unique identifier of this User. The value must be the same as the authenticated user.

Example:

"2244994945"

Query Parameters

max_results

integer<int32>

The maximum number of results.

Required range: 1 <= x <= 100

pagination_token

string

This parameter is used to get the next 'page' of results. A base36 pagination token.

Minimum string length: 1

tweet.fields

enum<string>[]

A comma separated list of Tweet fields to display. The fields available for a Tweet object.

Minimum array length: 1

Available options:

article,

attachments,

author_id,

card_uri,

community_id,

context_annotations,

conversation_id,

created_at,

display_text_range,

edit_controls,

edit_history_tweet_ids,

entities,

geo,

id,

in_reply_to_user_id,

lang,

media_metadata,

non_public_metrics,

note_tweet,

organic_metrics,

possibly_sensitive,

promoted_metrics,

public_metrics,

referenced_tweets,

reply_settings,

scopes,

source,

suggested_source_links,

text,

withheld

Example:

[
  "article",
  "attachments",
  "author_id",
  "card_uri",
  "community_id",
  "context_annotations",
  "conversation_id",
  "created_at",
  "display_text_range",
  "edit_controls",
  "edit_history_tweet_ids",
  "entities",
  "geo",
  "id",
  "in_reply_to_user_id",
  "lang",
  "media_metadata",
  "non_public_metrics",
  "note_tweet",
  "organic_metrics",
  "possibly_sensitive",
  "promoted_metrics",
  "public_metrics",
  "referenced_tweets",
  "reply_settings",
  "scopes",
  "source",
  "suggested_source_links",
  "text",
  "withheld"
]

expansions

enum<string>[]

A comma separated list of fields to expand. The list of fields you can expand for a Tweet object. If the field has an ID, it can be expanded into a full object.

Minimum array length: 1

Available options:

article.cover_media,

article.media_entities,

attachments.media_keys,

attachments.media_source_tweet,

attachments.poll_ids,

author_id,

edit_history_tweet_ids,

entities.mentions.username,

geo.place_id,

in_reply_to_user_id,

entities.note.mentions.username,

referenced_tweets.id,

referenced_tweets.id.attachments.media_keys,

referenced_tweets.id.author_id

Example:

[
  "article.cover_media",
  "article.media_entities",
  "attachments.media_keys",
  "attachments.media_source_tweet",
  "attachments.poll_ids",
  "author_id",
  "edit_history_tweet_ids",
  "entities.mentions.username",
  "geo.place_id",
  "in_reply_to_user_id",
  "entities.note.mentions.username",
  "referenced_tweets.id",
  "referenced_tweets.id.attachments.media_keys",
  "referenced_tweets.id.author_id"
]

media.fields

enum<string>[]

A comma separated list of Media fields to display. The fields available for a Media object.

Minimum array length: 1

Available options:

alt_text,

duration_ms,

height,

media_key,

non_public_metrics,

organic_metrics,

preview_image_url,

promoted_metrics,

public_metrics,

type,

url,

variants,

width

Example:

[
  "alt_text",
  "duration_ms",
  "height",
  "media_key",
  "non_public_metrics",
  "organic_metrics",
  "preview_image_url",
  "promoted_metrics",
  "public_metrics",
  "type",
  "url",
  "variants",
  "width"
]

poll.fields

enum<string>[]

A comma separated list of Poll fields to display. The fields available for a Poll object.

Minimum array length: 1

Available options:

duration_minutes,

end_datetime,

id,

options,

voting_status

Example:

[
  "duration_minutes",
  "end_datetime",
  "id",
  "options",
  "voting_status"
]

user.fields

enum<string>[]

A comma separated list of User fields to display. The fields available for a User object.

Minimum array length: 1

Available options:

affiliation,

confirmed_email,

connection_status,

created_at,

description,

entities,

id,

is_identity_verified,

location,

most_recent_tweet_id,

name,

parody,

pinned_tweet_id,

profile_banner_url,

profile_image_url,

protected,

public_metrics,

receives_your_dm,

subscription,

subscription_type,

url,

username,

verified,

verified_followers_count,

verified_type,

withheld

Example:

[
  "affiliation",
  "confirmed_email",
  "connection_status",
  "created_at",
  "description",
  "entities",
  "id",
  "is_identity_verified",
  "location",
  "most_recent_tweet_id",
  "name",
  "parody",
  "pinned_tweet_id",
  "profile_banner_url",
  "profile_image_url",
  "protected",
  "public_metrics",
  "receives_your_dm",
  "subscription",
  "subscription_type",
  "url",
  "username",
  "verified",
  "verified_followers_count",
  "verified_type",
  "withheld"
]

place.fields

enum<string>[]

A comma separated list of Place fields to display. The fields available for a Place object.

Minimum array length: 1

Available options:

contained_within,

country,

country_code,

full_name,

geo,

id,

name,

place_type

Example:

[
  "contained_within",
  "country",
  "country_code",
  "full_name",
  "geo",
  "id",
  "name",
  "place_type"
]

Response

The request has succeeded.

data

object[]

Minimum array length: 1

Show child attributes

data.attachments

object

Specifies the type of attachments (if any) present in this Tweet.

Show child attributes

data.attachments.media_keys

string[]

A list of Media Keys for each one of the media attachments (if media are attached).

Minimum array length: 1

The Media Key identifier for this attachment.

data.attachments.media_source_tweet_id

string[]

A list of Posts the media on this Tweet was originally posted in. For example, if the media on a tweet is re-used in another Tweet, this refers to the original, source Tweet..

Minimum array length: 1

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

data.attachments.poll_ids

string[]

A list of poll IDs (if polls are attached).

Minimum array length: 1

Unique identifier of this poll.

data.author_id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

data.community_id

string

The unique identifier of this Community.

Example:

"1146654567674912769"

data.context_annotations

object[]

Minimum array length: 1

Show child attributes

data.context_annotations.domain

object

required

Represents the data for the context annotation domain.

Show child attributes

data.context_annotations.domain.id

string

required

The unique id for a context annotation domain.

data.context_annotations.domain.description

string

Description of the context annotation domain.

data.context_annotations.domain.name

string

Name of the context annotation domain.

data.context_annotations.entity

object

required

Represents the data for the context annotation entity.

Show child attributes

data.context_annotations.entity.id

string

required

The unique id for a context annotation entity.

data.context_annotations.entity.description

string

Description of the context annotation entity.

data.context_annotations.entity.name

string

Name of the context annotation entity.

data.conversation_id

string

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

data.created_at

string<date-time>

Creation time of the Tweet.

Example:

"2021-01-06T18:40:40.000Z"

data.display_text_range

integer[]

Represent a boundary range (start and end zero-based indices) for the portion of text that is displayed for a post. start must be smaller than end. The start index is inclusive, the end index is exclusive.

Required array length: 2 elements

Required range: x >= 0

data.edit_controls

object

Show child attributes

data.edit_controls.editable_until

string<date-time>

required

Time when Tweet is no longer editable.

Example:

"2021-01-06T18:40:40.000Z"

data.edit_controls.edits_remaining

integer

required

Number of times this Tweet can be edited.

data.edit_controls.is_edit_eligible

boolean

required

Indicates if this Tweet is eligible to be edited.

Example:

false

data.edit_history_tweet_ids

string[]

A list of Tweet Ids in this Tweet chain.

Minimum array length: 1

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

data.entities

object

Show child attributes

data.entities.annotations

object[]

Minimum array length: 1

Show child attributes

data.entities.annotations.end

integer

required

Index (zero-based) at which position this entity ends. The index is inclusive.

Required range: x >= 0

Example:

61

data.entities.annotations.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.entities.annotations.normalized_text

string

Text used to determine annotation.

Example:

"Barack Obama"

data.entities.annotations.probability

number<double>

Confidence factor for annotation type.

Required range: 0 <= x <= 1

data.entities.annotations.type

string

Annotation type.

Example:

"Person"

data.entities.cashtags

object[]

Minimum array length: 1

Show child attributes

data.entities.cashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.entities.cashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.entities.cashtags.tag

string

required

Example:

"TWTR"

data.entities.hashtags

object[]

Minimum array length: 1

Show child attributes

data.entities.hashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.entities.hashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.entities.hashtags.tag

string

required

The text of the Hashtag.

Example:

"MondayMotivation"

data.entities.mentions

object[]

Minimum array length: 1

Show child attributes

data.entities.mentions.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.entities.mentions.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.entities.mentions.username

string

required

The X handle (screen name) of this user.

data.entities.mentions.id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

data.entities.urls

object[]

Minimum array length: 1

Show child attributes

data.entities.urls.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.entities.urls.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.entities.urls.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.entities.urls.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

data.entities.urls.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

data.entities.urls.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.entities.urls.images

object[]

Minimum array length: 1

Show child attributes

data.entities.urls.images.height

integer

The height of the media in pixels.

Required range: x >= 0

data.entities.urls.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.entities.urls.images.width

integer

The width of the media in pixels.

Required range: x >= 0

data.entities.urls.media_key

string

The Media Key identifier for this attachment.

data.entities.urls.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

data.entities.urls.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

data.entities.urls.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

data.geo

object

The location tagged on the Tweet, if the user provided one.

Show child attributes

data.geo.coordinates

object

A GeoJson Point geometry object.

Show child attributes

data.geo.coordinates.coordinates

number[]

required

A GeoJson Position in the format [longitude,latitude].

Required array length: 2 elements

Example:

[-105.18816086351444, 40.247749999999996]

data.geo.coordinates.type

enum<string>

required

Available options:

Point

Example:

"Point"

data.geo.place_id

string

The identifier for this place.

Example:

"f7eb2fa2fea288b1"

data.id

string

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

data.in_reply_to_user_id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

data.lang

string

Language of the Tweet, if detected by X. Returned as a BCP47 language tag.

Example:

"en"

data.non_public_metrics

object

Nonpublic engagement metrics for the Tweet at the time of the request.

Show child attributes

data.non_public_metrics.impression_count

integer<int32>

Number of times this Tweet has been viewed.

data.note_tweet

object

The full-content of the Tweet, including text beyond 280 characters.

Show child attributes

data.note_tweet.entities

object

Show child attributes

data.note_tweet.entities.cashtags

object[]

Minimum array length: 1

Show child attributes

data.note_tweet.entities.cashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.note_tweet.entities.cashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.note_tweet.entities.cashtags.tag

string

required

Example:

"TWTR"

data.note_tweet.entities.hashtags

object[]

Minimum array length: 1

Show child attributes

data.note_tweet.entities.hashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.note_tweet.entities.hashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.note_tweet.entities.hashtags.tag

string

required

The text of the Hashtag.

Example:

"MondayMotivation"

data.note_tweet.entities.mentions

object[]

Minimum array length: 1

Show child attributes

data.note_tweet.entities.mentions.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.note_tweet.entities.mentions.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.note_tweet.entities.mentions.username

string

required

The X handle (screen name) of this user.

data.note_tweet.entities.mentions.id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

data.note_tweet.entities.urls

object[]

Minimum array length: 1

Show child attributes

data.note_tweet.entities.urls.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.note_tweet.entities.urls.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.note_tweet.entities.urls.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.note_tweet.entities.urls.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

data.note_tweet.entities.urls.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

data.note_tweet.entities.urls.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.note_tweet.entities.urls.images

object[]

Minimum array length: 1

Show child attributes

data.note_tweet.entities.urls.images.height

integer

The height of the media in pixels.

Required range: x >= 0

data.note_tweet.entities.urls.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.note_tweet.entities.urls.images.width

integer

The width of the media in pixels.

Required range: x >= 0

data.note_tweet.entities.urls.media_key

string

The Media Key identifier for this attachment.

data.note_tweet.entities.urls.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

data.note_tweet.entities.urls.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

data.note_tweet.entities.urls.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

data.note_tweet.text

string

The note content of the Tweet.

Example:

"Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"

data.organic_metrics

object

Organic nonpublic engagement metrics for the Tweet at the time of the request.

Show child attributes

data.organic_metrics.impression_count

integer

required

Number of times this Tweet has been viewed.

data.organic_metrics.like_count

integer

required

Number of times this Tweet has been liked.

data.organic_metrics.reply_count

integer

required

Number of times this Tweet has been replied to.

data.organic_metrics.retweet_count

integer

required

Number of times this Tweet has been Retweeted.

data.possibly_sensitive

boolean

Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences.

Example:

false

data.promoted_metrics

object

Promoted nonpublic engagement metrics for the Tweet at the time of the request.

Show child attributes

data.promoted_metrics.impression_count

integer<int32>

Number of times this Tweet has been viewed.

data.promoted_metrics.like_count

integer<int32>

Number of times this Tweet has been liked.

data.promoted_metrics.reply_count

integer<int32>

Number of times this Tweet has been replied to.

data.promoted_metrics.retweet_count

integer<int32>

Number of times this Tweet has been Retweeted.

data.public_metrics

object

Engagement metrics for the Tweet at the time of the request.

Show child attributes

data.public_metrics.bookmark_count

integer<int32>

required

Number of times this Tweet has been bookmarked.

data.public_metrics.impression_count

integer<int32>

required

Number of times this Tweet has been viewed.

data.public_metrics.like_count

integer

required

Number of times this Tweet has been liked.

data.public_metrics.reply_count

integer

required

Number of times this Tweet has been replied to.

data.public_metrics.retweet_count

integer

required

Number of times this Tweet has been Retweeted.

data.public_metrics.quote_count

integer

Number of times this Tweet has been quoted.

data.referenced_tweets

object[]

A list of Posts this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent.

Minimum array length: 1

Show child attributes

data.referenced_tweets.id

string

required

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

data.referenced_tweets.type

enum<string>

required

Available options:

retweeted,

quoted,

replied_to

data.reply_settings

enum<string>

Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, subscribers, verified and following.

Available options:

everyone,

mentionedUsers,

following,

other,

subscribers,

verified

data.scopes

object

The scopes for this tweet

Show child attributes

data.scopes.followers

boolean

Indicates if this Tweet is viewable by followers without the Tweet ID

Example:

false

data.source

string

This is deprecated.

data.suggested_source_links

object[]

Show child attributes

data.suggested_source_links.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

data.suggested_source_links.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

data.suggested_source_links.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.suggested_source_links.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

data.suggested_source_links.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

data.suggested_source_links.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.suggested_source_links.images

object[]

Minimum array length: 1

Show child attributes

data.suggested_source_links.images.height

integer

The height of the media in pixels.

Required range: x >= 0

data.suggested_source_links.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

data.suggested_source_links.images.width

integer

The width of the media in pixels.

Required range: x >= 0

data.suggested_source_links.media_key

string

The Media Key identifier for this attachment.

data.suggested_source_links.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

data.suggested_source_links.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

data.suggested_source_links.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

data.text

string

The content of the Tweet.

Example:

"Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"

data.username

string

The X handle (screen name) of this user.

data.withheld

object

Indicates withholding details for withheld content.

Show child attributes

data.withheld.copyright

boolean

required

Indicates if the content is being withheld for on the basis of copyright infringement.

data.withheld.country_codes

string[]

required

Provides a list of countries where this content is not available.

Minimum array length: 1

A two-letter ISO 3166-1 alpha-2 country code.

data.withheld.scope

enum<string>

Indicates whether the content being withheld is the tweet or a user.

Available options:

tweet,

user

errors

object[]

Minimum array length: 1

Show child attributes

errors.title

string

required

errors.type

string

required

errors.detail

string

errors.status

integer

includes

object

Show child attributes

includes.media

object[]

Minimum array length: 1

Show child attributes

includes.media.type

string

required

includes.media.height

integer

The height of the media in pixels.

Required range: x >= 0

includes.media.media_key

string

The Media Key identifier for this attachment.

includes.media.width

integer

The width of the media in pixels.

Required range: x >= 0

includes.places

object[]

Minimum array length: 1

Show child attributes

includes.places.full_name

string

required

The full name of this place.

Example:

"Lakewood, CO"

includes.places.id

string

required

The identifier for this place.

Example:

"f7eb2fa2fea288b1"

includes.places.contained_within

string[]

Minimum array length: 1

The identifier for this place.

includes.places.country

string

The full name of the county in which this place exists.

Example:

"United States"

includes.places.country_code

string

A two-letter ISO 3166-1 alpha-2 country code.

Example:

"US"

includes.places.geo

object

Show child attributes

includes.places.geo.bbox

number<double>[]

required

Required array length: 4 elements

Required range: -180 <= x <= 180

Example:

[
  -105.193475,
  39.60973,
  -105.053164,
  39.761974
]

includes.places.geo.properties

object

required

includes.places.geo.type

enum<string>

required

Available options:

Feature

includes.places.geo.geometry

object

A GeoJson Point geometry object.

Show child attributes

includes.places.geo.geometry.coordinates

number[]

required

A GeoJson Position in the format [longitude,latitude].

Required array length: 2 elements

Example:

[-105.18816086351444, 40.247749999999996]

includes.places.geo.geometry.type

enum<string>

required

Available options:

Point

Example:

"Point"

includes.places.name

string

The human readable name of this place.

Example:

"Lakewood"

includes.places.place_type

enum<string>

Available options:

poi,

neighborhood,

city,

admin,

country,

unknown

Example:

"city"

includes.polls

object[]

Minimum array length: 1

Show child attributes

includes.polls.id

string

required

Unique identifier of this poll.

Example:

"1365059861688410112"

includes.polls.options

object[]

required

Required array length: 2 - 4 elements

Show child attributes

includes.polls.options.label

string

required

The text of a poll choice.

Required string length: 1 - 25

includes.polls.options.position

integer

required

Position of this choice in the poll.

includes.polls.options.votes

integer

required

Number of users who voted for this choice.

includes.polls.duration_minutes

integer<int32>

Required range: 5 <= x <= 10080

includes.polls.end_datetime

string<date-time>

includes.polls.voting_status

enum<string>

Available options:

open,

closed

includes.topics

object[]

Minimum array length: 1

Show child attributes

includes.topics.id

string

required

Unique identifier of this Topic.

includes.topics.name

string

required

The name of the given topic.

Example:

"Technology"

includes.topics.description

string

The description of the given topic.

Example:

"All about technology"

includes.tweets

object[]

Minimum array length: 1

Show child attributes

includes.tweets.attachments

object

Specifies the type of attachments (if any) present in this Tweet.

Show child attributes

includes.tweets.attachments.media_keys

string[]

A list of Media Keys for each one of the media attachments (if media are attached).

Minimum array length: 1

The Media Key identifier for this attachment.

includes.tweets.attachments.media_source_tweet_id

string[]

A list of Posts the media on this Tweet was originally posted in. For example, if the media on a tweet is re-used in another Tweet, this refers to the original, source Tweet..

Minimum array length: 1

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

includes.tweets.attachments.poll_ids

string[]

A list of poll IDs (if polls are attached).

Minimum array length: 1

Unique identifier of this poll.

includes.tweets.author_id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

includes.tweets.community_id

string

The unique identifier of this Community.

Example:

"1146654567674912769"

includes.tweets.context_annotations

object[]

Minimum array length: 1

Show child attributes

includes.tweets.context_annotations.domain

object

required

Represents the data for the context annotation domain.

Show child attributes

includes.tweets.context_annotations.domain.id

string

required

The unique id for a context annotation domain.

includes.tweets.context_annotations.domain.description

string

Description of the context annotation domain.

includes.tweets.context_annotations.domain.name

string

Name of the context annotation domain.

includes.tweets.context_annotations.entity

object

required

Represents the data for the context annotation entity.

Show child attributes

includes.tweets.context_annotations.entity.id

string

required

The unique id for a context annotation entity.

includes.tweets.context_annotations.entity.description

string

Description of the context annotation entity.

includes.tweets.context_annotations.entity.name

string

Name of the context annotation entity.

includes.tweets.conversation_id

string

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

includes.tweets.created_at

string<date-time>

Creation time of the Tweet.

Example:

"2021-01-06T18:40:40.000Z"

includes.tweets.display_text_range

integer[]

Required array length: 2 elements

Required range: x >= 0

includes.tweets.edit_controls

object

Show child attributes

includes.tweets.edit_controls.editable_until

string<date-time>

required

Time when Tweet is no longer editable.

Example:

"2021-01-06T18:40:40.000Z"

includes.tweets.edit_controls.edits_remaining

integer

required

Number of times this Tweet can be edited.

includes.tweets.edit_controls.is_edit_eligible

boolean

required

Indicates if this Tweet is eligible to be edited.

Example:

false

includes.tweets.edit_history_tweet_ids

string[]

A list of Tweet Ids in this Tweet chain.

Minimum array length: 1

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

includes.tweets.entities

object

Show child attributes

includes.tweets.entities.annotations

object[]

Minimum array length: 1

Show child attributes

includes.tweets.entities.annotations.end

integer

required

Index (zero-based) at which position this entity ends. The index is inclusive.

Required range: x >= 0

Example:

61

includes.tweets.entities.annotations.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.entities.annotations.normalized_text

string

Text used to determine annotation.

Example:

"Barack Obama"

includes.tweets.entities.annotations.probability

number<double>

Confidence factor for annotation type.

Required range: 0 <= x <= 1

includes.tweets.entities.annotations.type

string

Annotation type.

Example:

"Person"

includes.tweets.entities.cashtags

object[]

Minimum array length: 1

Show child attributes

includes.tweets.entities.cashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.entities.cashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.entities.cashtags.tag

string

required

Example:

"TWTR"

includes.tweets.entities.hashtags

object[]

Minimum array length: 1

Show child attributes

includes.tweets.entities.hashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.entities.hashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.entities.hashtags.tag

string

required

The text of the Hashtag.

Example:

"MondayMotivation"

includes.tweets.entities.mentions

object[]

Minimum array length: 1

Show child attributes

includes.tweets.entities.mentions.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.entities.mentions.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.entities.mentions.username

string

required

The X handle (screen name) of this user.

includes.tweets.entities.mentions.id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

includes.tweets.entities.urls

object[]

Minimum array length: 1

Show child attributes

includes.tweets.entities.urls.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.entities.urls.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.entities.urls.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.entities.urls.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

includes.tweets.entities.urls.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

includes.tweets.entities.urls.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.entities.urls.images

object[]

Minimum array length: 1

Show child attributes

includes.tweets.entities.urls.images.height

integer

The height of the media in pixels.

Required range: x >= 0

includes.tweets.entities.urls.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.entities.urls.images.width

integer

The width of the media in pixels.

Required range: x >= 0

includes.tweets.entities.urls.media_key

string

The Media Key identifier for this attachment.

includes.tweets.entities.urls.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

includes.tweets.entities.urls.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

includes.tweets.entities.urls.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

includes.tweets.geo

object

The location tagged on the Tweet, if the user provided one.

Show child attributes

includes.tweets.geo.coordinates

object

A GeoJson Point geometry object.

Show child attributes

includes.tweets.geo.coordinates.coordinates

number[]

required

A GeoJson Position in the format [longitude,latitude].

Required array length: 2 elements

Example:

[-105.18816086351444, 40.247749999999996]

includes.tweets.geo.coordinates.type

enum<string>

required

Available options:

Point

Example:

"Point"

includes.tweets.geo.place_id

string

The identifier for this place.

Example:

"f7eb2fa2fea288b1"

includes.tweets.id

string

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

includes.tweets.in_reply_to_user_id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

includes.tweets.lang

string

Language of the Tweet, if detected by X. Returned as a BCP47 language tag.

Example:

"en"

includes.tweets.non_public_metrics

object

Nonpublic engagement metrics for the Tweet at the time of the request.

Show child attributes

includes.tweets.non_public_metrics.impression_count

integer<int32>

Number of times this Tweet has been viewed.

includes.tweets.note_tweet

object

The full-content of the Tweet, including text beyond 280 characters.

Show child attributes

includes.tweets.note_tweet.entities

object

Show child attributes

includes.tweets.note_tweet.entities.cashtags

object[]

Minimum array length: 1

Show child attributes

includes.tweets.note_tweet.entities.cashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.note_tweet.entities.cashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.note_tweet.entities.cashtags.tag

string

required

Example:

"TWTR"

includes.tweets.note_tweet.entities.hashtags

object[]

Minimum array length: 1

Show child attributes

includes.tweets.note_tweet.entities.hashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.note_tweet.entities.hashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.note_tweet.entities.hashtags.tag

string

required

The text of the Hashtag.

Example:

"MondayMotivation"

includes.tweets.note_tweet.entities.mentions

object[]

Minimum array length: 1

Show child attributes

includes.tweets.note_tweet.entities.mentions.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.note_tweet.entities.mentions.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.note_tweet.entities.mentions.username

string

required

The X handle (screen name) of this user.

includes.tweets.note_tweet.entities.mentions.id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

includes.tweets.note_tweet.entities.urls

object[]

Minimum array length: 1

Show child attributes

includes.tweets.note_tweet.entities.urls.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.note_tweet.entities.urls.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.note_tweet.entities.urls.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.note_tweet.entities.urls.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

includes.tweets.note_tweet.entities.urls.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

includes.tweets.note_tweet.entities.urls.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.note_tweet.entities.urls.images

object[]

Minimum array length: 1

Show child attributes

includes.tweets.note_tweet.entities.urls.images.height

integer

The height of the media in pixels.

Required range: x >= 0

includes.tweets.note_tweet.entities.urls.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.note_tweet.entities.urls.images.width

integer

The width of the media in pixels.

Required range: x >= 0

includes.tweets.note_tweet.entities.urls.media_key

string

The Media Key identifier for this attachment.

includes.tweets.note_tweet.entities.urls.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

includes.tweets.note_tweet.entities.urls.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

includes.tweets.note_tweet.entities.urls.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

includes.tweets.note_tweet.text

string

The note content of the Tweet.

Example:

"Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"

includes.tweets.organic_metrics

object

Organic nonpublic engagement metrics for the Tweet at the time of the request.

Show child attributes

includes.tweets.organic_metrics.impression_count

integer

required

Number of times this Tweet has been viewed.

includes.tweets.organic_metrics.like_count

integer

required

Number of times this Tweet has been liked.

includes.tweets.organic_metrics.reply_count

integer

required

Number of times this Tweet has been replied to.

includes.tweets.organic_metrics.retweet_count

integer

required

Number of times this Tweet has been Retweeted.

includes.tweets.possibly_sensitive

boolean

Indicates if this Tweet contains URLs marked as sensitive, for example content suitable for mature audiences.

Example:

false

includes.tweets.promoted_metrics

object

Promoted nonpublic engagement metrics for the Tweet at the time of the request.

Show child attributes

includes.tweets.promoted_metrics.impression_count

integer<int32>

Number of times this Tweet has been viewed.

includes.tweets.promoted_metrics.like_count

integer<int32>

Number of times this Tweet has been liked.

includes.tweets.promoted_metrics.reply_count

integer<int32>

Number of times this Tweet has been replied to.

includes.tweets.promoted_metrics.retweet_count

integer<int32>

Number of times this Tweet has been Retweeted.

includes.tweets.public_metrics

object

Engagement metrics for the Tweet at the time of the request.

Show child attributes

includes.tweets.public_metrics.bookmark_count

integer<int32>

required

Number of times this Tweet has been bookmarked.

includes.tweets.public_metrics.impression_count

integer<int32>

required

Number of times this Tweet has been viewed.

includes.tweets.public_metrics.like_count

integer

required

Number of times this Tweet has been liked.

includes.tweets.public_metrics.reply_count

integer

required

Number of times this Tweet has been replied to.

includes.tweets.public_metrics.retweet_count

integer

required

Number of times this Tweet has been Retweeted.

includes.tweets.public_metrics.quote_count

integer

Number of times this Tweet has been quoted.

includes.tweets.referenced_tweets

object[]

A list of Posts this Tweet refers to. For example, if the parent Tweet is a Retweet, a Quoted Tweet or a Reply, it will include the related Tweet referenced to by its parent.

Minimum array length: 1

Show child attributes

includes.tweets.referenced_tweets.id

string

required

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

includes.tweets.referenced_tweets.type

enum<string>

required

Available options:

retweeted,

quoted,

replied_to

includes.tweets.reply_settings

enum<string>

Shows who can reply a Tweet. Fields returned are everyone, mentioned_users, subscribers, verified and following.

Available options:

everyone,

mentionedUsers,

following,

other,

subscribers,

verified

includes.tweets.scopes

object

The scopes for this tweet

Show child attributes

includes.tweets.scopes.followers

boolean

Indicates if this Tweet is viewable by followers without the Tweet ID

Example:

false

includes.tweets.source

string

This is deprecated.

includes.tweets.suggested_source_links

object[]

Show child attributes

includes.tweets.suggested_source_links.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.tweets.suggested_source_links.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.tweets.suggested_source_links.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.suggested_source_links.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

includes.tweets.suggested_source_links.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

includes.tweets.suggested_source_links.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.suggested_source_links.images

object[]

Minimum array length: 1

Show child attributes

includes.tweets.suggested_source_links.images.height

integer

The height of the media in pixels.

Required range: x >= 0

includes.tweets.suggested_source_links.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.tweets.suggested_source_links.images.width

integer

The width of the media in pixels.

Required range: x >= 0

includes.tweets.suggested_source_links.media_key

string

The Media Key identifier for this attachment.

includes.tweets.suggested_source_links.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

includes.tweets.suggested_source_links.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

includes.tweets.suggested_source_links.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

includes.tweets.text

string

The content of the Tweet.

Example:

"Learn how to use the user Tweet timeline and user mention timeline endpoints in the X API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"

includes.tweets.username

string

The X handle (screen name) of this user.

includes.tweets.withheld

object

Indicates withholding details for withheld content.

Show child attributes

includes.tweets.withheld.copyright

boolean

required

Indicates if the content is being withheld for on the basis of copyright infringement.

includes.tweets.withheld.country_codes

string[]

required

Provides a list of countries where this content is not available.

Minimum array length: 1

A two-letter ISO 3166-1 alpha-2 country code.

includes.tweets.withheld.scope

enum<string>

Indicates whether the content being withheld is the tweet or a user.

Available options:

tweet,

user

includes.users

object[]

Minimum array length: 1

Show child attributes

includes.users.id

string

required

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

includes.users.name

string

required

The friendly name of this User, as shown on their profile.

includes.users.username

string

required

The X handle (screen name) of this user.

includes.users.affiliation

object

Metadata about a user's affiliation.

Show child attributes

includes.users.affiliation.badge_url

string<uri>

The badge URL corresponding to the affiliation.

includes.users.affiliation.description

string

The description of the affiliation.

includes.users.affiliation.url

string<uri>

The URL, if available, to details about an affiliation.

includes.users.affiliation.user_id

string[]

Minimum array length: 1

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

includes.users.connection_status

enum<string>[]

Returns detailed information about the relationship between two users.

Type of connection between users.

Available options:

follow_request_received,

follow_request_sent,

blocking,

followed_by,

following,

muting

includes.users.created_at

string<date-time>

Creation time of this User.

includes.users.description

string

The text of this User's profile description (also known as bio), if the User provided one.

includes.users.entities

object

A list of metadata found in the User's profile description.

Show child attributes

includes.users.entities.description

object

Show child attributes

includes.users.entities.description.annotations

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.description.annotations.end

integer

required

Index (zero-based) at which position this entity ends. The index is inclusive.

Required range: x >= 0

Example:

61

includes.users.entities.description.annotations.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.users.entities.description.annotations.normalized_text

string

Text used to determine annotation.

Example:

"Barack Obama"

includes.users.entities.description.annotations.probability

number<double>

Confidence factor for annotation type.

Required range: 0 <= x <= 1

includes.users.entities.description.annotations.type

string

Annotation type.

Example:

"Person"

includes.users.entities.description.cashtags

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.description.cashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.users.entities.description.cashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.users.entities.description.cashtags.tag

string

required

Example:

"TWTR"

includes.users.entities.description.hashtags

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.description.hashtags.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.users.entities.description.hashtags.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.users.entities.description.hashtags.tag

string

required

The text of the Hashtag.

Example:

"MondayMotivation"

includes.users.entities.description.mentions

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.description.mentions.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.users.entities.description.mentions.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.users.entities.description.mentions.username

string

required

The X handle (screen name) of this user.

includes.users.entities.description.mentions.id

string

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"2244994945"

includes.users.entities.description.urls

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.description.urls.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.users.entities.description.urls.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.users.entities.description.urls.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.users.entities.description.urls.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

includes.users.entities.description.urls.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

includes.users.entities.description.urls.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.users.entities.description.urls.images

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.description.urls.images.height

integer

The height of the media in pixels.

Required range: x >= 0

includes.users.entities.description.urls.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.users.entities.description.urls.images.width

integer

The width of the media in pixels.

Required range: x >= 0

includes.users.entities.description.urls.media_key

string

The Media Key identifier for this attachment.

includes.users.entities.description.urls.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

includes.users.entities.description.urls.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

includes.users.entities.description.urls.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

includes.users.entities.url

object

Expanded details for the URL specified in the User's profile, with start and end indices.

Show child attributes

includes.users.entities.url.urls

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.url.urls.end

integer

required

Index (zero-based) at which position this entity ends. The index is exclusive.

Required range: x >= 0

Example:

61

includes.users.entities.url.urls.start

integer

required

Index (zero-based) at which position this entity starts. The index is inclusive.

Required range: x >= 0

Example:

50

includes.users.entities.url.urls.url

string<uri>

required

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.users.entities.url.urls.description

string

Description of the URL landing page.

Example:

"This is a description of the website."

includes.users.entities.url.urls.display_url

string

The URL as displayed in the X client.

Example:

"twittercommunity.com/t/introducing-…"

includes.users.entities.url.urls.expanded_url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.users.entities.url.urls.images

object[]

Minimum array length: 1

Show child attributes

includes.users.entities.url.urls.images.height

integer

The height of the media in pixels.

Required range: x >= 0

includes.users.entities.url.urls.images.url

string<uri>

A validly formatted URL.

Example:

"https://developer.twitter.com/en/docs/twitter-api"

includes.users.entities.url.urls.images.width

integer

The width of the media in pixels.

Required range: x >= 0

includes.users.entities.url.urls.media_key

string

The Media Key identifier for this attachment.

includes.users.entities.url.urls.status

integer

HTTP Status Code.

Required range: 100 <= x <= 599

includes.users.entities.url.urls.title

string

Title of the page the URL points to.

Example:

"Introducing the v2 follow lookup endpoints"

includes.users.entities.url.urls.unwound_url

string<uri>

Fully resolved url.

Example:

"https://twittercommunity.com/t/introducing-the-v2-follow-lookup-endpoints/147118"

includes.users.location

string

The location specified in the User's profile, if the User provided one. As this is a freeform value, it may not indicate a valid location, but it may be fuzzily evaluated when performing searches with location queries.

includes.users.most_recent_tweet_id

string

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

includes.users.pinned_tweet_id

string

Unique identifier of this Tweet. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Example:

"1346889436626259968"

includes.users.profile_banner_url

string<uri>

The URL to the profile banner for this User.

includes.users.profile_image_url

string<uri>

The URL to the profile image for this User.

includes.users.protected

boolean

Indicates if this User has chosen to protect their Posts (in other words, if this User's Posts are private).

includes.users.public_metrics

object

A list of metrics for this User.

Show child attributes

includes.users.public_metrics.followers_count

integer

required

Number of Users who are following this User.

includes.users.public_metrics.following_count

integer

required

Number of Users this User is following.

includes.users.public_metrics.listed_count

integer

required

The number of lists that include this User.

includes.users.public_metrics.tweet_count

integer

required

The number of Posts (including Retweets) posted by this User.

includes.users.public_metrics.like_count

integer

The number of likes created by this User.

includes.users.receives_your_dm

boolean

Indicates if you can send a DM to this User

includes.users.subscription_type

enum<string>

The X Blue subscription type of the user, eg: Basic, Premium, PremiumPlus or None.

Available options:

Basic,

Premium,

PremiumPlus,

None

includes.users.url

string

The URL specified in the User's profile.

includes.users.verified

boolean

Indicate if this User is a verified X User.

includes.users.verified_type

enum<string>

The X Blue verified type of the user, eg: blue, government, business or none.

Available options:

blue,

government,

business,

none

includes.users.withheld

object

Indicates withholding details for withheld content.

Show child attributes

includes.users.withheld.country_codes

string[]

required

Provides a list of countries where this content is not available.

Minimum array length: 1

A two-letter ISO 3166-1 alpha-2 country code.

includes.users.withheld.scope

enum<string>

Indicates that the content being withheld is a user.

Available options:

user

Overview

Posts

Users

Direct Messages

Likes

Lists

Spaces

Communities

Community Notes

Trends

News

Media

X Activity

Usage

Stream Connections

Compliance

Enterprise v2

Likes Streams

GNIP 2.0

Get Bookmarks

Authorizations

Path Parameters

Query Parameters

Response