{ "openapi": "3.0.1", "info": { "title": "šŸ¦ Twitter (X) Follower Scraper", "description": "Scrape Followers & Following lists of any public X (Twitter) profile in bulk. Returns rich, v1.1-compatible user records with pinned-tweet hydration, full bio, profile image, banner, verified badge and more ā€” streamed live to the dataset.", "version": "0.1", "x-build-id": "SfFveVl3xm0fj2tKf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapium~twitter-x-follower-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapium-twitter-x-follower-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/scrapium~twitter-x-follower-scraper/runs": { "post": { "operationId": "runs-sync-scrapium-twitter-x-follower-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/scrapium~twitter-x-follower-scraper/run-sync": { "post": { "operationId": "run-sync-scrapium-twitter-x-follower-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": [ "auth_token", "ct0" ], "properties": { "urls": { "title": "šŸ”— X (Twitter) Profile URLs or Usernames", "type": "array", "description": "Paste one URL/username per line. Accepts:\nā€¢ `https://x.com/elonmusk`\nā€¢ `https://twitter.com/elonmusk`\nā€¢ `@elonmusk`\nā€¢ `elonmusk`\n\nāš ļø Ignored when **User ID List** is provided below.", "items": { "type": "string" } }, "user_ids": { "title": "šŸ†” User ID List (optional)", "type": "array", "description": "Enter the numeric X user IDs you want to scrape ā€” one per line. Example: `1846987139428634858`.\n\nšŸ’” Use this when you already have user IDs (faster ā€” skips the username lookup).\n\nāš ļø **Note:** When this field has a value, all other URL/username inputs above will be ignored.", "items": { "type": "string" } }, "getFollowers": { "title": "šŸ‘„ Scrape Followers", "type": "boolean", "description": "Collect the profile's **Followers** list.", "default": true }, "getFollowing": { "title": "āž”ļø Scrape Following", "type": "boolean", "description": "Collect the profile's **Following** list.", "default": true }, "maxFollowers": { "title": "šŸ”¢ Max Followers per profile", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on how many followers to fetch per profile. Lower = faster & cheaper.", "default": 20 }, "maxFollowings": { "title": "šŸ”¢ Max Following per profile", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Hard cap on how many followings to fetch per profile.", "default": 20 }, "auth_token": { "title": "šŸ”‘ X auth_token cookie", "type": "string", "description": "Your X (Twitter) `auth_token` cookie from a logged-in browser session. Required ā€” X's Followers/Following GraphQL endpoints reject anonymous traffic.\n\nšŸ‘‰ How to find it: open x.com ā†’ DevTools ā†’ Application ā†’ Cookies ā†’ copy the value of `auth_token`." }, "ct0": { "title": "šŸ”‘ X ct0 (CSRF) cookie", "type": "string", "description": "Your X (Twitter) `ct0` cookie from the same session as `auth_token`. Used as the `x-csrf-token` header." }, "proxyConfiguration": { "title": "šŸŒ Proxy Configuration", "type": "object", "description": "Default = **no proxy**. If X blocks the run, the actor automatically escalates: Direct ā†’ Datacenter ā†’ Residential (3 retries on residential). Override only if you have a specific reason ā€” the actor handles blocks for you.", "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 } } } } } } } } } }