{ "openapi": "3.0.1", "info": { "title": "Tweet Scraper — X search, $0.15 per 1,000 tweets", "description": "Tweets from X (Twitter) search by keyword, URL, handle or filters, newest first. Same input and output as apidojo/tweet-scraper — switch by changing the actor id. Pay only per tweet.", "version": "0.0", "x-build-id": "sMhVrw50Tgkf4Cw00" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tweetpipe~tweet-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tweetpipe-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/tweetpipe~tweet-scraper/runs": { "post": { "operationId": "runs-sync-tweetpipe-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/tweetpipe~tweet-scraper/run-sync": { "post": { "operationId": "run-sync-tweetpipe-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "X search URLs (x.com or twitter.com). A profile URL is searched as from:handle. List and single-tweet URLs are not supported yet.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms", "type": "array", "description": "What to search for, one per line. Any X search operator works (from:, -filter:replies, \"exact phrase\", OR, …).", "items": { "type": "string" } }, "twitterHandles": { "title": "X handles", "type": "array", "description": "Tweets from these accounts (searched as from:handle).", "items": { "type": "string" } }, "conversationIds": { "title": "Conversation IDs", "type": "array", "description": "Tweets in these conversations (searched as conversation_id:).", "items": { "type": "string" } }, "maxItems": { "title": "Maximum tweets", "type": "integer", "description": "Stop after this many tweets in total. Empty = as many as the search returns (within your maximum run charge)." }, "sort": { "title": "Sort", "enum": [ "Top", "Latest", "Latest + Top" ], "type": "string", "description": "Latest = newest first. Top = what X ranks most relevant. Latest + Top runs both." }, "tweetLanguage": { "title": "Language", "enum": [ "ab", "aa", "af", "ak", "sq", "am", "ar", "an", "hy", "as", "av", "ae", "ay", "az", "bm", "ba", "eu", "be", "bn", "bi", "bs", "br", "bg", "my", "ca", "ch", "ce", "ny", "zh", "cu", "cv", "kw", "co", "cr", "hr", "cs", "da", "dv", "nl", "dz", "en", "eo", "et", "ee", "fo", "fj", "fi", "fr", "fy", "ff", "gd", "gl", "lg", "ka", "de", "el", "kl", "gn", "gu", "ht", "ha", "he", "hz", "hi", "ho", "hu", "is", "io", "ig", "id", "ia", "ie", "iu", "ik", "ga", "it", "ja", "jv", "kn", "kr", "ks", "kk", "km", "ki", "rw", "ky", "kv", "kg", "ko", "kj", "ku", "lo", "la", "lv", "li", "ln", "lt", "lu", "lb", "mk", "mg", "ms", "ml", "mt", "gv", "mi", "mr", "mh", "mn", "na", "nv", "nd", "nr", "ng", "ne", "no", "nb", "nn", "ii", "oc", "oj", "or", "om", "os", "pi", "ps", "fa", "pl", "pt", "pa", "qu", "ro", "rm", "rn", "ru", "se", "sm", "sg", "sa", "sc", "sr", "sn", "sd", "si", "sk", "sl", "so", "st", "es", "su", "sw", "ss", "sv", "tl", "ty", "tg", "ta", "tt", "te", "th", "bo", "ti", "to", "ts", "tn", "tr", "tk", "tw", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "wa", "cy", "wo", "xh", "yi", "yo", "za", "zu" ], "type": "string", "description": "Only tweets in this language (ISO 639-1 code)." }, "onlyVerifiedUsers": { "title": "Only verified accounts", "type": "boolean", "description": "Only tweets from verified accounts." }, "onlyTwitterBlue": { "title": "Only X Premium (blue check)", "type": "boolean", "description": "Only tweets from X Premium subscribers." }, "onlyImage": { "title": "Only with images", "type": "boolean", "description": "Only tweets that contain images." }, "onlyVideo": { "title": "Only with video", "type": "boolean", "description": "Only tweets that contain video." }, "onlyQuote": { "title": "Only quote tweets", "type": "boolean", "description": "Only tweets that quote another tweet." }, "author": { "title": "From", "type": "string", "description": "Only tweets posted by this handle." }, "inReplyTo": { "title": "Replying to", "type": "string", "description": "Only replies to this handle." }, "mentioning": { "title": "Mentioning", "type": "string", "description": "Only tweets that mention this handle." }, "geotaggedNear": { "title": "Near place", "type": "string", "description": "Only tweets geotagged near this place." }, "withinRadius": { "title": "Within radius", "type": "string", "description": "Radius around the place above, e.g. 15km." }, "geocode": { "title": "Geocode", "type": "string", "description": "latitude,longitude,radius — e.g. 37.78,-122.41,1km." }, "placeObjectId": { "title": "Place ID", "type": "string", "description": "Only tweets tagged with this X place ID." }, "minimumRetweets": { "title": "Minimum reposts", "type": "integer", "description": "Only tweets with at least this many reposts." }, "minimumFavorites": { "title": "Minimum likes", "type": "integer", "description": "Only tweets with at least this many likes." }, "minimumReplies": { "title": "Minimum replies", "type": "integer", "description": "Only tweets with at least this many replies." }, "start": { "title": "From date", "type": "string", "description": "Only tweets posted on or after this date." }, "end": { "title": "Until date", "type": "string", "description": "Only tweets posted before this date." }, "includeSearchTerms": { "title": "Add the search term to each tweet", "type": "boolean", "description": "Adds a searchTerm field with the term, URL or handle that found the tweet." }, "customMapFunction": { "title": "Map function", "type": "string", "description": "A JavaScript function applied to every tweet before it is saved: (tweet) => ({ ...tweet }). For reshaping only — never for filtering." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }