{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Tweet Scraper — browserless", "description": "Scrapes public tweets from X over its internal GraphQL API using HTTP requests only (no headless browser). Fetch by author handle or tweet ID, filter by hashtag, date, language, engagement and media type. Guest-token rotation, cursor pagination, resumable state, and a strict output schema.", "version": "1.0", "x-build-id": "heCY9M5AIhls307mp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/juanoox~x-tweet-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-juanoox-x-tweet-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/juanoox~x-tweet-scraper/runs": { "post": { "operationId": "runs-sync-juanoox-x-tweet-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/juanoox~x-tweet-scraper/run-sync": { "post": { "operationId": "run-sync-juanoox-x-tweet-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": { "fromUsers": { "title": "From users", "uniqueItems": true, "type": "array", "description": "Handles whose recent tweets should be scraped, without the leading @. Backed by X's profile timeline operation, which is reachable with a guest token.", "items": { "type": "string" } }, "tweetIds": { "title": "Tweet IDs", "uniqueItems": true, "type": "array", "description": "Specific tweet IDs to hydrate into the full output schema.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms (topic discovery)", "uniqueItems": true, "type": "array", "description": "Free-text topics. X's own SearchTimeline is closed to guest tokens, so these are resolved a different way: a public search engine is asked which X profiles rank for the topic, those profiles' timelines are read through the guest-token path, and only tweets actually mentioning a term are kept. This finds tweets by accounts that rank for the topic — it is not an exhaustive index of every matching tweet. See the README.", "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "uniqueItems": true, "type": "array", "description": "Keep only tweets containing all of these hashtags, without the leading #. Applied as a post-filter over the fetched timelines.", "items": { "type": "string" } }, "since": { "title": "Since (inclusive)", "type": "string", "description": "Keep only tweets created on or after this date (ISO date, e.g. 2025-01-01)." }, "until": { "title": "Until (inclusive)", "type": "string", "description": "Keep only tweets created on or before this date (ISO date, e.g. 2025-12-31)." }, "language": { "title": "Language", "type": "string", "description": "Keep only tweets whose detected language matches this ISO-639-1 code, e.g. 'en' or 'es'." }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Keep only tweets with at least this many likes." }, "minRetweets": { "title": "Minimum retweets", "minimum": 0, "type": "integer", "description": "Keep only tweets with at least this many retweets." }, "minReplies": { "title": "Minimum replies", "minimum": 0, "type": "integer", "description": "Keep only tweets with at least this many replies." }, "onlyVerified": { "title": "Only verified authors", "type": "boolean", "description": "Keep only tweets whose author is verified (legacy verified or X Premium blue check).", "default": false }, "mediaType": { "title": "Media type", "enum": [ "any", "text_only", "images", "video", "links" ], "type": "string", "description": "Keep only tweets carrying this kind of media.", "default": "any" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Count replies as results.", "default": false }, "includeRetweets": { "title": "Include retweets", "type": "boolean", "description": "Count retweets as results.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "latest", "top" ], "type": "string", "description": "Ordering, for the surfaces that support it. X's profile timeline is served newest-first, so 'top' is applied by this Actor as an engagement sort over what was fetched.", "default": "latest" }, "maxResults": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "How many items you want. NOTE: free-tier runs are capped server-side at 10 items regardless of this value; raising it cannot lift that cap.", "default": 100 }, "webhookUrl": { "title": "Finish webhook URL", "type": "string", "description": "Optional. When the run finishes, the summary (counts, timing, the free-tier flag and error tallies) is POSTed as JSON to this URL. Delivery failures are logged and never fail the run." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. Residential rotation is supported; pick the RESIDENTIAL group and optionally a country.", "default": { "useApifyProxy": 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 } } } } } } } } } }