{ "openapi": "3.0.1", "info": { "title": "X Feed Monitor", "description": "Monitor X/Twitter in real-time using Grok's x_search API. Collect posts by keyword, hashtag, or @mention with engagement metrics. Optional sentiment analysis. Returns post IDs, timestamps, authors, and URLs. Perfect for brand monitoring, trend tracking, and social listening.", "version": "1.0", "x-build-id": "wjAYEIkfPyCm0ekwN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/constant_quadruped~x-feed-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-constant_quadruped-x-feed-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/constant_quadruped~x-feed-monitor/runs": { "post": { "operationId": "runs-sync-constant_quadruped-x-feed-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/constant_quadruped~x-feed-monitor/run-sync": { "post": { "operationId": "run-sync-constant_quadruped-x-feed-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": [ "queries" ], "properties": { "queries": { "title": "Queries", "type": "array", "description": "Keywords, hashtags, or accounts to monitor. Can be strings or objects with advanced options." }, "mode": { "title": "Mode", "enum": [ "collect", "analyze", "both" ], "type": "string", "description": "Operation mode: collect only, analyze only, or both", "default": "collect" }, "maxResults": { "title": "Max Results Per Query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Hard cap on posts per query", "default": 50 }, "maxPages": { "title": "Max Pages", "minimum": 1, "maximum": 10, "type": "integer", "description": "Pagination limit per query", "default": 1 }, "maxCostUsd": { "title": "Max Cost (USD)", "minimum": 0, "type": "number", "description": "Hard abort if projected cost exceeds this amount" }, "maxApiCalls": { "title": "Max API Calls", "minimum": 1, "type": "integer", "description": "Alternative hard cap on API calls" }, "sinceId": { "title": "Since ID", "type": "string", "description": "Only fetch posts newer than this ID (overrides other since options)" }, "sinceMinutes": { "title": "Since Minutes", "minimum": 1, "type": "integer", "description": "Only fetch posts from the last N minutes" }, "includeReplies": { "title": "Include Replies", "type": "boolean", "description": "Include reply posts", "default": true }, "includeReposts": { "title": "Include Reposts", "type": "boolean", "description": "Include repost/retweet posts", "default": true }, "includeQuotes": { "title": "Include Quotes", "type": "boolean", "description": "Include quote posts", "default": true }, "analysisLevel": { "title": "Analysis Level", "enum": [ "none", "light", "full" ], "type": "string", "description": "Depth of AI analysis on posts", "default": "none" }, "includeMetrics": { "title": "Include Metrics", "type": "boolean", "description": "Include engagement metrics (likes, reposts, etc.)", "default": true }, "persistState": { "title": "Persist State", "type": "boolean", "description": "Save cursor state for incremental runs", "default": true }, "stateKey": { "title": "State Key", "type": "string", "description": "KV store key for state persistence", "default": "STATE" }, "dedupe": { "title": "Deduplicate", "type": "boolean", "description": "Remove duplicate posts within a run", "default": true }, "estimateOnly": { "title": "Estimate Only", "type": "boolean", "description": "Output cost estimate without fetching data", "default": false }, "webhook": { "title": "Webhook URL", "type": "string", "description": "URL to POST on completion" }, "outputFormat": { "title": "Output Format", "enum": [ "dataset", "json", "csv" ], "type": "string", "description": "Additional export format (dataset always written)", "default": "dataset" }, "grokApiKey": { "title": "Grok API Key", "type": "string", "description": "xAI API key (or set GROK_API_KEY env var). Get one free at console.x.ai" } } }, "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 } } } } } } } } } }