X (Twitter) Scraper
Pricing
from $0.23 / 1,000 timeline/list posts
X (Twitter) Scraper
Collect public X (Twitter) profiles and content with structured exports, grouped input and bounded API usage. Provider access included.
X (Twitter) Scraper
Pricing
from $0.23 / 1,000 timeline/list posts
Collect public X (Twitter) profiles and content with structured exports, grouped input and bounded API usage. Provider access included.
You can access the X (Twitter) Scraper programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "0.1", "x-build-id": "CGOm4d6neh97n5fdm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mscraper~x-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mscraper-x-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/mscraper~x-scraper/runs": { "post": { "operationId": "runs-sync-mscraper-x-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/mscraper~x-scraper/run-sync": { "post": { "operationId": "run-sync-mscraper-x-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": [ "mode" ], "properties": { "mode": { "title": "What to collect", "enum": [ "profiles", "profilesById", "posts", "media", "likes", "followers", "following", "postsByUrl", "postDetails", "likers", "reposters", "listPosts", "followerIds", "followingIds", "trends" ], "type": "string", "description": "Choose which public data to collect. Fill only the source field used by the selected mode.", "default": "profiles" }, "profiles": { "title": "Usernames or profile URLs", "type": "array", "description": "Used by: Profiles, Profile posts, Profile media posts, Liked posts, Followers, Following. Up to 100 sources. Leave empty in other modes.", "items": { "type": "string" }, "default": [] }, "userIds": { "title": "User IDs", "type": "array", "description": "Used by: Profiles by ID, Follower IDs, Following IDs. Up to 100 sources. Leave empty in other modes.", "items": { "type": "string" }, "default": [] }, "postUrls": { "title": "Post URLs or IDs", "type": "array", "description": "Used by: Posts by URL or ID, Post detail, Post likers, Post reposters. Up to 100 sources. Leave empty in other modes.", "items": { "type": "string" }, "default": [] }, "listIds": { "title": "List IDs", "type": "array", "description": "Used by: List posts. Up to 100 sources. Leave empty in other modes.", "items": { "type": "string" }, "default": [] }, "locations": { "title": "Trend location IDs (WOEID)", "type": "array", "description": "Used by: Trends. Up to 100 sources. Leave empty in other modes.", "items": { "type": "string" }, "default": [] }, "maxItems": { "title": "Maximum total results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Global cap across all sources. Provider page sizes may be larger; only saved results are billed.", "default": 20 }, "maxItemsPerSource": { "title": "Maximum results per source", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum saved records from each source. The global result limit still applies.", "default": 100 }, "maxRequests": { "title": "Maximum API requests", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Includes username lookups and retries. Successful empty checks are billed separately; malformed responses and provider errors are not empty checks.", "default": 10 }, "requestsPerMinute": { "title": "Maximum requests per minute", "minimum": 1, "maximum": 60, "type": "integer", "description": "The shared provider limiter may enforce a lower rate.", "default": 30 }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 3, "type": "integer", "description": "Retries consume API quota and the request budget. Off by default.", "default": 0 }, "includeRaw": { "title": "Include original record", "type": "boolean", "description": "Adds the original per-record payload. It can be large and contain additional public profile fields.", "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for X (Twitter) Scraper from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: