{ "openapi": "3.0.1", "info": { "title": "Twitter X-Plorer 🦜", "description": "💫 All-in-one Twitter X.com Scraper 🐦🐦‍⬛🐤", "version": "0.3", "x-build-id": "2AqOuIJKfH1kour4w" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jupri~twitter-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jupri-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/jupri~twitter-scraper/runs": { "post": { "operationId": "runs-sync-jupri-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/jupri~twitter-scraper/run-sync": { "post": { "operationId": "run-sync-jupri-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": { "query": { "title": "❓ Query", "type": "string", "description": "💡 Query, Search Terms or URL" }, "example": { "title": "💡 Examples", "enum": [ "angry bird", "@elonmusk", "@elonmusk/about", "@elonmusk/info", "@elonmusk/posts", "https://x.com/elonmusk/media" ], "type": "string", "description": "💡 QUERY Examples" }, "limit": { "title": "🔢 Limit", "type": "integer", "description": "💡 Limit number of results" }, "filters.type": { "title": "🔎 Search Type", "enum": [ "latest", "top", "people", "media", "photos", "videos", "lists", "communities", "jobs" ], "type": "string", "description": "💡 Tweets product (tab) (default: Latest)" }, "content": { "title": "📄 Content", "enum": [ "text", "html", "md" ], "type": "string", "description": "💡 Content format (default: text)" }, "token": { "title": "🔑 Token", "type": "string", "description": "" }, "auth_token": { "title": "🔑 Token", "type": "string", "description": "" }, "filters.url": { "title": "🔗 Containing URL", "type": "string", "description": "💡 Containing URL (not twitter URL). example: youtube.com" }, "filters.within_community": { "title": "Search (Latest or Top) Tweets within Communities", "type": "boolean", "description": "" }, "filters.lang": { "title": "Language", "enum": [ "any", "ar", "ar-x-fm", "bn", "eu", "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", "es", "sv", "ta", "th", "zh-tw", "tr", "uk", "ur", "vi" ], "type": "string", "description": "" }, "filters.word": { "title": "Word", "type": "string", "description": "💡 All of these words" }, "filters.phrase": { "title": "Phrase", "type": "string", "description": "💡 This exact phrase" }, "filters.any": { "title": "Any", "type": "string", "description": "💡 Any of these words" }, "filters.exclude": { "title": "Exclude", "type": "string", "description": "💡 None of these words" }, "filters.hashtag": { "title": "Hashtag", "type": "string", "description": "💡 These hashtags" }, "filters.from": { "title": "From", "type": "string", "description": "💡 From these accounts" }, "filters.to": { "title": "To", "type": "string", "description": "💡 To these accounts" }, "filters.mention": { "title": "Mention", "type": "string", "description": "💡 Mentioning these accounts" }, "filters.retweets": { "title": "Retweets", "type": "boolean", "description": "💡 Old style retweets (\"RT\") + quoted tweets" }, "filters.replies": { "title": "Replies", "type": "boolean", "description": "💡 Reply to another Tweet" }, "filters.min_retweets": { "title": "Retweets", "type": "integer", "description": "💡 Minimum retweets" }, "filters.min_replies": { "title": "Replies", "type": "integer", "description": "💡 Minimum replies" }, "filters.min_faves": { "title": "Likes", "type": "integer", "description": "💡 Minimum likes" }, "filters.since": { "title": "Since", "type": "string", "description": "💡 Since (YYYY-MM-DD)" }, "filters.until": { "title": "Until", "type": "string", "description": "💡 Until (YYYY-MM-DD)" }, "filters.within_time": { "title": "Within", "type": "string", "description": "💡 Within time (s)econds, (m)inutes, (h)ours, (d)ays example: 7d" }, "filters.near": { "title": "Near", "type": "string", "description": "💡 Near a location. example: alaska" }, "filters.within": { "title": "Within", "type": "string", "description": "💡 Within radius: mi, km example: 10mi" }, "filters.geocode": { "title": "Geocode", "type": "string", "description": "💡 Geocode: LAT,LON,RADIUS example: 37.781157,-122.398720,1mi" }, "filters.media": { "title": "Media", "type": "boolean", "description": "💡 All Media" }, "filters.images": { "title": "Images", "type": "boolean", "description": "💡 Links identified as photos, including third parties such as Instagram" }, "filters.twimg": { "title": "Twimg", "type": "boolean", "description": "💡 Native Twitter images (pic.twitter.com links)" }, "filters.videos": { "title": "Videos", "type": "boolean", "description": "💡 Video types, including native Twitter video and external sources such as Youtube" }, "filters.native_video": { "title": "Native Video", "type": "boolean", "description": "💡 Twitter-owned video types (native video, vine, periscope)" }, "filters.consumer_video": { "title": "Consumer Video", "type": "boolean", "description": "💡 Twitter native video" }, "filters.pro_video": { "title": "Pro Video", "type": "boolean", "description": "💡 Twitter pro video (Amplify)" }, "filters.vine": { "title": "Vine", "type": "boolean", "description": "" }, "filters.periscope": { "title": "Periscope", "type": "boolean", "description": "💡 Periscope video URL" }, "filters.links": { "title": "Links", "type": "boolean", "description": "" }, "filters.news": { "title": "News", "type": "boolean", "description": "" }, "filters.spaces": { "title": "Spaces", "type": "boolean", "description": "" }, "filters.safe": { "title": "Safe", "type": "boolean", "description": "💡 Exclude NSFW posts" }, "filters.verified": { "title": "Verified", "type": "boolean", "description": "" }, "filters.location": { "title": "Location", "type": "string", "description": "" }, "filters.location_type": { "title": "Location Type", "type": "array", "description": "", "items": { "type": "string", "enum": [ "onsite", "remote", "hybrid" ], "enumTitles": [ "Onsite", "Remote", "Hybrid" ] } }, "filters.seniority": { "title": "Seniority", "type": "array", "description": "", "items": { "type": "string", "enum": [ "entry_level", "junior", "mid_level", "senior", "lead", "manager", "executive" ], "enumTitles": [ "Entry Level", "Junior", "Mid-Level", "Senior", "Lead", "Manager", "Executive" ] } }, "filters.employment": { "title": "Employment Type", "type": "array", "description": "", "items": { "type": "string", "enum": [ "full_time", "full_time_contract", "part_time", "contract_to_hire" ], "enumTitles": [ "Full-Time", "Full-Time Contract", "Part-Time", "Contract-to-Hire" ] } }, "filters.company": { "title": "Company Name", "type": "string", "description": "" }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "object", "description": "💡 Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

Example: socks5://example.com:9000" }, "dev_custom_headers": { "title": "📜 HTTP HEADERS", "type": "array", "description": "💡 Additional HTTP Headers", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_custom_cookies": { "title": "🍰 HTTP COOKIES", "type": "array", "description": "💡 Additional HTTP Cookies", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_transform_fields": { "title": "♻️ CUSTOM FIELD", "type": "array", "description": "💡 Transform the resulting output. Select only needed fields.

For nested object use DOT. For example: 
address.streetAddress

For nested array use NUMBER (index of array element starting from index=0). For example: 
images.0.url
", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_dataset_name": { "title": "📁 CUSTOM STORAGE", "type": "string", "description": "💡 Save results into custom named Dataset, use mask to customize dataset name

{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)

This masks can be used to autogenerate Dataset Name.

example: data-{DATE}
Depending on today date the dataset name will be: data-20230603

default: data-{ACTOR}-{DATE}-{TIME}" }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update." }, "dev_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)" } } }, "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 } } } } } } } } } }