{ "openapi": "3.0.1", "info": { "title": "🐦 Twitter (X) Search Scraper", "description": "🐦 Twitter (X) Search Scraper by twitter-search-scraper pulls real-time results from X search queriesβ€”tweets, authors, timestamps & engagement. πŸ”Ž Fast, efficient scraping for brand monitoring, competitor insights, sentiment & lead research. πŸš€", "version": "0.1", "x-build-id": "GkBfADk8eN3MrErM0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~twitter-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-twitter-search-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/scraper-engine~twitter-search-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-twitter-search-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/scraper-engine~twitter-search-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-twitter-search-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", "required": [ "authToken", "csrfToken" ], "properties": { "searchQueries": { "title": "πŸ”Ž Search queries", "type": "array", "description": "One or more search terms (bulk supported). Each line is searched separately. Plain text or X advanced-search syntax both work, e.g. ai agents or from:openai filter:videos.", "items": { "type": "string" } }, "tweetsDesired": { "title": "πŸ”’ Max tweets per query", "minimum": 1, "type": "integer", "description": "Maximum number of tweets to collect for each search query.", "default": 10 }, "repliesDepth": { "title": "πŸ’¬ Replies depth", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many levels of replies to scrape. 0 = no replies, 1 = tweet + its direct replies, 2 = replies of replies, etc. Higher values are much slower.", "default": 0 }, "includeUserInfo": { "title": "πŸ‘€ Include author profile in every tweet", "type": "boolean", "description": "Attach the full author profile (followers, bio, location, join date, …) to every tweet. Slightly slower but far richer data.", "default": true }, "authToken": { "title": "πŸ”‘ X auth_token cookie (required)", "type": "string", "description": "Paste your X auth_token cookie (from a logged-in browser session) so the scraper uses your session." }, "csrfToken": { "title": "πŸ”‘ X ct0 cookie (required)", "type": "string", "description": "Paste your X ct0 (CSRF) cookie that matches the auth_token above." }, "since": { "title": "πŸ“… Tweets newer than (since)", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Oldest date to include, format YYYY-MM-DD. Relative values like 1 month or 2 days also work." }, "until": { "title": "πŸ“… Tweets older than (until)", "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$", "type": "string", "description": "Newest date to include, format YYYY-MM-DD. Relative values like 1 month also work." }, "minReplies": { "title": "↩️ Minimum replies", "minimum": 0, "type": "integer", "description": "Only keep tweets with at least this many replies.", "default": 0 }, "minRetweets": { "title": "πŸ” Minimum retweets", "minimum": 0, "type": "integer", "description": "Only keep tweets with at least this many retweets.", "default": 0 }, "minLikes": { "title": "❀️ Minimum likes", "minimum": 0, "type": "integer", "description": "Only keep tweets with at least this many likes.", "default": 0 }, "fromTheseAccounts": { "title": "πŸ“€ From these accounts", "type": "array", "description": "Only tweets authored by these usernames (with or without @).", "default": [], "items": { "type": "string" } }, "toTheseAccounts": { "title": "πŸ“₯ To these accounts", "type": "array", "description": "Only tweets that are replies to these usernames.", "default": [], "items": { "type": "string" } }, "mentioningTheseAccounts": { "title": "πŸ“£ Mentioning these accounts", "type": "array", "description": "Only tweets that mention these usernames.", "default": [], "items": { "type": "string" } }, "nativeRetweets": { "title": "πŸ” Only native retweets", "type": "boolean", "description": "Include only native retweets (retweets without comment).", "default": false }, "media": { "title": "πŸ–ΌοΈ Only tweets with media", "type": "boolean", "description": "Include only tweets that contain media (images, videos, gifs).", "default": false }, "images": { "title": "πŸŒ… Only tweets with images", "type": "boolean", "description": "Include only tweets that contain images.", "default": false }, "videos": { "title": "🎬 Only tweets with videos", "type": "boolean", "description": "Include only tweets that contain videos.", "default": false }, "news": { "title": "πŸ“° Only tweets with news", "type": "boolean", "description": "Include only tweets that contain news links.", "default": false }, "verified": { "title": "βœ”οΈ Only from verified users", "type": "boolean", "description": "Include only tweets from verified accounts.", "default": false }, "nativeVideo": { "title": "πŸ“Ή Only tweets with native video", "type": "boolean", "description": "Include only tweets that contain native video.", "default": false }, "replies": { "title": "↩️ Only replies", "type": "boolean", "description": "Include only tweets that are replies.", "default": false }, "links": { "title": "πŸ”— Only tweets with links", "type": "boolean", "description": "Include only tweets that contain links.", "default": false }, "safe": { "title": "⚠️ Only sensitive-marked tweets", "type": "boolean", "description": "Include only tweets marked as potentially sensitive.", "default": false }, "quote": { "title": "πŸ’¬ Only quote tweets", "type": "boolean", "description": "Include only tweets that quote other tweets.", "default": false }, "proVideo": { "title": "πŸŽ₯ Only tweets with pro video", "type": "boolean", "description": "Include only tweets that contain pro video.", "default": false }, "excludeNativeRetweets": { "title": "πŸš«πŸ” Exclude native retweets", "type": "boolean", "description": "Exclude native retweets from the results.", "default": false }, "excludeMedia": { "title": "πŸš«πŸ–ΌοΈ Exclude tweets with media", "type": "boolean", "description": "Exclude tweets that contain media.", "default": false }, "excludeImages": { "title": "πŸš«πŸŒ… Exclude tweets with images", "type": "boolean", "description": "Exclude tweets that contain images.", "default": false }, "excludeVideos": { "title": "🚫🎬 Exclude tweets with videos", "type": "boolean", "description": "Exclude tweets that contain videos.", "default": false }, "excludeNews": { "title": "πŸš«πŸ“° Exclude tweets with news", "type": "boolean", "description": "Exclude tweets that contain news links.", "default": false }, "excludeVerified": { "title": "πŸš«βœ”οΈ Exclude verified users", "type": "boolean", "description": "Exclude tweets from verified accounts.", "default": false }, "excludeNativeVideo": { "title": "πŸš«πŸ“Ή Exclude native video", "type": "boolean", "description": "Exclude tweets that contain native video.", "default": false }, "excludeReplies": { "title": "πŸš«β†©οΈ Exclude replies", "type": "boolean", "description": "Exclude tweets that are replies.", "default": false }, "excludeLinks": { "title": "πŸš«πŸ”— Exclude tweets with links", "type": "boolean", "description": "Exclude tweets that contain links.", "default": false }, "excludeSafe": { "title": "🚫⚠️ Exclude sensitive-marked tweets", "type": "boolean", "description": "Exclude tweets marked as potentially sensitive.", "default": false }, "excludeQuote": { "title": "πŸš«πŸ’¬ Exclude quote tweets", "type": "boolean", "description": "Exclude tweets that quote other tweets.", "default": false }, "excludeProVideo": { "title": "🚫πŸŽ₯ Exclude pro video", "type": "boolean", "description": "Exclude tweets that contain pro video.", "default": false }, "language": { "title": "🌍 Tweet language", "enum": [ "any", "ar", "bn", "bg", "ca", "hr", "cs", "da", "nl", "en", "fi", "fr", "de", "el", "gu", "he", "hi", "hu", "id", "it", "ja", "kn", "ko", "mr", "no", "fa", "pl", "pt", "ro", "ru", "sr", "zh-cn", "sk", "sl", "es", "sv", "ta", "th", "zh-tw", "tr", "uk", "ur", "vi" ], "type": "string", "description": "Restrict results to a single language.", "default": "any" }, "near": { "title": "πŸ“ Near location", "type": "string", "description": "Search near a location (e.g. a city name)." }, "textLengthLessThan": { "title": "βœ‚οΈ Text length less than", "minimum": 1, "type": "integer", "description": "Keep only tweets whose text is shorter than this many characters." }, "proxyConfiguration": { "title": "πŸ›°οΈ Proxy configuration", "type": "object", "description": "By default the scraper runs with no proxy and automatically falls back to a datacenter, then a residential proxy if X blocks the connection. Pick RESIDENTIAL here to start (and stay) on residential immediately β€” recommended for large runs.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }