{ "openapi": "3.0.1", "info": { "title": "Twitter Profile & Tweets Scraper", "description": "Scrapes public Twitter X profiles, capturing usernames, bios, follower and following counts, tweets, media, timestamps, engagement stats, and profile URLs. Ideal for influencer research, competitor analysis, audience insights, and large-scale Twitter X profile data extraction", "version": "0.2", "x-build-id": "5KTUPuznABP2nQst8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~twitter-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-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/scrapio~twitter-profile-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-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/scrapio~twitter-profile-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-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": { "startUrls": { "title": "🔗 Profile URLs / handles", "type": "array", "description": "List of Twitter/X profiles. Accepts full URLs (https://x.com/elonmusk), @handles, plain usernames, or numeric user IDs. Required if twitterHandles is empty.", "items": { "type": "string" } }, "twitterHandles": { "title": "🏷️ Twitter Handles", "type": "array", "description": "List of usernames without the @ (e.g., elonmusk). Merged with startUrls. Required if startUrls is empty.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "📦 Maximum Items", "minimum": 1, "type": "integer", "description": "Hard cap on total rows written across the whole run (profiles + tweets + replies). Example: maxItems=10 → up to 10 rows. Default is 10.", "default": 10 }, "onlyUserInfo": { "title": "👤 Only Profile Info (no tweets)", "type": "boolean", "description": "When on, emit exactly one clean flat profile record per account (followers, following, verification, bio, website, joinDate, pinnedTweetId, derived metrics) and skip tweets entirely.", "default": false }, "includeUserInfo": { "title": "➕ Include Profile Row With Tweets", "type": "boolean", "description": "When on (and onlyUserInfo is off), emit one flat profile record per account first, then its tweets.", "default": false }, "start": { "title": "📅 Start Date (UTC)", "type": "string", "description": "Lower bound for tweet date. Absolute date (YYYY-MM-DD) or relative value (e.g. 7 days). Empty = no lower bound.", "default": "" }, "end": { "title": "📅 End Date (UTC)", "type": "string", "description": "Upper bound for tweet date. Absolute date (YYYY-MM-DD) or relative value (e.g. 1 day). Empty = no upper bound.", "default": "" }, "keywords": { "title": "🔍 Keywords (any-match)", "type": "array", "description": "Keep only tweets whose text contains at least one of these terms (case-insensitive). Empty = no keyword filter.", "default": [], "items": { "type": "string" } }, "excludeKeywords": { "title": "🚫 Exclude Keywords", "type": "array", "description": "Drop tweets whose text contains any of these terms (case-insensitive).", "default": [], "items": { "type": "string" } }, "language": { "title": "🌐 Language (ISO code)", "type": "string", "description": "Keep only tweets in this language (X-detected BCP-47 code, e.g. en, es, ja). Empty = any language.", "default": "" }, "minFavorites": { "title": "👍 Minimum Likes", "minimum": 0, "type": "integer", "description": "Keep only tweets with at least this many likes.", "default": 0 }, "minRetweets": { "title": "🔁 Minimum Retweets", "minimum": 0, "type": "integer", "description": "Keep only tweets with at least this many retweets.", "default": 0 }, "minReplies": { "title": "💬 Minimum Replies", "minimum": 0, "type": "integer", "description": "Keep only tweets with at least this many replies.", "default": 0 }, "excludeReplies": { "title": "🙅 Exclude Reply Tweets", "type": "boolean", "description": "Drop tweets that are replies to another tweet (keeps only originals, quotes and retweets).", "default": false }, "includeNativeRetweets": { "title": "🔁 Include Native Retweets", "type": "boolean", "description": "When off, native retweets (text starts with 'RT @') are dropped. Only reliably present for the last ~7-10 days.", "default": false }, "onlyImages": { "title": "🖼️ Only Tweets With Images", "type": "boolean", "description": "Keep only tweets that contain at least one photo.", "default": false }, "onlyVideos": { "title": "🎬 Only Tweets With Video", "type": "boolean", "description": "Keep only tweets that contain a video or animated GIF.", "default": false }, "hasMedia": { "title": "📎 Only Tweets With Any Media", "type": "boolean", "description": "Keep only tweets that contain at least one media item (photo, video or GIF).", "default": false }, "getReplies": { "title": "💬 Scrape Replies", "type": "boolean", "description": "Fetch replies to each qualifying tweet via the TweetDetail endpoint. Requires auth_token + ct0 cookies.", "default": false }, "minReplyCount": { "title": "📈 Minimum Reply Count To Fetch Replies", "minimum": 0, "type": "integer", "description": "Only fetch replies for tweets whose reply_count is at least this value.", "default": 0 }, "authToken": { "title": "🔐 auth_token Cookie", "type": "string", "description": "Value of the `auth_token` cookie from x.com (devtools → Application → Cookies). Required only for getReplies." }, "csrfToken": { "title": "🛡️ ct0 Cookie", "type": "string", "description": "Value of the `ct0` cookie from x.com. Required only for getReplies." }, "proxyConfiguration": { "title": "🌐 Proxy Configuration", "type": "object", "description": "Apify proxy configuration. Recommended for reliability against rate limits." } } }, "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 } } } } } } } } } }