How to Use
1. Get Authenticated User Profile
xurl whoami
2. Look Up User by Username
Note: Replace
elonmuskwith the actual username. Leading@is optional.
xurl user elonmusk
3. Look Up User by ID
Note: Replace
12345with the actual user ID. You can obtain user IDs from other endpoint responses.
xurl /2/users/12345?user.fields=id,name,username,description,public_metrics,created_at
4. Look Up Multiple Users
Get profiles for multiple users at once (up to 100):
Note: Replace the IDs with actual user IDs, comma-separated.
xurl '/2/users?ids=12345,67890&user.fields=id,name,username,description,public_metrics'
5. Get a Tweet by ID
Note: Replace
1234567890with the actual tweet ID. Full URLs likehttps://x.com/user/status/1234567890also work.
xurl read 1234567890
6. Get Multiple Tweets
Get details for multiple tweets at once (up to 100):
Note: Replace the IDs with actual tweet IDs, comma-separated.
xurl '/2/tweets?ids=1234567890,0987654321&tweet.fields=created_at,public_metrics,author_id,text&expansions=author_id&user.fields=name,username'
7. Get User's Tweets (Timeline)
Get recent tweets posted by the authenticated user:
xurl timeline -n 10
Query parameters for raw API (if you need another user's timeline):
xurl '/2/users/USER_ID/tweets?max_results=10&tweet.fields=created_at,public_metrics,text&exclude=retweets,replies'
max_results- 5 to 100 (default: 10)start_time/end_time- ISO 8601 datetime filtersince_id/until_id- Tweet ID boundariespagination_token- For paginating resultsexclude- Comma-separated:retweets,replies
8. Get User's Mentions
xurl mentions -n 10
9. Search Recent Tweets
Search for tweets from the past 7 days:
Note: Replace the query with your search terms.
xurl search "openai lang:en -is:retweet" -n 10
Common search operators:
from:username- Tweets from a specific userto:username- Tweets replying to a user@username- Tweets mentioning a user#hashtag- Tweets with a hashtaghas:links/has:images/has:videos- Media filters-is:retweet- Exclude retweets-is:reply- Exclude replieslang:en- Filter by languageconversation_id:123- Tweets in a conversation thread
10. Get User's Followers
Note: Replace
elonmuskwith the actual username.
xurl followers --of elonmusk -n 20
11. Get User's Following
Note: Replace
elonmuskwith the actual username.
xurl following --of elonmusk -n 20
Pagination
Most list endpoints support pagination. For shortcut commands, use -n to control result count.
For raw API endpoints, check the meta.next_token field in the response:
xurl '/2/tweets/search/recent?query=example&max_results=10' | jq .meta
Use the returned next_token value as pagination_token in the next request to get more results.
Common user.fields
| Field | Description |
|-------|-------------|
| id | Unique user ID |
| name | Display name |
| username | Handle (without @) |
| description | Bio text |
| created_at | Account creation date |
| public_metrics | Followers, following, tweet, and listed counts |
| profile_image_url | Avatar URL |
| verified | Verification status |
| location | User-defined location |
| url | User-defined URL |
Common tweet.fields
| Field | Description |
|-------|-------------|
| id | Unique tweet ID |
| text | Tweet content |
| created_at | Post timestamp |
| author_id | Author's user ID |
| public_metrics | Retweets, replies, likes, quotes, bookmarks, impressions |
| conversation_id | Thread root tweet ID |
| lang | Detected language |
| referenced_tweets | Retweet/quote/reply references |
| entities | URLs, hashtags, mentions, cashtags |
Guidelines
- Read-only access: This connector only grants read permissions; you cannot post, like, or retweet
- Rate limits: X API has strict rate limits; avoid rapid successive calls
- Prefer shortcut commands: Use
xurl search,xurl user,xurl readetc. over raw API paths when possible - Raw API fallback: For bulk lookups or advanced queries, use
xurl '/2/...'with query parameters - Fields are opt-in (raw API only): Raw endpoints only return
idandtextby default; specifytweet.fieldsanduser.fieldsfor richer data. Shortcut commands include common fields automatically - 7-day search window: The recent search endpoint only covers the past 7 days
- Pagination: Use
-nfor shortcut commands,max_resultsandpagination_tokenfor raw API