{
"openapi": "3.0.1",
"info": {
"title": "Twitter (X) Data API: Tweets, Profiles, Followers, Search",
"description": "Get tweets, search results, profiles, followers, following, replies, retweeters, list and community tweets, and trends from X (Twitter) as clean JSON. No login, no browser, no X account needed.",
"version": "0.1",
"x-build-id": "0ePN2W3CroberA1Ab"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/kiddodev~twitter-x-data-twittrapi/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-kiddodev-twitter-x-data-twittrapi",
"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/kiddodev~twitter-x-data-twittrapi/runs": {
"post": {
"operationId": "runs-sync-kiddodev-twitter-x-data-twittrapi",
"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/kiddodev~twitter-x-data-twittrapi/run-sync": {
"post": {
"operationId": "run-sync-kiddodev-twitter-x-data-twittrapi",
"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": [
"mode"
],
"properties": {
"mode": {
"title": "Mode",
"enum": [
"searchTweets",
"userTweets",
"userProfiles",
"followers",
"following",
"tweetReplies",
"tweetRetweeters",
"listTweets",
"communityTweets",
"trends"
],
"type": "string",
"description": "What to collect. Each mode reads one of the fields below:
Search tweets: Search queries.
User tweets, User profiles, Followers, Following: Usernames or User IDs.
Tweet replies, Tweet retweeters: Tweet IDs or URLs.
List tweets: List IDs. Community tweets: Community IDs. Trends: Locations (WOEIDs).",
"default": "searchTweets"
},
"searchQueries": {
"title": "Search queries",
"type": "array",
"description": "For mode Search tweets. One query per line. X search operators work, for example from:nasa, \"exact phrase\", lang:en, since:2025-01-01, min_faves:100, -filter:replies. Max 512 characters per query.",
"items": {
"type": "string"
}
},
"searchCategory": {
"title": "Search tab",
"enum": [
"Latest",
"Top",
"People",
"Photos",
"Videos"
],
"type": "string",
"description": "Which X search tab to read. Latest is newest first. People returns accounts instead of tweets.",
"default": "Latest"
},
"usernames": {
"title": "Usernames",
"type": "array",
"description": "For modes User tweets, User profiles, Followers and Following. One per line: nasa, @nasa or https://x.com/nasa.",
"items": {
"type": "string"
}
},
"userIds": {
"title": "User IDs",
"type": "array",
"description": "Numeric X user IDs (rest_id), one per line. Slightly faster than usernames. User profiles are fetched 100 IDs per request.",
"items": {
"type": "string"
}
},
"tweetIds": {
"title": "Tweet IDs or URLs",
"type": "array",
"description": "For modes Tweet replies and Tweet retweeters. One per line: the numeric ID or the tweet URL, e.g. https://x.com/nasa/status/1844000000000000001.",
"items": {
"type": "string"
}
},
"listIds": {
"title": "List IDs or URLs",
"type": "array",
"description": "For mode List tweets. Numeric list ID or URL, e.g. https://x.com/i/lists/1234567890.",
"items": {
"type": "string"
}
},
"communityIds": {
"title": "Community IDs or URLs",
"type": "array",
"description": "For mode Community tweets. Numeric community ID or URL, e.g. https://x.com/i/communities/1234567890.",
"items": {
"type": "string"
}
},
"woeids": {
"title": "Trend locations (WOEID)",
"type": "array",
"description": "For mode Trends. Yahoo WOEIDs: 1 = worldwide, 23424977 = United States, 23424975 = United Kingdom, 23424829 = Germany. Defaults to worldwide.",
"items": {
"type": "string"
}
},
"maxItems": {
"title": "Max items per input",
"minimum": 1,
"maximum": 100000,
"type": "integer",
"description": "Stop after this many results for each query, user, tweet, list, community or location. You pay per result, so this also caps the cost per input.",
"default": 100
},
"maxPages": {
"title": "Max pages per input",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Safety limit on requests per input. A page usually holds about 20 results. Raise it together with Max items for large pulls.",
"default": 20
},
"includeRaw": {
"title": "Include raw X data",
"type": "boolean",
"description": "Adds a raw field with X's original JSON for each item. Useful for fields this Actor does not flatten. Makes items much larger.",
"default": 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
},
"PROXY_UNBLOCKER_UNITS": {
"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
},
"PROXY_UNBLOCKER_UNITS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}