{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Search Scraper", "description": "Search X (Twitter) by keyword, hashtag, or 'from:user' query and stream matching tweets. Supports Top / Latest / People / Photos / Videos tabs. HTTP-only, no native login flow.", "version": "1.0", "x-build-id": "I83ury1qbf8VKVmn5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xtracto~x-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xtracto-x-search-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/xtracto~x-search-scraper/runs": { "post": { "operationId": "runs-sync-xtracto-x-search-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/xtracto~x-search-scraper/run-sync": { "post": { "operationId": "run-sync-xtracto-x-search-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": [ "queries" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "List of X (Twitter) search queries. Two modes are supported: (1) Per-user queries using the `from:USERNAME [keywords]` syntax (e.g. `from:jack twitter`) — works anonymously, no setup. (2) General keyword/hashtag queries (e.g. `bitcoin`, `#worldcup`) — requires the `xCookies` field below. Without cookies, general queries return a structured `_error: \"login_required\"` record.", "items": { "type": "string" } }, "maxResults": { "title": "Max results per query", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum tweets returned per query. Caps at 500. Pagination handled automatically via cursor.", "default": 20 }, "product": { "title": "Search tab", "enum": [ "Top", "Latest", "People", "Photos", "Videos" ], "type": "string", "description": "Which X search tab to read from. Only applied when running in authenticated mode (with `xCookies`). Anonymous `from:USERNAME` queries always return the user's full timeline regardless of this setting.", "default": "Top" }, "xCookies": { "title": "X (Twitter) cookies — optional, unlocks general search", "type": "string", "description": "Paste your logged-in X cookies here to unlock general keyword and hashtag search. Accepts either (a) the JSON export from the Cookie-Editor browser extension or (b) a `name=value; name=value` cookie string. At minimum `auth_token` and `ct0` are required. See the actor README for a step-by-step tutorial. Leave empty for anonymous per-user (`from:USERNAME`) mode." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings. For anonymous per-user (`from:USERNAME`) search, datacenter proxy is fine. For authenticated general keyword/hashtag search (with `xCookies`), use RESIDENTIAL groups — X soft-blocks general search by IP and datacenter ranges get a 404-empty response. Each run picks a fresh egress IP, which is what makes authenticated search reliable.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }