User by Username

GET https://api.twitter.com/2/users/by/username/:username

This endpoint returns details about a user by username.

For full details, see the API reference for this endpoint.

Request Params

KeyDatatypeRequiredDescription
user.fieldsnullComma-separated fields for the user object.

Allowed values: created_at,description,entities,id,location,name,pinned_tweet_id,profile_image_url,protected,public_metrics,url,username,verified,withheld

Default values: id,name,username | | expansions | null | | Expansions enable requests to expand an ID into a full object in the includes response object.

Allowed value: pinned_tweet_id

Default value: none | | tweet.fields | null | | Comma-separated list of fields for the Tweet object. Expansion required.

Allowed values: attachments,author_id,context_annotations,conversation_id,created_at,entities,geo,id,in_reply_to_user_id,lang,non_public_metrics,organic_metrics,possibly_sensitive,promoted_metrics,public_metrics,referenced_tweets,source,text,withheld

Default values: id,text

OAuth1.0a User Context authorization required if any of the following fields are included in the request: non_public_metrics,organic_metrics,promoted_metrics |

RESPONSES

status: OK

{"errors":[{"detail":"Could not find user with username: [TwitterDec].","title":"Not Found Error","resource_type":"user","parameter":"username","value":"TwitterDec","type":"https://api.twitter.com/2/problems/resource-not-found"}]}