{ "openapi": "3.0.1", "info": { "title": "Scrapeclaw - Twitter Scraper", "description": "Part of ScrapeClaw (https://scrapeclaw.cc/) — a suite of production-ready, agentic social media scrapers for Instagram, YouTube, X/Twitter, TikTok, and Facebook. Built with Python & Playwright. No API keys required.", "version": "0.0", "x-build-id": "kJVh362KEZmxAD9bq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeclaw~scrapeclaw---twitter-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeclaw-scrapeclaw---twitter-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/scrapeclaw~scrapeclaw---twitter-scraper/runs": { "post": { "operationId": "runs-sync-scrapeclaw-scrapeclaw---twitter-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/scrapeclaw~scrapeclaw---twitter-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeclaw-scrapeclaw---twitter-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", "properties": { "mode": { "title": "Run Mode", "enum": [ "full", "discovery_only", "scrape_profiles" ], "type": "string", "description": "full = discover profiles then scrape them; discovery_only = only find usernames; scrape_profiles = scrape the profileUsernames list directly.", "default": "full" }, "region": { "title": "Region Preset", "enum": [ "us", "uk", "ind", "eur", "gulf", "east", "custom" ], "type": "string", "description": "Pre-configured region with relevant categories and locations. Choose 'custom' to specify your own.", "default": "us" }, "categories": { "title": "Categories", "type": "array", "description": "Content categories to discover (used when region = custom or to override preset).", "items": { "type": "string" }, "default": [ "tech", "sports", "entertainment", "news", "finance", "politics" ] }, "locations": { "title": "Locations", "type": "array", "description": "Geographic locations to search within (used when region = custom or to override preset).", "items": { "type": "string" }, "default": [ "New York", "Los Angeles", "Chicago", "Miami", "San Francisco" ] }, "profileUsernames": { "title": "Profile Usernames (scrape_profiles mode)", "type": "array", "description": "List of Twitter/X usernames to scrape directly. Used when mode = scrape_profiles. Include or omit the @ prefix.", "items": { "type": "string" } }, "maxProfiles": { "title": "Max Profiles to Scrape", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Maximum number of profiles to scrape (0 = unlimited).", "default": 50 }, "minFollowers": { "title": "Minimum Followers Filter", "minimum": 0, "type": "integer", "description": "Skip profiles with fewer followers than this value (0 = no filter).", "default": 500 }, "maxTweetsPerProfile": { "title": "Max Recent Tweets Per Profile", "minimum": 0, "maximum": 100, "type": "integer", "description": "Number of recent tweets to scrape per profile.", "default": 20 }, "downloadThumbnails": { "title": "Download Profile Pics & Media to Key-Value Store", "type": "boolean", "description": "If enabled, profile pictures and tweet media images are downloaded and stored in the actor's Key-Value store.", "default": false }, "googleApiKey": { "title": "Google Custom Search API Key", "type": "string", "description": "Optional. If provided together with googleSearchEngineId, uses Google Custom Search for discovery instead of DuckDuckGo." }, "googleSearchEngineId": { "title": "Google Custom Search Engine ID (CX)", "type": "string", "description": "Optional. The Custom Search Engine ID (cx) to use with the Google API key." }, "skipProxyValidation": { "title": "Skip Proxy Validation", "type": "boolean", "description": "Skip the proxy connectivity check before scraping. Useful when the proxy is known to work but blocks common test sites.", "default": false }, "dropProxyOnFailure": { "title": "Drop Proxy if Validation Fails", "type": "boolean", "description": "If proxy validation fails, disable the proxy and run directly. By default the proxy is kept even if validation fails.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy settings. Recommended: use Apify Residential proxies to avoid rate-limiting by Twitter/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 } } } } } } } } } }