{ "openapi": "3.0.1", "info": { "title": "X/Twitter Profile Scraper", "description": "Scrape any public X (Twitter) profile. Extract every tweet with full text, likes, retweets, replies, views, media, hashtags and follower stats. Go beyond the tweet limit with deep history mode. Bulk scrape multiple profiles at once.", "version": "0.0", "x-build-id": "25xZz9dy48J8YAA2m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesmith~x-twitter-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesmith-x-twitter-profile-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/scrapesmith~x-twitter-profile-scraper/runs": { "post": { "operationId": "runs-sync-scrapesmith-x-twitter-profile-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/scrapesmith~x-twitter-profile-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesmith-x-twitter-profile-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": { "twitterHandles": { "title": "Twitter / X Handles", "type": "array", "description": "List of Twitter/X usernames to scrape (with or without @). The scraper uses time-window pagination to go far beyond Twitter's standard ~1000-tweet profile cap.", "items": { "type": "string" } }, "startUrls": { "title": "Profile URLs", "type": "array", "description": "Direct Twitter/X profile URLs to scrape (e.g. https://x.com/elonmusk).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxTweets": { "title": "Max Tweets per Profile", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Maximum number of tweets to collect per profile. Set to 5000+ to leverage the deep-history fallback.", "default": 10 }, "includeReplies": { "title": "Include Replies", "type": "boolean", "description": "Also include tweets that are replies, not just original tweets.", "default": false }, "maxItems": { "title": "Max Total Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Hard cap on total items pushed to the dataset across all profiles combined. Leave empty to use the plan's default limit.", "default": 10 }, "searchFallbackMode": { "title": "Search Fallback Mode", "enum": [ "after-primary", "from-today", "disabled" ], "type": "string", "description": "How the SearchTimeline fallback walks the user's history when the primary ~1000-tweet wall is hit. 'after-primary' (default) anchors windows at the oldest tweet the primary loop returned — eliminates the dupe-overlap that wastes paid requests. 'from-today' uses the original today-anchored behavior (higher cost, max coverage if you suspect the primary missed recent items). 'disabled' skips search fallback entirely (primary + sub-tabs only).", "default": "after-primary" }, "subTabsFallback": { "title": "Enable Sub-Tabs Fallback (Media + Tweets-and-Replies)", "type": "boolean", "description": "Before the search fallback, scrape the user's separate Media and (when not already covered) Tweets-and-Replies sub-tabs. These have their own per-tab walls and often surface tweets the main timeline missed — no search filters required, no extra cost beyond the actual page requests.", "default": true } } }, "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 } } } } } } } } } }