{ "openapi": "3.0.1", "info": { "title": "X Twitter Posts Search", "description": "Search and collect public posts from X using keywords, hashtags, phrases, or specific accounts. Filter results by date, language, engagement, and popularity. Export structured post data for research, brand monitoring, trend tracking, lead discovery, and content analysis.", "version": "0.1", "x-build-id": "tXjHa67LWbB1eH6vd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~x-twitter-posts-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-x-twitter-posts-search", "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/scrapio~x-twitter-posts-search/runs": { "post": { "operationId": "runs-sync-scrapio-x-twitter-posts-search", "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/scrapio~x-twitter-posts-search/run-sync": { "post": { "operationId": "run-sync-scrapio-x-twitter-posts-search", "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": [ "startUrls", "searchType" ], "properties": { "startUrls": { "title": "๐Ÿ”— Targets โ€” URLs, @users, or keywords", "type": "array", "description": "๐Ÿ“‹ Add one row per target.\n\nโœ… Works: `https://x.com/username` ยท `@user` ยท `username` ยท `climate change` ยท `search: python from:NASA`\n๐Ÿšซ Skipped: links to a **single tweet** (`โ€ฆ/status/123โ€ฆ`).\n\n๐Ÿ’ก Multi-word = search. One word / profile URL = that accountโ€™s posts.", "items": { "type": "string" } }, "maxTweets": { "title": "๐Ÿ”ข Max posts per target", "minimum": 1, "maximum": 1000, "type": "integer", "description": "๐ŸŽฏ Cap how many posts to collect **per** URL, user, or keyword (1โ€“1000). ๐Ÿ“Š Higher = longer run & more API load.", "default": 10 }, "timeWindow": { "title": "โฑ๏ธ Only posts from the last N days", "minimum": 1, "type": "integer", "description": "๐Ÿ“… Keep posts **newer** than this many days (UTC).\n\nโš™๏ธ Requires **Search type โ†’ Latest** + a number here.\nโœ… Applies to **keyword search** and **profile** timelines.\n๐Ÿ”• Leave empty if you want all posts up to **Max posts**." }, "searchType": { "title": "๐Ÿ”Ž Search mode โ€” Top or Latest", "enum": [ "top", "latest" ], "type": "string", "description": "๐Ÿ“Œ **Top** โ†’ popular / relevant ordering (good for broad topics).\n๐Ÿ“Œ **Latest** โ†’ newest first (best for news + **Time window**).\n\n๐Ÿง‘ On **profile** runs this mainly changes **sort order** of saved posts.", "default": "top" }, "proxyConfiguration": { "title": "๐ŸŒ Proxy (recommended for X)", "type": "object", "description": "๐Ÿ”’ Off = direct connection (fast, but X may block datacenter IPs).\nโœ… On = Apify Proxy โ€” pick groups in the proxy UI.\n\n๐Ÿ”„ The actor can **escalate** to other Apify proxy tiers if a request **throws** (network errors). Empty API responses still need a better IP or retry.\n\nโญ For stubborn blocks, try **RESIDENTIAL**." } } }, "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 } } } } } } } } } }