{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Profile Scraper", "description": "🐦 Scrape tweets, followers, following, affiliates, and profile data from X (Twitter) accounts.", "version": "0.0", "x-build-id": "uoEpqt7LqH1grTzBq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api-ninja~x-twitter-profile-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api-ninja-x-twitter-profile-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/api-ninja~x-twitter-profile-scraper/runs": { "post": { "operationId": "runs-sync-api-ninja-x-twitter-profile-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/api-ninja~x-twitter-profile-scraper/run-sync": { "post": { "operationId": "run-sync-api-ninja-x-twitter-profile-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": [ "urls" ], "properties": { "urls": { "title": "🔗 Profile URLs or Usernames", "type": "array", "description": "Provide X/Twitter profile URLs, usernames, or @usernames.", "items": { "type": "string" } }, "category": { "title": "🗂️ Category", "enum": [ "tweets", "followers", "following", "affiliates", "user_info" ], "type": "string", "description": "Select a single category to run for all input profiles in this run.", "default": "tweets" }, "maxResults": { "title": "Maximum results", "minimum": 20, "type": "integer", "description": "Maximum number of items to save per profile for paginated categories. Ignored when Parse all results is enabled.", "default": 100 }, "parseAllResults": { "title": "Parse all results", "type": "boolean", "description": "When enabled, keep paginating until the API has no more data to return.", "default": false }, "tweetSubtype": { "title": "Tweet subtype", "enum": [ "all", "replies", "self_threads", "quotes" ], "type": "string", "description": "When category is Tweets, optionally narrow results to replies, self-threads, or quote tweets. Leave as All posts to use a plain from:username latest query.", "default": "all" }, "includeNativeRetweets": { "title": "Include native retweets", "type": "boolean", "description": "Include native retweets in tweet results using include:nativeretweets.", "default": false }, "mediaSubtype": { "title": "Media subtype", "enum": [ "any", "media", "images", "videos" ], "type": "string", "description": "Restrict tweet results to any media, images only, or videos only.", "default": "any" }, "requireLinks": { "title": "Require links", "type": "boolean", "description": "Only keep tweets that contain links.", "default": false }, "requireHashtags": { "title": "Require hashtags", "type": "boolean", "description": "Only keep tweets that contain hashtags.", "default": false }, "requireMentions": { "title": "Require mentions", "type": "boolean", "description": "Only keep tweets that contain mentions.", "default": false }, "hasEngagement": { "title": "Require engagement", "type": "boolean", "description": "Only keep tweets that have some engagement such as likes, replies, or retweets.", "default": false }, "minRetweets": { "title": "Minimum retweets", "minimum": 0, "type": "integer", "description": "Minimum retweet count." }, "minLikes": { "title": "Minimum likes", "minimum": 0, "type": "integer", "description": "Minimum like count." }, "minReplies": { "title": "Minimum replies", "minimum": 0, "type": "integer", "description": "Minimum reply count." }, "maxRetweets": { "title": "Maximum retweets", "minimum": 0, "type": "integer", "description": "Maximum retweet count." }, "maxLikes": { "title": "Maximum likes", "minimum": 0, "type": "integer", "description": "Maximum like count." }, "maxReplies": { "title": "Maximum replies", "minimum": 0, "type": "integer", "description": "Maximum reply count." }, "language": { "title": "Language", "pattern": "^[a-z]{2,3}$", "type": "string", "description": "Restrict tweet results to a language code such as en, es, fr, de, ja, or zh. Use 2-3 lowercase letters only." }, "since": { "title": "Since date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only keep tweets on or after this date. Format: YYYY-MM-DD." }, "until": { "title": "Until date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Only keep tweets before this date. Format: YYYY-MM-DD." }, "withinTime": { "title": "Within time", "pattern": "^[1-9][0-9]*[dhms]$", "type": "string", "description": "Only keep tweets within a recent time window. Examples: 7d, 12h, 30m." }, "sinceTime": { "title": "Since unix time", "minimum": 0, "type": "integer", "description": "Only keep tweets on or after this Unix timestamp in seconds." }, "untilTime": { "title": "Until unix time", "minimum": 0, "type": "integer", "description": "Only keep tweets before this Unix timestamp in seconds." }, "sinceId": { "title": "Since tweet ID", "pattern": "^\\d+$", "type": "string", "description": "Only keep tweets after this tweet snowflake ID." } } }, "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 } } } } } } } } } }