{ "openapi": "3.0.1", "info": { "title": "Twitter (X) Scraper: Profiles, Posts & Trends", "description": "Scrape public Twitter (X) profiles, posts, timelines, Highlights, trends, communities, videos, Articles, Spaces and broadcasts without login. Batch targets, monitor changes and export consistent 60-field records.", "version": "0.0", "x-build-id": "bsJr19jVj2vTAi4wf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~twitter-x-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-twitter-x-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/scrapingmonkey~twitter-x-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-twitter-x-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/scrapingmonkey~twitter-x-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-twitter-x-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "profile", "tweet", "userTimeline", "userRecent", "highlights", "threadPreview", "replyAncestors", "trends", "trendLocations", "trendingPosts", "trendPosts", "community", "communityPosts", "communityMembers", "communityMedia", "videoFeed", "asset", "article", "space", "broadcast", "monitorProfile", "monitorTrends", "monitorCommunity" ], "type": "string", "description": "Choose the public X surface to extract. Monitoring modes remember the previous run in the same task storage.", "default": "profile" }, "targets": { "title": "Targets", "type": "array", "description": "Handles, X URLs or IDs required by the selected mode. Handles accept NASA, @NASA or https://x.com/NASA. Post, community, Space and broadcast modes accept either a full X URL or its ID. Asset mode accepts TSLA or $TSLA. Trend-post mode accepts trend names or hashtags.", "items": { "type": "string" }, "default": [ "NASA" ] }, "woeids": { "title": "Trend location WOEIDs", "type": "array", "description": "Numeric Yahoo Where On Earth IDs used by trends and monitorTrends. Use mode trendLocations to discover all currently supported IDs. 1 means worldwide.", "items": { "type": "string" }, "default": [ "1" ] }, "maxItems": { "title": "Maximum results per target", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum dataset rows kept for each handle, ID, symbol, trend or WOEID. Use 0 for every item the public source makes available in one run.", "default": 50 }, "maxTotalItems": { "title": "Maximum results for the run", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional hard cap after all targets are combined. 0 means no additional run-wide cap.", "default": 0 }, "trendWindow": { "title": "Trending-post time window", "enum": [ "Day", "Week", "Month" ], "type": "string", "description": "Time window used by trendingPosts and trendPosts.", "default": "Day" }, "assetTimeframe": { "title": "Asset timeframe", "type": "string", "description": "Timeframe forwarded to X market-data cards, for example 1D.", "default": "1D" }, "assetCandleSize": { "title": "Asset candle size", "type": "string", "description": "Candle size forwarded to X market-data cards, for example 1h.", "default": "1h" }, "includeRaw": { "title": "Include raw source objects", "type": "boolean", "description": "Also store the underlying public X payload under raw and inside normalized nested objects. This can substantially increase dataset size.", "default": false }, "monitorKey": { "title": "Monitor key", "maxLength": 80, "type": "string", "description": "Separates independent monitors that otherwise use the same mode and targets.", "default": "default" }, "monitorBehavior": { "title": "Monitor output", "enum": [ "newOnly", "newAndChanged" ], "type": "string", "description": "newOnly emits newly observed records. newAndChanged also emits known records whose public fields or engagement metrics changed.", "default": "newAndChanged" }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 32, "type": "integer", "description": "Maximum independent handles, IDs or locations processed at the same time.", "default": 8 }, "maxRequestRetries": { "title": "Request retries", "minimum": 1, "maximum": 8, "type": "integer", "description": "Attempts for temporary X errors. Guest tokens rotate automatically for rate-limit and access responses.", "default": 3 }, "requestTimeoutSecs": { "title": "Request timeout", "minimum": 10, "maximum": 120, "type": "integer", "description": "Maximum duration of one X request in seconds.", "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 } } } } } } } } } }