{
"openapi": "3.0.1",
"info": {
"title": "X Scraper Studio",
"description": "Paste mixed X / Twitter targets — handles, tweet links, hashtags, communities, lists — and collect tweets, people, replies, followers, or trends as clean JSON. No login, no cookies, no proxy.",
"version": "1.0",
"x-build-id": "aOwYt7c3B3BurrdIZ"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/social_developer~x-scraper-studio/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-social_developer-x-scraper-studio",
"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/social_developer~x-scraper-studio/runs": {
"post": {
"operationId": "runs-sync-social_developer-x-scraper-studio",
"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/social_developer~x-scraper-studio/run-sync": {
"post": {
"operationId": "run-sync-social_developer-x-scraper-studio",
"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": {
"paste": {
"title": "Paste anything (one per line)",
"type": "string",
"description": "Mix freely — Auto reads each line. @NASA or a profile link → their tweets. A tweet link or ID → that tweet. #AI or climate summit → search. Community and list links work too. Leave empty only for Trends (set region below)."
},
"job": {
"title": "What to collect",
"enum": [
"auto",
"profile_tweets",
"profile_replies",
"profile_media",
"profile_likes",
"profile_mentions",
"profile_about",
"followers",
"following",
"verified_followers",
"search_tweets",
"search_people",
"tweet_details",
"tweet_replies",
"tweet_quotes",
"tweet_thread",
"tweet_likers",
"tweet_reposts",
"tweet_article",
"community_tweets",
"community_members",
"community_moderators",
"community_search",
"list_tweets",
"list_members",
"list_followers",
"trends"
],
"type": "string",
"description": "@handles → their tweets · #hashtags / text → search · tweet links → that tweet. Leave Auto unless you need another slice — scan by prefix: Profile, Search, Tweet, Community, List.",
"default": "auto"
},
"maxItems": {
"title": "Stop after this many (per line)",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "Cap for each pasted line, not the whole run. Example: 3 lines × 50 = up to 150 rows.",
"default": 50
},
"fromDate": {
"title": "Posted after",
"type": "string",
"description": "Keep posts on/after this day (YYYY-MM-DD). Ignored for people lists, profile cards, and trends."
},
"toDate": {
"title": "Posted before",
"type": "string",
"description": "Keep posts on/before this day (YYYY-MM-DD). Leave empty for no end date."
},
"sort": {
"title": "Latest or Top",
"enum": [
"latest",
"top"
],
"type": "string",
"description": "Latest = monitoring. Top = research. Used for search and similar feeds.",
"default": "latest"
},
"replies": {
"title": "Replies",
"enum": [
"include",
"exclude",
"only"
],
"type": "string",
"description": "Filters tweet results only. Does nothing to followers, likers, profile cards, or trends.",
"default": "include"
},
"reposts": {
"title": "Reposts",
"enum": [
"include",
"exclude",
"only"
],
"type": "string",
"description": "Include, hide, or keep only reposts / retweets.",
"default": "include"
},
"media": {
"title": "Media",
"enum": [
"any",
"media",
"images",
"videos",
"gifs",
"links",
"none"
],
"type": "string",
"description": "Limit to posts with a certain attachment, or text-only.",
"default": "any"
},
"language": {
"title": "Language",
"enum": [
"any",
"en",
"hi",
"es",
"ar",
"pt",
"fr",
"de",
"id",
"ja",
"ur",
"bn",
"ta",
"te",
"mr",
"gu"
],
"type": "string",
"description": "Keep posts in one language. Any = no language filter.",
"default": "any"
},
"replyScope": {
"title": "Which replies",
"enum": [
"all",
"direct"
],
"type": "string",
"description": "Used when collecting replies on a tweet. All = direct + nested. Direct only = top-level replies.",
"default": "all"
},
"minLikes": {
"title": "Minimum likes",
"minimum": 1,
"maximum": 100000000,
"type": "integer",
"description": "Drop weaker posts. For people search, this is treated as a minimum follower count."
},
"verifiedOnly": {
"title": "Checkmark accounts only",
"type": "boolean",
"description": "Keep verified authors / profiles only.",
"default": false
},
"trendRegion": {
"title": "Region",
"enum": [
"worldwide",
"india",
"united_states",
"united_kingdom",
"canada",
"mexico",
"brazil",
"turkey",
"spain",
"germany",
"france",
"japan"
],
"type": "string",
"description": "Used only when the job is Trends. Paste can be empty.",
"default": "worldwide"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}