{ "openapi": "3.0.1", "info": { "title": "Twitter Profile Scraper", "description": "Scrape detailed user data from X (Twitter) with the Twitter Profile Scraper. Extract bios, follower counts, following, tweets, media, verification status, and engagement stats from any public profile. Perfect for influencer analysis, research, and monitoring. Fast, accurate, and scalable.", "version": "0.2", "x-build-id": "7BUz9u33Rzi9xFIen" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapier~twitter-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapier-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/scrapier~twitter-profile-scraper/runs": { "post": { "operationId": "runs-sync-scrapier-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/scrapier~twitter-profile-scraper/run-sync": { "post": { "operationId": "run-sync-scrapier-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", "type": "array", "description": "List of Twitter/X profile URLs (e.g., https://x.com/elonmusk). Required if twitterHandles is empty.", "default": [ "elonmusk" ], "items": { "type": "string" } }, "twitterHandles": { "title": "🏷️ Twitter Handles", "type": "array", "description": "List of usernames without the @ (e.g., elonmusk). Required if startUrls is empty.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "📦 Maximum Items", "minimum": 1, "type": "integer", "description": "Hard cap on total items written across the whole run.", "default": 10 }, "start": { "title": "📅 Start Date (UTC)", "type": "string", "description": "Lower bound for tweet date. Use absolute date (YYYY-MM-DD) or relative value (for example, 7 days). Empty = no lower bound.", "default": "" }, "end": { "title": "📅 End Date (UTC)", "type": "string", "description": "Upper bound for tweet date. Use absolute date (YYYY-MM-DD) or relative value (for example, 1 day). Empty = no upper bound.", "default": "" }, "includeNativeRetweets": { "title": "🔁 Include Native Retweets", "type": "boolean", "description": "When false, native retweets (full_text starts with 'RT @') are dropped. Only effective 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 }, "getAboutData": { "title": "👤 Emit Profile About Data", "type": "boolean", "description": "Emit one profile-about record per user (uses the embedded user object from UserTweets).", "default": false }, "getReplies": { "title": "💬 Scrape Replies", "type": "boolean", "description": "Fetch replies to each qualifying tweet via the TweetDetail endpoint. Requires login cookies.", "default": false }, "minReplyCount": { "title": "📈 Minimum Reply Count", "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 for getReplies." }, "csrfToken": { "title": "🛡️ ct0 Cookie", "type": "string", "description": "Value of the `ct0` cookie from x.com. Required 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 } } } } } } } } } }