{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Tweets & Profiles Scraper", "description": "Scrape public X (Twitter) tweets and profiles by handle or tweet ID. Extract text, author, likes, retweets, replies, quotes, views, followers, bio, hashtags and media. No login needed. Export to JSON, CSV or Excel.", "version": "0.2", "x-build-id": "SO53VLFnjTI7a6tv6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~x-twitter-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-x-twitter-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/scrapers_lat~x-twitter-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-x-twitter-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/scrapers_lat~x-twitter-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-x-twitter-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "mode": { "title": "Mode", "enum": [ "userTweets", "userProfile", "tweet", "search" ], "type": "string", "description": "What to scrape. 'User Tweets' pulls a public account's recent posts. 'User Profile' pulls profile details (bio, followers, etc). 'Tweet by ID/URL' fetches specific tweets. Keyword 'Search' is shown but NOT available without a logged-in account — X requires authentication for search, so it returns a clear error instead of fake data.", "default": "userTweets" }, "handles": { "title": "Handles (for User Tweets / User Profile)", "type": "array", "description": "Public X (Twitter) handles for the 'User Tweets' and 'User Profile' modes. Accepts @name, name, or a profile URL such as https://x.com/nasa. Add one or more.", "items": { "type": "string" } }, "tweetsLimit": { "title": "Tweets per user", "minimum": 1, "maximum": 3200, "type": "integer", "description": "For 'User Tweets' mode: maximum number of tweets to collect per handle (paginated). Default 100." }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "For 'User Tweets' mode: also include the account's replies (uses the tweets-and-replies timeline).", "default": false }, "tweetIds": { "title": "Tweet IDs or URLs (for Tweet mode)", "type": "array", "description": "For 'Tweet by ID/URL' mode: numeric tweet IDs (for example 20) or full status URLs such as https://x.com/jack/status/20. One record per tweet.", "items": { "type": "string" } }, "searchQuery": { "title": "Search query (NOT available)", "type": "string", "description": "Keyword/query for 'Search' mode. NOTE: X disabled logged-out search, so this mode returns a clear error explaining the limitation rather than results. Use 'User Tweets' instead." }, "searchType": { "title": "Search type", "enum": [ "Top", "Latest" ], "type": "string", "description": "Top or Latest for 'Search' mode. Not used — search is login-gated by X.", "default": "Top" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of records to collect across all inputs. Optional." }, "lang": { "title": "Language", "type": "string", "description": "Two-letter UI language hint sent to X for localized fields. Defaults to English.", "default": "en" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy used to reach X. RESIDENTIAL United States is required and used by default — X rate-limits (429/403) every datacenter IP on these endpoints. Residential is metered per GB.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }