{ "openapi": "3.0.1", "info": { "title": "X / Twitter Scraper", "description": "Scrape X (Twitter) search results, profiles, posts, and lists into clean structured JSON. Supports bulk URLs, pagination, normalized output, and easy exports through Apify for monitoring, research, lead generation, and automation.", "version": "1.0", "x-build-id": "DXvWcb7J7sSVKLIfY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alwaysprimedev~twitter-scraper-json/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alwaysprimedev-twitter-scraper-json", "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/alwaysprimedev~twitter-scraper-json/runs": { "post": { "operationId": "runs-sync-alwaysprimedev-twitter-scraper-json", "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/alwaysprimedev~twitter-scraper-json/run-sync": { "post": { "operationId": "run-sync-alwaysprimedev-twitter-scraper-json", "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": { "whatToScrape": { "title": "What do you want to scrape?", "enum": [ "search", "profile", "tweet", "list" ], "type": "string", "description": "Choose the kind of X page you want to collect data from.", "default": "search" }, "searchQuery": { "title": "Search queries or search URLs", "type": "string", "description": "Used when you scrape search results. You can paste one query or many queries/search URLs, one per line." }, "searchSort": { "title": "Search sort", "enum": [ "Latest", "Top" ], "type": "string", "description": "Choose how search results should be ordered.", "default": "Latest" }, "profile": { "title": "Profiles", "type": "string", "description": "Used when you scrape profiles. Paste one or many @handles or full profile URLs, one per line." }, "profileContent": { "title": "Profile content", "enum": [ "tweets", "replies", "media" ], "type": "string", "description": "Choose which profile tab to collect.", "default": "tweets" }, "postUrlOrId": { "title": "Posts", "type": "string", "description": "Used when you scrape specific posts. Paste one or many full post URLs or post IDs, one per line." }, "listUrlOrId": { "title": "Lists", "type": "string", "description": "Used when you scrape lists. Paste one or many full list URLs or list IDs, one per line." }, "maxItems": { "title": "How many posts per target do you want?", "minimum": 1, "type": "integer", "description": "Maximum number of posts to collect for each pasted search/profile/list target. Ignored in single-post mode.", "default": 20 }, "demoMode": { "title": "Demo mode", "type": "boolean", "description": "Legacy compatibility field retained for older tasks and inputs." }, "mode": { "title": "Legacy mode", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "query": { "title": "Legacy query", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "product": { "title": "Legacy product", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "screenName": { "title": "Legacy screen name", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "profileTab": { "title": "Legacy profile tab", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "tweetId": { "title": "Legacy tweet id", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "listId": { "title": "Legacy list id", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "count": { "title": "Legacy count", "type": "integer", "description": "Legacy compatibility field retained for older tasks and inputs." }, "cursor": { "title": "Cursor", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "timeoutSeconds": { "title": "Timeout", "type": "integer", "description": "Legacy compatibility field retained for older tasks and inputs." }, "bearerToken": { "title": "Legacy bearer token", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "authToken": { "title": "Legacy auth token", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." }, "ct0": { "title": "Legacy ct0", "type": "string", "description": "Legacy compatibility field retained for older tasks and inputs." } } }, "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 } } } } } } } } } }