{ "openapi": "3.0.1", "info": { "title": "🐦 Twitter (X) User Scraper", "description": null, "version": "0.1", "x-build-id": "fjsG2qRw4VqPl1ppc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraperx~twitter-x-user-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraperx-twitter-x-user-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/scraperx~twitter-x-user-scraper/runs": { "post": { "operationId": "runs-sync-scraperx-twitter-x-user-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/scraperx~twitter-x-user-scraper/run-sync": { "post": { "operationId": "run-sync-scraperx-twitter-x-user-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", "authToken", "csrfToken" ], "properties": { "startUrls": { "title": "🔗 Profile URLs", "uniqueItems": true, "type": "array", "description": "List one or more X / Twitter profile URLs. Examples: `https://x.com/elonmusk`, `https://twitter.com/openai`. You can also paste plain usernames (e.g. `elonmusk`).", "items": { "type": "string" } }, "maxItems": { "title": "🎯 Max items per source", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of users to collect per input URL. Helps you stay inside your monetization budget.", "default": 10 }, "authToken": { "title": "🔐 X auth_token cookie", "type": "string", "description": "Required. Paste your `auth_token` cookie from x.com. Open x.com in your browser → DevTools → Application → Cookies → copy the `auth_token` value." }, "csrfToken": { "title": "🛡️ X ct0 (csrf) cookie", "type": "string", "description": "Required. The `ct0` cookie from x.com that pairs with your `auth_token` — found beside it in DevTools → Application → Cookies." }, "getRetweeters": { "title": "🔁 Get retweeters / related users", "type": "boolean", "description": "When enabled, also collect users surfaced from the profile's timeline (retweeters, mentions, quoted authors). Disable to scrape only the profile owner.", "default": true }, "getFollowers": { "title": "👥 Include follower count", "type": "boolean", "description": "Include `followers` (follower count) in each output record.", "default": true }, "getFollowing": { "title": "🤝 Include following count", "type": "boolean", "description": "Include `following` (friends count) in each output record.", "default": true }, "getAbout": { "title": "🪪 Include rich `about` profile", "type": "boolean", "description": "Enrich each user with verification info, profile image shape, account creation source, and other profile-only fields. Slightly slower because every user is re-fetched via the profile API.", "default": false }, "includeUnavailableUsers": { "title": "👻 Include unavailable users", "type": "boolean", "description": "Include users that X marks as suspended / protected / deleted. They appear with `isUnavailable: true` and `unavailableReason`.", "default": false }, "proxyConfiguration": { "title": "🌐 Proxy configuration", "type": "object", "description": "By default the actor goes direct (no proxy). If X blocks the request, it automatically falls back to Apify DATACENTER proxies, then to RESIDENTIAL (3 retries). Override here to force a specific proxy.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }