Users
User lookup by usernames
This endpoint returns information about Users. Specify Users by their username.
get/2/users/by
Query parameters
usernamesstring[] required
A list of usernames, comma-separated.
user.fieldsstring[]
The fields available for a User object.
A comma separated list of User fields to display.
[ "created_at", "description", "entities", "id", "location", "name", "pinned_tweet_id", "profile_image_url", "protected", "public_metrics", "url", "username", "verified", "verified_type", "withheld" ]
expansionsstring[]
The list of fields you can expand for a User object. If the field has an ID, it can be expanded into a full object.
A comma separated list of fields to expand.
[ "pinned_tweet_id" ]
tweet.fieldsstring[]
The fields available for a Tweet object.
A comma separated list of Tweet fields to display.
[ "attachments", "author_id", "context_annotations", "conversation_id", "created_at", "edit_controls", "edit_history_tweet_ids", "entities", "geo", "id", "in_reply_to_user_id", "lang", "non_public_metrics", "organic_metrics", "possibly_sensitive", "promoted_metrics", "public_metrics", "referenced_tweets", "reply_settings", "source", "text", "withheld" ]
Response
The request has succeeded.
Example response
{
"data": [
{
"created_at": "2013-12-14T04:35:55Z",
"id": "2244994945",
"name": "Twitter Dev",
"protected": false,
"username": "TwitterDev"
}
],
"includes": {
"places": [
{
"contained_within": [
"f7eb2fa2fea288b1"
],
"country": "United States",
"country_code": "US",
"full_name": "Lakewood, CO",
"geo": {
"bbox": [
-105.193475,
39.60973,
-105.053164,
39.761974
],
"geometry": {
"coordinates": [
-105.18816086351444,
40.247749999999996
],
"type": "Point"
}
},
"id": "f7eb2fa2fea288b1",
"name": "Lakewood",
"place_type": "city"
}
],
"polls": [
{
"id": "1365059861688410112"
}
],
"topics": [
{
"description": "All about technology",
"name": "Technology"
}
],
"tweets": [
{
"author_id": "2244994945",
"created_at": "Wed Jan 06 18:40:40 +0000 2021",
"id": "1346889436626259968",
"text": "Learn how to use the user Tweet timeline and user mention timeline endpoints in the Twitter API v2 to explore Tweet\\u2026 https:\\/\\/t.co\\/56a0vZUx7i"
}
],
"users": [
{
"created_at": "2013-12-14T04:35:55Z",
"id": "2244994945",
"name": "Twitter Dev",
"protected": false,
"username": "TwitterDev"
}
]
}
}