{ "openapi": "3.0.1", "info": { "title": "X Twitter Posts Search", "description": "Collect real-time and historical posts from X based on search queries, hashtags, or accounts. Apply filters for likes, reposts, replies, and dates. Export structured data for analytics, brand monitoring, and audience insights.", "version": "0.1", "x-build-id": "wgTeWYkTJcN08GGta" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-empire~x-twitter-posts-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-empire-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/api-empire~x-twitter-posts-search/runs": { "post": { "operationId": "runs-sync-api-empire-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/api-empire~x-twitter-posts-search/run-sync": { "post": { "operationId": "run-sync-api-empire-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 to scrape โ€” profiles, @users, or keywords", "type": "array", "description": "๐Ÿ“‹ **Add one row per target.** Mix and match freely!\n\nโœ… **What works:**\nโ€ข ๐Ÿ”— Profile URL โ€” `https://x.com/elonmusk`\nโ€ข ๐Ÿ‘ค Handle โ€” `@NASA` or `BarackObama`\nโ€ข ๐Ÿ”ค Keyword(s) โ€” `climate change` ยท `world cup final`\nโ€ข ๐Ÿง  Search syntax โ€” `search: python from:NASA min_retweets:50`\n\n๐Ÿšซ **Skipped:** single-tweet links (`โ€ฆ/status/123โ€ฆ`).\n\n๐Ÿ’ก **Tip:** multi-word input = search ยท single word / URL = that account's timeline.", "items": { "type": "string" } }, "maxTweets": { "title": "๐Ÿ”ข Max posts per target", "minimum": 1, "maximum": 10000, "type": "integer", "description": "๐ŸŽฏ **Cap collection per target** (URL / user / keyword).\n\nโš–๏ธ Higher = more data + longer runs.\n๐Ÿ’ธ Tip: start small (50โ€“100) to validate, then scale up.", "default": 10 }, "searchType": { "title": "๐Ÿ”Ž Search mode โ€” Top or Latest", "enum": [ "top", "latest" ], "type": "string", "description": "๐Ÿ† **Top** โ†’ popular & relevant posts (great for trends and analysis).\n๐Ÿ†• **Latest** โ†’ newest first (perfect with **Time window** for monitoring).\n\n๐Ÿง‘ On **profile** runs this controls the sort order of saved posts.", "default": "top" }, "timeWindow": { "title": "๐Ÿ“… Time window โ€” last N days", "minimum": 1, "type": "integer", "description": "๐Ÿ—“๏ธ **Keep only posts newer than N days (UTC).**\n\nโš™๏ธ Requires **Search mode โ†’ Latest**.\n๐Ÿ”• Leave empty to collect up to *Max posts* regardless of date." }, "timeWindowHours": { "title": "๐Ÿ• Time window โ€” last N hours", "minimum": 1, "type": "integer", "description": "โฐ **Keep only posts newer than N hours (UTC).**\n\nโš™๏ธ Requires **Search mode โ†’ Latest**.\nโšก Use this for breaking-news / real-time monitoring.\n๐Ÿ‘‘ Takes precedence over days if both are set." }, "proxyConfiguration": { "title": "๐ŸŒ Proxy โ€” recommended for stable runs", "type": "object", "description": "๐Ÿ”’ **Off** โ†’ direct connection (fast, but X may block datacenter IPs).\nโœ… **On** โ†’ Apify Proxy (pick your groups in the UI).\n\nโญ **For stubborn blocks โ†’ RESIDENTIAL** is the most reliable choice on X." } } }, "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 } } } } } } } } } }