{ "info": { "name": "TwitterAPIs API", "description": "REST API for Twitter and X data. Search tweets and users, resolve a single tweet into its full thread, read profiles and timelines, page the follower graph, and run write actions over plain HTTP with Bearer auth and JSON. Pay per call: almost every call is $0.0008 (standard reads plus simple write actions like, retweet, bookmark, follow, their undos, and delete), tweet/thread is $0.004, full tweet history is $0.0024, tweet creation and DM reads are $0.0016, and account reads are free. New accounts start with $0.50 in free credits.\n\nSet the collection variables `apiKey` (your TwitterAPIs key) and `baseUrl` before sending.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.twitterapis.com/twitter" }, { "key": "apiKey", "value": "YOUR_API_KEY" } ], "item": [ { "name": "Account", "description": "Your API account: credit balance, usage totals, and payment history. Served from the API root (https://api.twitterapis.com/account/*), not under /twitter, because billing owns their authentication. Free.", "item": [ { "name": "Account Info", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "https://api.twitterapis.com/account/me", "host": [ "https://api.twitterapis.com" ], "path": [ "account", "me" ] }, "description": "Returns the account behind your API key: remaining credits, credits consumed, total requests served, and when the account was created. Use it to show a balance in your own dashboard or to alert before you run out of credits. This call is free and is not metered. Cost: Free per call." } }, { "name": "Payment History", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "https://api.twitterapis.com/account/payments", "host": [ "https://api.twitterapis.com" ], "path": [ "account", "payments" ] }, "description": "Returns the payment history for the account behind your API key, ordered newest first. Each entry records what was paid, how many credits it added, and whether the payment completed. Use it to reconcile top-ups against your own billing records. This call is free. Cost: Free per call." } } ] }, { "name": "Account Session", "description": "Bring your own X session cookies (recommended), or mint a session from a username and password, so write actions and private-data reads act as your account. Free.", "item": [ { "name": "Register Session", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/customer/session", "host": [ "{{baseUrl}}" ], "path": [ "customer", "session" ] }, "description": "Register your X session cookies so write actions (like, retweet, bookmark, follow, create or delete a tweet) and private-data reads (home timeline, bookmarks, likes, DMs, followers-you-know) run as your account. Supply auth_token and ct0 once; the session is stored against your API key and applied automatically. This call is free. Cost: Free per call.", "body": { "mode": "raw", "raw": "{\n \"auth_token\": \"\",\n \"ct0\": \"\",\n \"user_agent\": \"\",\n \"proxy_url\": \"\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "User Login", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/user/user_login", "host": [ "{{baseUrl}}" ], "path": [ "user", "user_login" ] }, "description": "Log in to an X account with a username and password (plus a TOTP secret when two-factor authentication is enabled) and get back a fresh session: the auth_token, ct0, and twid cookies. This is a convenience alternative to Register Session for when you cannot copy cookies out of a browser. Bringing your own auth_token and ct0 via POST /customer/session stays the primary, recommended path. This call is free. Cost: Free per call.", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"totp_secret\": \"\"\n}", "options": { "raw": { "language": "json" } } } } } ] }, { "name": "Search", "description": "Full-text and structured search across tweets and users. Filter by query operators, author, date, language, and engagement.", "item": [ { "name": "Advanced Tweet Search", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/advanced_search?query=from%3Anaval%20min_faves%3A1000", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "advanced_search" ], "query": [ { "key": "query", "value": "from:naval min_faves:1000", "description": "Search query using Twitter operator syntax.", "disabled": false }, { "key": "product", "value": "Latest", "description": "Ranking and result type: Latest, Top, People, Photos, or Videos. Defaults to Latest.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true }, { "key": "count", "value": "20", "description": "Accepted but not honoured on this endpoint: the upstream page is fixed at roughly 20 results and raising count does not return more. Use cursor to read further.", "disabled": true } ] }, "description": "Run a full-text tweet search using the same operator syntax as Twitter/X advanced search. Combine free text with operators such as from:, to:, since:, until:, min_faves:, and lang: to filter precisely. Results are cursor-paginated at roughly 20 tweets per call. Cost: $0.0008 per call." } }, { "name": "User Search", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/search?query=machine%20learning", "host": [ "{{baseUrl}}" ], "path": [ "user", "search" ], "query": [ { "key": "query", "value": "machine learning", "description": "Keyword or partial handle to search for.", "disabled": false }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Search the user directory by keyword. Matches against display name, handle, and bio. Useful for discovery, lead lists, and resolving partial handles into full profiles. Cost: $0.0008 per call." } } ] }, { "name": "Tweet Details", "description": "Resolve a single tweet into its full object: replies, retweeters, and the complete conversation thread.", "item": [ { "name": "Tweet Detail", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/detail", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "detail" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to fetch. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet, for example https://x.com/naval/status/1759123456789012345. Provide either id or url.", "disabled": true } ] }, "description": "Resolve a tweet ID into its complete object, including author, engagement counts, attached media, and any quoted tweet. The starting point for any single-tweet workflow. Cost: $0.0008 per call." } }, { "name": "Tweet Replies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/replies", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "replies" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the parent tweet. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the parent tweet. Provide either id or url.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true } ] }, "description": "Fetch the direct replies to a given tweet, cursor-paginated. Combine with Tweet Detail to reconstruct a discussion or measure reply sentiment. Cost: $0.0008 per call." } }, { "name": "Tweet Retweeters", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/retweeters", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "retweeters" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet. Provide either id or url.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Fetch the users who retweeted a given tweet, cursor-paginated. Useful for amplification analysis and identifying the accounts that spread a post. Cost: $0.0008 per call." } }, { "name": "Tweet Thread", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/thread", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "thread" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of any tweet in the thread. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of any tweet in the thread. Provide either id or url.", "disabled": true } ] }, "description": "Given the first tweet of a thread, return the ordered list of tweets that make up the author's connected thread. The endpoint reads forward from the tweet you pass and does not walk backwards, so pass the thread's first tweet, which is the conversation_id carried on every tweet in that thread. Passing a later tweet returns only the tail of the thread. Cost: $0.0040 per call." } } ] }, { "name": "User Reads", "description": "Read a profile, its timeline, media, mentions, affiliates, and follow relationships by username or numeric ID.", "item": [ { "name": "User Info by Username", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/info?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "info" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false } ] }, "description": "Resolve a username into the full user object: bio, follower and following counts, verification status, location, and avatar. The canonical entry point for profile lookups. Cost: $0.0008 per call." } }, { "name": "User Info by ID", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/info_by_id?user_id=745273", "host": [ "{{baseUrl}}" ], "path": [ "user", "info_by_id" ], "query": [ { "key": "user_id", "value": "745273", "description": "Numeric ID of the user.", "disabled": false } ] }, "description": "Resolve a numeric user ID into the full user object. Use this when you already have the stable ID (handles can change, IDs do not). Cost: $0.0008 per call." } }, { "name": "Users by IDs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/users/by_ids?user_ids=745273%2C44196397", "host": [ "{{baseUrl}}" ], "path": [ "users", "by_ids" ], "query": [ { "key": "user_ids", "value": "745273,44196397", "description": "Comma-separated numeric user IDs, up to 100. Duplicates are collapsed.", "disabled": false } ] }, "description": "Resolve many numeric user IDs into full user objects in a single request. Send up to 100 comma-separated IDs. Unresolvable IDs (suspended or deleted) are omitted rather than returned as nulls, and the response reports how many were requested and how many resolved. Cost: $0.0008 per call." } }, { "name": "User About", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/user_about?username=stripe", "host": [ "{{baseUrl}}" ], "path": [ "user", "user_about" ], "query": [ { "key": "username", "value": "stripe", "description": "Handle without the leading @. Required: unlike the other user reads, this endpoint cannot be called with user_id alone.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID. Not currently a substitute for username on this endpoint: a user_id-only request fails upstream. Resolve the ID to a handle with GET /user/info_by_id and pass username.", "disabled": true } ] }, "description": "Read a profile's full About object: identity, bio, location, linked website, avatar, verification and identity-verification flags, professional account type and categories, follower and following counts, the account creation date, and X's \"About this account\" transparency panel (account country, how the account was created, and username-change history). Cost: $0.0008 per call." } }, { "name": "User Media", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/media?username=nasa", "host": [ "{{baseUrl}}" ], "path": [ "user", "media" ], "query": [ { "key": "username", "value": "nasa", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Fetch the media tweets posted by a user, cursor-paginated. Returns the tweet objects from the account's Media tab, with media URLs included under extended_entities.media. The tab occasionally surfaces a link-or-card tweet with no attachment, so guard on extended_entities before reading it. Cost: $0.0008 per call." } }, { "name": "User Tweets", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/tweets?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "tweets" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Accepted but not honoured on this endpoint: the upstream timeline page is fixed at roughly 20 tweets and raising count does not return more. Use cursor to read further back.", "disabled": true } ] }, "description": "Page through a user's public timeline, cursor-paginated at roughly 20 tweets per call. The page mirrors the account's timeline as X returns it, so it contains original tweets, retweets, and the account's own replies. Each tweet carries is_retweet and is_reply, so filter client-side if you want original posts only. Cost: $0.0008 per call." } }, { "name": "User Tweets and Replies", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/tweets_and_replies?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "tweets_and_replies" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Accepted but not honoured on this endpoint: the upstream timeline page is fixed at roughly 20 tweets and raising count does not return more. Use cursor to read further back.", "disabled": true } ] }, "description": "Page through a user's public timeline including the replies the account posted. This endpoint resolves to the same upstream timeline as GET /user/tweets and returns the same tweets in the same order, so treat it as an alias kept for compatibility rather than a wider result set. Each tweet carries is_retweet and is_reply for client-side filtering. Cost: $0.0008 per call." } }, { "name": "User Mentions", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/mentions?username=twitterapis", "host": [ "{{baseUrl}}" ], "path": [ "user", "mentions" ], "query": [ { "key": "username", "value": "twitterapis", "description": "Handle without the leading @ to find mentions of.", "disabled": false }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Accepted but not honoured on this endpoint: the upstream page is fixed at roughly 20 results and raising count does not return more. Use cursor to read further.", "disabled": true } ] }, "description": "Return the tweets that mention a given account, cursor-paginated. This is the canonical way to read a handle's mentions; it is a thin wrapper over a to:username search and returns the same tweet objects. Cost: $0.0008 per call." } }, { "name": "User Affiliates", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/affiliates?username=stripe", "host": [ "{{baseUrl}}" ], "path": [ "user", "affiliates" ], "query": [ { "key": "username", "value": "stripe", "description": "Handle of the organization account.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true }, { "key": "team", "value": "", "description": "Affiliate team filter, when the organization exposes teams.", "disabled": true } ] }, "description": "Return the affiliated accounts linked under an organization's Verified Organizations profile. Useful for mapping a company to its employees and brand accounts. Cost: $0.0008 per call." } }, { "name": "Check Follow Relationship", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/check_follow_relationship?source_user_id=745273&target_user_id=2178758961", "host": [ "{{baseUrl}}" ], "path": [ "user", "check_follow_relationship" ], "query": [ { "key": "source_user_id", "value": "745273", "description": "Numeric ID of the account whose following is checked.", "disabled": false }, { "key": "target_user_id", "value": "2178758961", "description": "Numeric ID of the account being checked against.", "disabled": false } ] }, "description": "Return the directional relationship between a source and target user: whether source follows target (following) and target follows source (followed_by), plus block, mute, and DM-eligibility flags. The relationship object is null when either user is not found. Cost: $0.0008 per call." } }, { "name": "Bookmarks", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/bookmarks", "host": [ "{{baseUrl}}" ], "path": [ "user", "bookmarks" ], "query": [ { "key": "count", "value": "20", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Fetch the bookmarked tweets for the account behind your registered session, newest first. Each item is a full tweet object with author and engagement counts. Cursor-paginated. Requires a registered session. Cost: $0.0008 per call." } }, { "name": "Bookmark Search", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/bookmark_search?query=cursor%20pagination", "host": [ "{{baseUrl}}" ], "path": [ "user", "bookmark_search" ], "query": [ { "key": "query", "value": "cursor pagination", "description": "Keyword(s) to match against your bookmarked tweets' text.", "disabled": false }, { "key": "count", "value": "", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Search the bookmarks of the account behind your registered session by keyword. Matches against bookmarked tweet text and returns full tweet objects. Cursor-paginated. Requires a registered session. Cost: $0.0008 per call." } }, { "name": "User Likes", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/likes?user_id=44196397", "host": [ "{{baseUrl}}" ], "path": [ "user", "likes" ], "query": [ { "key": "user_id", "value": "44196397", "description": "Numeric ID of the account whose likes to read. Resolve a handle with GET /user/info first.", "disabled": false }, { "key": "count", "value": "", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Read the Likes tab of the account named by user_id, read through your registered session, most recent first. Returns full tweet objects, cursor-paginated. Returns an empty list when the account hides its likes. Requires a registered session and a numeric user_id. Cost: $0.0008 per call." } }, { "name": "Home Timeline", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/home_timeline", "host": [ "{{baseUrl}}" ], "path": [ "user", "home_timeline" ], "query": [ { "key": "count", "value": "20", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Read the home timeline for the account behind your registered session: the ranked feed shown when that account opens X, most recent first. Returns full tweet objects with author and engagement counts. Cursor-paginated. Requires a registered session. Cost: $0.0008 per call." } }, { "name": "Blocked Accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/blocking", "host": [ "{{baseUrl}}" ], "path": [ "user", "blocking" ], "query": [ { "key": "count", "value": "20", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Return the accounts blocked by the account behind your registered session, as full user objects, cursor-paginated. This reads your OWN block list. There is no user_id parameter because X exposes no way to read another account's blocks, so the endpoint does not pretend to offer one. Requires a registered session or per-call inline credentials. Cost: $0.0008 per call." } }, { "name": "Muted Accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/muting", "host": [ "{{baseUrl}}" ], "path": [ "user", "muting" ], "query": [ { "key": "count", "value": "20", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Return the accounts muted by the account behind your registered session, as full user objects, cursor-paginated. Muting hides someone's posts from your timeline without blocking them, so this list is distinct from GET /user/blocking. This reads your OWN mute list; X exposes no way to read another account's, so there is no user_id parameter. Requires a registered session or per-call inline credentials. Cost: $0.0008 per call." } }, { "name": "Full Tweet History", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/tweets/complete?user_id=44196397", "host": [ "{{baseUrl}}" ], "path": [ "user", "tweets", "complete" ], "query": [ { "key": "user_id", "value": "44196397", "description": "Numeric ID of the target account. Resolve a handle with GET /user/info first.", "disabled": false }, { "key": "max", "value": "200", "description": "Target number of tweets to collect in this call. Defaults to 200. This is a MINIMUM target, not a hard cap: pages arrive in whole chunks, so a response may contain up to one page (<=100) more than requested. Twitter's ~3200-per-user history ceiling still applies overall.", "disabled": true }, { "key": "cursor", "value": "DAAHCgABHNqVL6L__zs", "description": "Resume point from a previous response's next_cursor. Omit on the first call. Pass it back to continue collecting where the last call stopped.", "disabled": true } ] }, "description": "Collect a user's tweet history in bulk, auto-paginating server-side across upstream pages. Unlike GET /user/tweets (one upstream page per call), this drives pagination for you and returns a large batch in one request. Each call is bounded by both `max` and a server-side time budget, so it always returns inside a normal client timeout. When more history remains the response carries a `next_cursor` — pass it back as `cursor` to continue, and repeat until `next_cursor` is null. Uses the public account pool: no registered session required. Cost: $0.0024 per call." } } ] }, { "name": "Direct Messages", "description": "Read your account's DM inbox and the message history of a single conversation. Read-only; requires a registered session.", "item": [ { "name": "Send DM", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/dm/send", "host": [ "{{baseUrl}}" ], "path": [ "dm", "send" ] }, "description": "Send a direct message to a user as the authenticated account. Requires a logged-in session for the acting account. Billed at $0.0016 per call. Cost: $0.0016 per call.", "body": { "mode": "raw", "raw": "{\n \"recipient_id\": \"44196397\",\n \"text\": \"Hello from the TwitterAPIs DM API\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "DM Inbox", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/dm/list", "host": [ "{{baseUrl}}" ], "path": [ "dm", "list" ] }, "description": "List the DM conversations (inbox) for the account behind your session. Returns each conversation's ID, type, and participant user IDs. Pass a conversation_id to GET /dm/conversation to read its messages. Authenticate with a registered session (POST /customer/session) or per-call x-auth-token and x-ct0 headers, so one API key can poll the inboxes of many accounts. Read-only: this does not send DMs. Cost: $0.0016 per call." } }, { "name": "DM Conversation", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/dm/conversation?conversation_id=1749154312754794496-1972455697997824000", "host": [ "{{baseUrl}}" ], "path": [ "dm", "conversation" ], "query": [ { "key": "conversation_id", "value": "1749154312754794496-1972455697997824000", "description": "Conversation ID from a GET /dm/list entry.", "disabled": false } ] }, "description": "Fetch the messages inside a single DM conversation. Pass a conversation_id from GET /dm/list. Each message carries its ID, sender ID, timestamp, and text. Authenticate with a registered session (POST /customer/session) or per-call x-auth-token and x-ct0 headers. Read-only: this does not send DMs. Cost: $0.0016 per call." } } ] }, { "name": "Follower Graph", "description": "Page through followers and following lists, including the verified-only and v2 cursor-paginated variants.", "item": [ { "name": "Followers You Know", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/followers_you_know?user_id=44196397", "host": [ "{{baseUrl}}" ], "path": [ "user", "followers_you_know" ], "query": [ { "key": "user_id", "value": "44196397", "description": "Numeric ID of the target account to compute shared followers against.", "disabled": false }, { "key": "count", "value": "", "description": "Items per page. Defaults to 20; capped at 100.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response's next_cursor.", "disabled": true } ] }, "description": "Return the followers of the account named by user_id that the account behind your registered session also follows: the mutual-connection overlap from your perspective. Returns full user objects, cursor-paginated. Requires a registered session and a numeric user_id. Cost: $0.0008 per call." } }, { "name": "User Followers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/followers?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "followers" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Fetch a user's followers, cursor-paginated. Returns full user objects. For large accounts, page with next_cursor until the users array comes back empty (the follower graph keeps returning a non-null cursor even on the final page). Cost: $0.0008 per call." } }, { "name": "User Following", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/following?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "following" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Fetch the accounts a user follows, cursor-paginated. Returns full user objects. Page with next_cursor until the users array comes back empty (the follower graph keeps returning a non-null cursor even on the final page). Cost: $0.0008 per call." } }, { "name": "User Followers (v2)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/followers_v2?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "followers_v2" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "The v2 variant of the followers endpoint. Same data, with a more consistent cursor model and additional user fields. Prefer v2 for new integrations. Cost: $0.0008 per call." } }, { "name": "User Following (v2)", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/following_v2?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "following_v2" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "The v2 variant of the following endpoint. Same data as the v1 following call, with a more consistent cursor model and additional user fields. Prefer v2 for new integrations. Cost: $0.0008 per call." } }, { "name": "Verified Followers", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/verified_followers?username=naval", "host": [ "{{baseUrl}}" ], "path": [ "user", "verified_followers" ], "query": [ { "key": "username", "value": "naval", "description": "Handle without the leading @.", "disabled": false }, { "key": "user_id", "value": "44196397", "description": "Numeric user ID; provide either username or user_id.", "disabled": true }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Fetch only the Verified (Blue) accounts that follow a user, cursor-paginated. A fast way to filter a large follower base down to higher-signal accounts. Cost: $0.0008 per call." } } ] }, { "name": "List Data", "description": "Read the members of any public Twitter/X List.", "item": [ { "name": "List Members", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/list/members?list_id=1234567890123456789", "host": [ "{{baseUrl}}" ], "path": [ "list", "members" ], "query": [ { "key": "list_id", "value": "1234567890123456789", "description": "Numeric ID of the public List.", "disabled": false }, { "key": "cursor", "value": "", "description": "Pagination cursor from a previous response.", "disabled": true }, { "key": "count", "value": "20", "description": "Max items to return for this page. Default 20; clamped to 1-100.", "disabled": true } ] }, "description": "Fetch the members of a public List by its numeric ID, cursor-paginated. Returns full user objects for every account in the List. Cost: $0.0008 per call." } } ] }, { "name": "Trends", "description": "Read what is trending on Twitter/X right now, worldwide or for a single country, plus the full set of locations trends are available for.", "item": [ { "name": "Trends", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/trends", "host": [ "{{baseUrl}}" ], "path": [ "trends" ], "query": [ { "key": "country", "value": "US", "description": "Country name or ISO code, e.g. \"US\" or \"Japan\". Resolved against the trends locations list, country-level entries only.", "disabled": true }, { "key": "woeid", "value": "23424977", "description": "Numeric WOEID from /twitter/trends/locations. Takes precedence over country when both are sent.", "disabled": true }, { "key": "count", "value": "10", "description": "Truncate the returned list to this many trends. X has no count of its own; it always returns its full set (about 50).", "disabled": true } ] }, "description": "Fetch the current top trends for one location. Ask for it by country name, ISO code, or numeric WOEID; with no location parameter you get Worldwide. X returns roughly 50 trends per location, ranked. Cost: $0.0008 per call." } }, { "name": "Trend Locations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/trends/locations", "host": [ "{{baseUrl}}" ], "path": [ "trends", "locations" ] }, "description": "Fetch the full set of locations X serves trends for, each with the WOEID to pass back to the Trends endpoint. Takes no parameters and returns the complete list. Cost: $0.0008 per call." } } ] }, { "name": "Write Actions", "description": "Act on behalf of an authenticated account: like, retweet, bookmark, and follow, each with its undo. Billed at $0.0008 per call, the same as a standard read.", "item": [ { "name": "Upload Media", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/media/upload", "host": [ "{{baseUrl}}" ], "path": [ "media", "upload" ] }, "description": "Upload a base64-encoded image as the authenticated account and receive a media_id you can attach when creating a tweet. Runs as your own logged-in account. Billed at $0.0008 per call. Cost: $0.0008 per call.", "body": { "mode": "raw", "raw": "{\n \"media_data\": \"iVBORw0KGgoAAAANSUhEUgAA...\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Media Status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/media/status?media_id=1899999999999999999", "host": [ "{{baseUrl}}" ], "path": [ "media", "status" ], "query": [ { "key": "media_id", "value": "1899999999999999999", "description": "Numeric media ID (as a string) returned by media/upload.", "disabled": false } ] }, "description": "Return the async processing state of a media_id from Upload Media, so a caller can verify readiness before attaching a video, GIF, or large-media id to a tweet. Runs as your own logged-in account. Billed at $0.0008 per call. Cost: $0.0008 per call." } }, { "name": "Like Tweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/favorite", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "favorite" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to like. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet to like. Provide either id or url.", "disabled": true }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Like a tweet as the authenticated account. Requires a logged-in session for the acting account. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Unlike Tweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/unfavorite", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "unfavorite" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to unlike. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet to unlike. Provide either id or url.", "disabled": true }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Remove a previously recorded like from a tweet as the authenticated account. Requires a logged-in session. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Retweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/retweet", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "retweet" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to retweet. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet to retweet. Provide either id or url.", "disabled": true }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Retweet a tweet as the authenticated account. Requires a logged-in session for the acting account. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Undo Retweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/unretweet", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "unretweet" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to un-retweet. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet to un-retweet. Provide either id or url.", "disabled": true }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Undo a previously recorded retweet as the authenticated account. Requires a logged-in session. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Bookmark Tweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/bookmark", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "bookmark" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to bookmark. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet to bookmark. Provide either id or url.", "disabled": true }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Bookmark a tweet as the authenticated account. Requires a logged-in session for the acting account. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Remove Bookmark", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/unbookmark", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "unbookmark" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to un-bookmark. Provide either id or url.", "disabled": true }, { "key": "url", "value": "https://x.com/naval/status/1759123456789012345", "description": "Full status URL of the tweet to un-bookmark. Provide either id or url.", "disabled": true }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Remove a previously saved bookmark as the authenticated account. Requires a logged-in session. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Follow User", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/follow?user_id=44196397", "host": [ "{{baseUrl}}" ], "path": [ "user", "follow" ], "query": [ { "key": "user_id", "value": "44196397", "description": "Numeric ID of the user to follow.", "disabled": false }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Follow a user as the authenticated account. Requires a logged-in session for the acting account. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Unfollow User", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/user/unfollow?user_id=44196397", "host": [ "{{baseUrl}}" ], "path": [ "user", "unfollow" ], "query": [ { "key": "user_id", "value": "44196397", "description": "Numeric ID of the user to unfollow.", "disabled": false }, { "key": "proxy", "value": "", "description": "Optional. Pass your own proxy (http(s)/socks URL) to egress the write through your clean IP for best success; if omitted, we use the session's proxy / our default.", "disabled": true } ] }, "description": "Unfollow a user as the authenticated account. Requires a logged-in session for the acting account. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } }, { "name": "Create Tweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/tweet/create", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "create" ] }, "description": "Post a new tweet as the account behind your registered session. Supports plain text, up to 4 image media_ids (from a prior media/upload), a reply (reply_to), and a quote (quote). Requires a registered session. Billed at $0.0016 per call. Cost: $0.0016 per call.", "body": { "mode": "raw", "raw": "{\n \"text\": \"Shipping cursor-paginated bookmarks today.\",\n \"media_ids\": \"1899999999999999999\",\n \"reply_to\": \"2080297101888733302\",\n \"quote\": \"1900000000000000000\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "Delete Tweet", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" } ], "url": { "raw": "{{baseUrl}}/tweet/delete", "host": [ "{{baseUrl}}" ], "path": [ "tweet", "delete" ], "query": [ { "key": "id", "value": "1759123456789012345", "description": "Numeric ID of the tweet to delete. Provide either id or url.", "disabled": true }, { "key": "url", "value": "", "description": "Status URL of the tweet to delete, for example https://x.com/you/status/1759123456789012345. Provide either id or url.", "disabled": true } ] }, "description": "Delete a tweet owned by the account behind your registered session. Identify it by id or url (read from the query string). Requires a registered session. Billed at $0.0008 per call, the same as a standard read. Cost: $0.0008 per call." } } ] } ] }