GET /2/users/by/username/:username (2024)

NameTypeDescriptionid
DefaultstringUnique identifier of this user. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.name
DefaultstringThe friendly name of this user, as shown on their profile.username
DefaultstringThe Twitter handle (screen name) of this user.created_atdate (ISO 8601)Creation time of this account.

To return this field, add user.fields=created_at in the request's query parameter.

most_recent_tweet_idstringThe ID of the User's most recent Tweet

To return this field, add user.fields=most_recent_tweet_id in the request's query parameter.

protectedbooleanIndicates if this user has chosen to protect their Tweets (in other words, if this user's Tweets are private).

To return this field, add user.fields=protected in the request's query parameter.

withheldobjectContains withholding details for withheld content.

To return this field, add user.fields=withheld in the request's query parameter.

withheld.country_codesarrayProvides a list of countries where this user is not available.

To return this field, add user.fields=withheld.country_codes in the request's query parameter.

withheld.scopeenum (tweet, user)Indicates whether the content being withheld is a Tweet or a user (this API will return user).

To return this field, add user.fields=withheld.scope in the request's query parameter.

locationstringThe 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.

To return this field, add user.fields=location in the request's query parameter.

urlstringThe URL specified in the user's profile, if present.

To return this field, add user.fields=url in the request's query parameter.

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

To return this field, add user.fields=description in the request's query parameter.

verifiedbooleanIndicate if this user is a verified Twitter user.

To return this field, add user.fields=verified in the request's query parameter.

verified_typeenum (blue, business, government, none)Indicates the type of verification for the Twitter account.

To return this field, add user.fields=verified_type in the request's query parameter.

entitiesobjectThis object and its children fields contain details about text that has a special meaning in the user's description.

To return this field, add user.fields=entities in the request's query parameter.

entities.urlarrayContains details about the user's profile website.entities.url.urlsarrayContains details about the user's profile website.entities.url.urls.startintegerThe start position (zero-based) of the recognized user's profile website. All start indices are inclusive.entities.url.urls.endintegerThe end position (zero-based) of the recognized user's profile website. This end index is exclusive.entities.url.urls.urlstringThe URL in the format entered by the user.entities.url.urls.expanded_urlstringThe fully resolved URL.entities.url.urls.display_urlstringThe URL as displayed in the user's profile.entities.descriptionarrayContains details about URLs, Hashtags, Cashtags, or mentions located within a user's description.entities.description.urlsarrayContains details about any URLs included in the user's description.entities.description.urls.startintegerThe start position (zero-based) of the recognized URL in the user's description. All start indices are inclusive.entities.description.urls.endintegerThe end position (zero-based) of the recognized URL in the user's description. This end index is exclusive.entities.description.urls.urlstringThe URL in the format entered by the user.entities.description.urls.expanded_urlstringThe fully resolved URL.entities.description.urls.display_urlstringThe URL as displayed in the user's description.entities.description.hashtagsarrayContains details about text recognized as a Hashtag.entities.description.hashtags.startintegerThe start position (zero-based) of the recognized Hashtag within the Tweet. All start indices are inclusive.entities.description.hashtags.endintegerThe end position (zero-based) of the recognized Hashtag within the Tweet. This end index is exclusive.entities.description.hashtags.hashtagstringThe text of the Hashtag.entities.description.mentionsarrayContains details about text recognized as a user mention.entities.description.mentions.startintegerThe start position (zero-based) of the recognized user mention within the Tweet. All start indices are inclusive.entities.description.mentions.endintegerThe end position (zero-based) of the recognized user mention within the Tweet. This end index is exclusive.entities.description.mentions.usernamestringThe part of text recognized as a user mention.entities.description.cashtagsarrayContains details about text recognized as a Cashtag.entities.description.cashtags.startintegerThe start position (zero-based) of the recognized Cashtag within the Tweet. All start indices are inclusive.entities.description.cashtags.endintegerThe end position (zero-based) of the recognized Cashtag within the Tweet. This end index is exclusive.entities.description.cashtags.cashtagstringThe text of the Cashtag.profile_image_urlstringThe URL to the profile image for this user, as shown on the user's profile.public_metricsobjectContains details about activity for this user.public_metrics.followers_countintegerNumber of users who follow this user.public_metrics.following_countintegerNumber of users this user is following.public_metrics.tweet_countintegerNumber of Tweets (including Retweets) posted by this user.public_metrics.listed_countintegerNumber of lists that include this user.pinned_tweet_idstringUnique identifier of this user's pinned Tweet.

You can obtain the expanded object in includes.tweets by adding expansions=pinned_tweet_id in the request's query parameter.

includes.tweetsarrayWhen including the expansions=pinned_tweet_id parameter, this includes the pinned Tweets attached to the returned users' profiles in the form of Tweet objects with their default fields and any additional fields requested using the tweet.fields parameter, assuming there is a referenced Tweet present in the returned Tweet(s).errorsobjectContains details about errors that affected any of the requested users. See Status codes and error messages for more details.