{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Scraper - Tweets, Threads & Engagement Rate", "description": "Scrape tweets from any X (Twitter) profile or tweet URL, no official API needed. Get text, engagement metrics, media, hashtags & author data as JSON, CSV or Excel.", "version": "0.1", "x-build-id": "d3sicKfrZ7IOopAXb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/techforce.global~twitter-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-techforce.global-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/techforce.global~twitter-scraper/runs": { "post": { "operationId": "runs-sync-techforce.global-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/techforce.global~twitter-scraper/run-sync": { "post": { "operationId": "run-sync-techforce.global-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": { "profiles": { "title": "Profiles (handles or URLs)", "type": "array", "description": "X/Twitter profiles to scrape. Accepts bare handles (with or without @) or full profile URLs, e.g. \"elonmusk\", \"@nasa\", \"https://x.com/apify\". The scraper collects the account's timeline tweets.", "items": { "type": "string" } }, "tweetUrls": { "title": "Tweet URLs", "type": "array", "description": "Individual tweet/status URLs to scrape, e.g. \"https://x.com/apify/status/1234567890\". Each tweet is fetched with its full detail.", "items": { "type": "string" } }, "maxTweetsPerProfile": { "title": "Max tweets per profile", "minimum": 0, "type": "integer", "description": "Maximum number of tweets to collect from each profile. Set 0 for unlimited (bounded by how far the timeline paginates).", "default": 100 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "When scraping profiles, also load the \"with replies\" timeline so the account's replies are captured. For tweet URLs, capture replies in the conversation thread.", "default": false }, "maxScrolls": { "title": "Max scrolls per page", "minimum": 1, "maximum": 500, "type": "integer", "description": "Safety cap on how many times to scroll each timeline to trigger loading of more tweets. Higher = more tweets but longer runs.", "default": 25 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Uses Apify Proxy (automatic) by default, which is available on the free plan and strongly recommended to avoid rate limiting.", "default": { "useApifyProxy": true } }, "mcpConnector": { "title": "Deliver to (MCP connector)", "type": "string", "description": "Optionally deliver the scraped tweets into a connector you have authorized - Notion, Slack, Linear, Airtable, Jira, GitHub, or any MCP-compatible connector. Leave empty to only save results to the dataset." }, "deliveryMode": { "title": "Delivery mode", "enum": [ "summary", "chunked", "perTweet", "none" ], "type": "string", "description": "How to deliver to the connector: summary = one call for the whole run; chunked = split a long tweet list across a few calls so services like Notion never time out; perTweet = one call per tweet; none = save to the dataset only.", "default": "none" }, "mcpTool": { "title": "Connector tool name", "type": "string", "description": "Name of the tool to call on the connector (e.g. 'create_page' for Notion, 'send_message' for Slack, 'create_issue' for Jira/GitHub). If unsure, run once with a connector selected - the log lists the connector's available tools and the selected tool's input schema.", "default": "" }, "mcpArguments": { "title": "Connector tool arguments", "type": "object", "description": "Arguments passed to the connector tool. Any {placeholder} in a string value is substituted per call. Tweet placeholders: {id} {url} {text} {createdAt} {lang} {authorUsername} {authorName} {authorFollowers} {authorVerified} {likeCount} {retweetCount} {replyCount} {quoteCount} {viewCount} {bookmarkCount} {isRetweet} {isQuote} {isReply} {hashtags} {mentions} {urls} {scrapedFrom} {tweet}. Run placeholders: {tweetCount} {authorBreakdown} {tweets} {part} {partCount} {message}.", "default": {} }, "mcpMessageTemplate": { "title": "Message template", "type": "string", "description": "Text rendered into the {message} placeholder. Accepts the same placeholders as the arguments above.", "default": "" } } }, "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 } } } } } } } } } }