{ "openapi": "3.0.1", "info": { "title": "Twitter Tweet Scraper", "description": "Extract tweets from X/Twitter using search queries, profile URLs, and direct tweet URLs. Get tweet text, engagement metrics, media, and author info ā€” fast, reliable, and cost-effective.", "version": "0.0", "x-build-id": "B469UNDIjGkmxlch1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/happitap~twitter-tweet-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-happitap-twitter-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/happitap~twitter-tweet-scraper/runs": { "post": { "operationId": "runs-sync-happitap-twitter-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/happitap~twitter-tweet-scraper/run-sync": { "post": { "operationId": "run-sync-happitap-twitter-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", "required": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search Terms", "type": "array", "description": "šŸ” **Twitter search queries** using [advanced search syntax](https://github.com/igorbrigadir/twitter-advanced-search).\n\nExamples:\n- `from:NASA` ā€” tweets from NASA\n- `#AI lang:en` ā€” English tweets with #AI\n- `from:elonmusk since:2024-01-01 until:2024-06-01` ā€” date range\n- `bitcoin min_faves:1000` ā€” tweets with 1000+ likes\n- `(puppy OR kitten) -filter:retweets` ā€” exclude retweets\n\nšŸ’” **Tip**: Test your query on Twitter search first!", "default": [ "from:NASA" ], "items": { "type": "string" } }, "startUrls": { "title": "Tweet or Profile URLs", "type": "array", "description": "šŸ“Ž **Direct URLs to scrape**\n\nSupported:\n- Tweet URL: `https://x.com/user/status/123456`\n- Profile URL: `https://x.com/NASA` (scrapes recent tweets)\n\nšŸ’” Leave empty if using search terms above.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max Tweets", "minimum": 1, "maximum": 100000, "type": "integer", "description": "šŸ“Š **Maximum number of tweets to extract**\n\n- Testing: 10-50\n- Small project: 100-500\n- Large project: 1000+\n\nšŸ’° Cost: $0.40 per 1,000 tweets", "default": 100 }, "sort": { "title": "Sort Order", "enum": [ "Latest", "Top" ], "type": "string", "description": "šŸ“ˆ **How to sort search results**\n\n- **Latest**: Newest tweets first (recommended)\n- **Top**: Most popular tweets first", "default": "Latest" }, "tweetLanguage": { "title": "Tweet Language", "type": "string", "description": "šŸŒ **Filter by language** (optional)\n\nISO language codes: `en`, `es`, `fr`, `de`, `ja`, `pt`, etc.\n\nLeave empty for all languages." }, "includeReplies": { "title": "Include Replies", "type": "boolean", "description": "šŸ’¬ **Include reply tweets in results?**\n\nDisable to get only original tweets.", "default": true }, "includeRetweets": { "title": "Include Retweets", "type": "boolean", "description": "šŸ” **Include retweets in results?**\n\nDisable to get only original content.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "šŸŒ **Proxy settings** (Advanced)\n\nResidential proxies are strongly recommended for Twitter scraping.\n\nšŸ’” Leave default for best results.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } }, "scrollTimeout": { "title": "Scroll Timeout (seconds)", "minimum": 10, "maximum": 120, "type": "integer", "description": "ā±ļø **Max seconds to wait for new tweets while scrolling**\n\nIncrease if you're getting fewer results than expected.", "default": 30 } } }, "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 } } } } } } } } } }