{ "openapi": "3.0.1", "info": { "title": "Twitter (X.com) Tweets & Profiles Scraper", "description": "Extract tweets and full profile data from any Twitter (X.com) account with our powerful scraper. Search profiles, scrape tweets with replies, or extract data via URL or username. Download in JSON, CSV, Excel, XML, or HTML—ideal for social media monitoring, content analysis, and competitive research.", "version": "0.1", "x-build-id": "FvNvcH0ieW6LW5BcC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/web.harvester~twitter-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-web.harvester-twitter-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/web.harvester~twitter-scraper/runs": { "post": { "operationId": "runs-sync-web.harvester-twitter-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/web.harvester~twitter-scraper/run-sync": { "post": { "operationId": "run-sync-web.harvester-twitter-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", "properties": { "startUrls": { "title": "Profiles or Tweets URLs.", "type": "array", "description": "", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "handles": { "title": "Twitter usernames, e.g. elonmusk or @elonmusk.", "type": "array", "description": "", "items": { "type": "string" } }, "userQueries": { "title": "Users search queries, e.g. elon musk.", "type": "array", "description": "A list of search queries for Twitter users. The scraper will scrape the tweets of the users returned by the search query.", "items": { "type": "string" } }, "tweetsDesired": { "title": "Maximum number of tweets (per profile or url). Limited to ~800 per profile without replies and ~3200 with replies.", "type": "integer", "description": "By setting this to 0, it will scrape only the profile info (for profiles only)", "default": 100 }, "repliesDepth": { "title": "Replies depth (Read the description!)", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many levels of replies should be scraped. 0 means no replies, 1 means the tweet and its replies, 2 means the tweet, its replies and the replies of the replies, etc." }, "profilesDesired": { "title": "Maximum number of profiles per (only for Users search queries)", "type": "integer", "description": "This value lets you set the maximum number of profiles to retrieve per search query (for \"Users search queries\")", "default": 10 }, "withReplies": { "title": "Tweets & Replies (for profiles only)", "type": "boolean", "description": "Scrape tweets and replies to tweets (enabling this increases the number of tweets per profile to ~3200), e.g. https://x.com/elonmusk/with_replies", "default": true }, "includeUserInfo": { "title": "Include the profile user info in every tweet result (Now will get userId!)", "type": "boolean", "description": "This will add the profile user info to every tweet result. This is useful if you want to scrape tweets from multiple profiles and want to know which profile each tweet belongs to.", "default": true }, "storeUserIfNoTweets": { "title": "Store user data if no tweets are found, the option will override includeUserInfo (For profiles only)", "type": "boolean", "description": "If no tweets are found, store the user data anyway", "default": false }, "since": { "title": "Tweets newer than (since)", "type": "string", "description": "This lets you specify the oldest date of tweets to extract, format YYYY-MM-DD. You can also use relative dates such as '1 month' or '2 days' instead of absolute dates such as '2020-02-29'." }, "proxyConfig": { "title": "Proxy configuration (RESIDENTIAL recommended)", "type": "object", "description": "", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }