{ "openapi": "3.0.1", "info": { "title": "Twitter X Reply Scraper: Reply Sentiment & Tone Breakdown", "description": "πŸ’¬ Twitter/X Reply Scraper extracts tweet replies at scaleβ€”usernames, text, timestamps, IDs & thread context. πŸ”Ž Perfect for social listening, sentiment, competitor research & engagement tracking. ⚑ CSV/JSON export for dashboards, BI & automation. πŸš€", "version": "0.1", "x-build-id": "HRFlAqjdxefrX60sB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapio~twitter-x-reply-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapio-twitter-x-reply-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/scrapio~twitter-x-reply-scraper/runs": { "post": { "operationId": "runs-sync-scrapio-twitter-x-reply-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/scrapio~twitter-x-reply-scraper/run-sync": { "post": { "operationId": "run-sync-scrapio-twitter-x-reply-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": [ "startUrls" ], "properties": { "startUrls": { "title": "πŸ”— Start URLs β€” where to look on X", "type": "array", "description": "Add one or more X search page links (the same URLs you get when you search on x.com). Each link's `q=` is used as the query. Example: a `#journorequest` search with `min_replies:10` surfaces posts that already have a conversation to analyze. Legacy `urls` is also accepted.", "items": { "type": "string" } }, "maxSearchResults": { "title": "πŸ“Š Maximum posts to collect", "minimum": 1, "maximum": 5000, "type": "integer", "description": "How many posts to collect from each search link. Example: maxSearchResults=10 β†’ up to 10 posts per link. Default is 10.", "default": 10 }, "maxReplies": { "title": "πŸ’¬ Maximum replies per post", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many direct replies to keep and analyze per post. Applied AFTER the language filter, so the cap counts kept replies only. Example: maxReplies=5 β†’ up to 5 replies scored per post. Default is 5.", "default": 5 }, "replyLanguage": { "title": "🌍 Reply language filter (optional)", "type": "string", "description": "Keep only replies whose language matches this code before scoring. Uses X's own per-reply language tag (ISO-639-1-style, e.g. `en`, `es`, `pt`, `fr`, `de`, `ja`). Leave blank to analyze replies in every language. Example: replyLanguage=en β†’ English replies only.", "default": "" }, "aiEnhancement": { "title": "πŸ€– AI reply enrichment (optional, off by default)", "type": "boolean", "description": "When ON, each reply also gets an AI sentiment + tone label (aiReplySentiment / aiReplyTone) alongside the always-on rule-based fields. Requires an API key below. If the AI call fails, those fields are left null (never fabricated). Off by default.", "default": false }, "aiModel": { "title": "🧠 AI Model / Provider", "enum": [ "claude-haiku-4-5", "claude-sonnet-5", "claude-opus-4-8", "gpt-4o-mini", "gpt-4o", "gpt-4.1-mini", "o3-mini", "gemini-2.0-flash-lite", "gemini-2.0-flash", "gemini-2.5-flash", "grok-3-mini", "grok-3", "deepseek-chat", "sonar", "mistral-small-latest" ], "type": "string", "description": "Provider auto-detected from the name: claude-*=Anthropic, gpt-*/o1/o3=OpenAI, gemini-*=Google, grok-*=xAI, deepseek-*=DeepSeek, sonar*=Perplexity, mistral-*=Mistral. Cheaper mini/flash/haiku models are recommended for classification. Only used when AI enrichment is ON.", "default": "claude-haiku-4-5" }, "aiApiKey": { "title": "πŸ”‘ AI API key (optional)", "type": "string", "description": "API key for the chosen provider. Only needed when AI enrichment is ON. If left blank, the actor falls back to the provider's environment variable (e.g. ANTHROPIC_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY, XAI_API_KEY, DEEPSEEK_API_KEY, PERPLEXITY_API_KEY, MISTRAL_API_KEY)." }, "authToken": { "title": "πŸ” Session β€” auth token", "type": "string", "description": "Your X account session auth_token cookie (or set the AUTH_TOKEN environment variable). Reading replies requires a logged-in session. Keep it private β€” never share it publicly." }, "ct0": { "title": "πŸ›‘οΈ Session β€” security (ct0)", "type": "string", "description": "The companion ct0 cookie for your X session (or use the CT0 env var). It works together with your auth token as the CSRF value." }, "proxyConfiguration": { "title": "🌐 Connection & privacy (proxy)", "type": "object", "description": "Optional Apify Proxy settings. Off by default: the run goes direct first, then escalates to datacenter and residential on blocks. Turn it on to route through Apify's network from the start." } } }, "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 } } } } } } } } } }