{ "openapi": "3.0.1", "info": { "title": "X / Twitter Monitor & Scraper - Profile Timelines & New Posts", "description": "Scrape and monitor public posts from one or many X (Twitter) accounts by handle or URL. Schedule it and turn on 'only new since last run' to get and pay for new posts only. Keyword filter, from:handle search, 23 fields incl. likes, reposts, views. No login. JSON, CSV, Excel.", "version": "0.3", "x-build-id": "spygOqsAMu2Ysc9wn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tictechid~vanzi-x-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tictechid-vanzi-x-monitor", "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/tictechid~vanzi-x-monitor/runs": { "post": { "operationId": "runs-sync-tictechid-vanzi-x-monitor", "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/tictechid~vanzi-x-monitor/run-sync": { "post": { "operationId": "run-sync-tictechid-vanzi-x-monitor", "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": [ "search", "user_timeline", "list" ], "type": "string", "description": "user_timeline = profile timelines (recent posts from one or more handles); list = multi-account posts in one dataset, maxItems split fairly across the handles; search = from:handle + keyword filtering on those accounts' posts.", "default": "user_timeline" }, "handles": { "title": "Handles", "type": "array", "description": "X handles (with or without @). Required for user_timeline and list. Optional for search (seeds keyword filtering).", "items": { "type": "string" } }, "searchQuery": { "title": "Search query", "type": "string", "description": "Required for search mode. Use from:Handle plus keywords (e.g. from:Apify scraper, or from:CoinDesk from:WatcherGuru BTC). Keeps posts from those accounts that contain all keywords; reads up to 5 pages per account." }, "listUrl": { "title": "List URL (optional)", "type": "string", "description": "Optional https://x.com/i/lists/{id} or https://x.com/{user}/lists/{slug}. Native list timeline is probed; X List URLs alone are not supported — always list the accounts in handles." }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Hard cap of posts to push. Use 0 for a safe ceiling of 500. Free-tier tip: keep ≤100 while testing.", "default": 20 }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Keep reply posts in the output.", "default": false }, "includeReposts": { "title": "Include reposts", "type": "boolean", "description": "Keep pure retweets / reposts in the output.", "default": false }, "onlyNewSinceLastRun": { "title": "Only new posts since last run", "type": "boolean", "description": "For scheduled runs: remember the newest post ID per handle and, on later runs, push (and charge) only posts newer than that. The first run returns posts normally and saves the IDs. If nothing is new, the run succeeds with 0 items. Off = normal behaviour.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Name for the saved \"last seen\" state (stored in your key-value store vanzi-x-monitor-state). Use a different key per Task or schedule so they don't share state. Only used when \"Only new posts since last run\" is on.", "default": "default" } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }