{ "openapi": "3.0.1", "info": { "title": "X Tweet Scraper", "description": "Browserless X/Twitter tweet scraper built with Node.js and TypeScript. Extracts and filters tweets using HTTP requests only, with pagination, rate-limit handling, retries, deduplication, resumable state, proxy support, and strict free-tier result limits.", "version": "0.1", "x-build-id": "tKqHbmUtLpIPw14jf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lucasacci~x-tweet-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lucasacci-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/lucasacci~x-tweet-scraper/runs": { "post": { "operationId": "runs-sync-lucasacci-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/lucasacci~x-tweet-scraper/run-sync": { "post": { "operationId": "run-sync-lucasacci-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Search terms or phrases to match. At least one of searchTerms, fromUsers, or hashtags must be provided.", "default": [ "openai" ], "items": { "type": "string" } }, "fromUsers": { "title": "From users", "type": "array", "description": "Usernames to include as tweet authors. Do not include the @ prefix.", "default": [], "items": { "type": "string" } }, "toUsers": { "title": "To users", "type": "array", "description": "Usernames whose replies should be included. Do not include the @ prefix.", "default": [], "items": { "type": "string" } }, "mentioning": { "title": "Mentioning", "type": "array", "description": "Usernames mentioned by tweets. Do not include the @ prefix.", "default": [], "items": { "type": "string" } }, "hashtags": { "title": "Hashtags", "type": "array", "description": "Hashtags that tweets must contain. Do not include the # prefix.", "default": [], "items": { "type": "string" } }, "since": { "title": "Since", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Inclusive UTC start date in YYYY-MM-DD format." }, "until": { "title": "Until", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Inclusive UTC end date in YYYY-MM-DD format." }, "language": { "title": "Language", "type": "string", "description": "ISO-639-1 language code to match." }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Minimum inclusive likes threshold." }, "minRetweets": { "title": "Minimum retweets", "minimum": 0, "type": "integer", "description": "Minimum inclusive retweets threshold." }, "minReplies": { "title": "Minimum replies", "minimum": 0, "type": "integer", "description": "Minimum inclusive replies threshold." }, "onlyVerified": { "title": "Only verified", "type": "boolean", "description": "When true, include only tweets from verified authors." }, "mediaType": { "title": "Media type", "enum": [ "any", "text_only", "images", "video", "links" ], "type": "string", "description": "Restrict results to any, text-only, images, video, or links.", "default": "any" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Reply filter: unset means no constraint, false excludes replies, true allows replies." }, "includeRetweets": { "title": "Include retweets", "type": "boolean", "description": "Whether retweets are allowed. Defaults to false.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "latest", "top" ], "type": "string", "description": "Search ordering mode.", "default": "latest" }, "maxResults": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Maximum number of results requested. Free-tier users are limited separately by server-side entitlement enforcement.", "default": 10 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy configuration for HTTP requests." }, "finishWebhookUrl": { "title": "Finish webhook URL", "type": "string", "description": "Optional HTTP or HTTPS URL that receives the final safe run summary after a successful run." } } }, "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 } } } } } } } } } }