{ "openapi": "3.0.1", "info": { "title": "X Twitter Lead Scraper", "description": "Extract high-quality leads from X (Twitter) using the X Twitter Lead Scraper. Collect profile names, bios, emails, websites, follower counts, and social links automatically. Ideal for lead generation, influencer discovery, outreach campaigns, and audience research.", "version": "0.4", "x-build-id": "uK7HVX1djmZpItV0i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~x-twitter-lead-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-x-twitter-lead-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/scraper-engine~x-twitter-lead-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-x-twitter-lead-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/scraper-engine~x-twitter-lead-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-x-twitter-lead-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": [ "keywords" ], "properties": { "keywords": { "title": "๐Ÿ” Keywords", "type": "array", "description": "๐ŸŽฏ The words that power your lead search! Add one or more keywords (e.g. ['founder', 'developer', 'designer', 'marketing']) and the actor finds public X/Twitter profiles matching them, then ๐Ÿ“ง extracts any email addresses it finds. ๐Ÿ’ก Tip: niche keywords tend to outperform broad generic terms.", "items": { "type": "string" } }, "platform": { "title": "๐ŸŒ Platform", "enum": [ "Twitter" ], "type": "string", "description": "๐Ÿ“ฑ The social network to mine for leads. Currently locked to Twitter (also matches x.com) โ€” more platforms coming soon! ๐Ÿš€", "default": "Twitter" }, "location": { "title": "๐Ÿ“ Location Filter", "type": "string", "description": "๐Ÿ—บ๏ธ Optional geo-targeting! Add a city or region (e.g. 'London' ๐Ÿ‡ฌ๐Ÿ‡ง, 'New York' ๐Ÿ—ฝ, 'Dubai' ๐Ÿ™๏ธ) to narrow leads down to profiles/posts mentioning that place. โœจ Leave empty to search the whole globe ๐ŸŒ.", "default": "" }, "emailDomains": { "title": "๐Ÿ“ง Email Domains Filter", "type": "array", "description": "๐ŸŽ›๏ธ Keep only leads whose email is on the domains you care about โ€” type as many as you like! โœ๏ธ Popular picks: ๐Ÿ“ฎ @gmail.com ยท ๐Ÿ“จ @outlook.com ยท ๐Ÿ’Œ @hotmail.com ยท ๐Ÿ’œ @yahoo.com ยท โ˜๏ธ @icloud.com ยท ๐Ÿ“ฌ @aol.com ยท ๐Ÿ”’ @protonmail.com ยท ๐Ÿ“ฅ @live.com ยท ๐Ÿ“ง @gmx.com ยท ๐ŸŸก @yandex.com ยท ๐Ÿ“— @zoho.com. ๐Ÿข Custom/business domains work too โ€” e.g. @yourcompany.com. ๐Ÿ•ณ๏ธ Leave empty to collect leads from ALL domains. ๐Ÿ’ก Adding a domain also sharpens the search ๐ŸŽฏ.", "items": { "type": "string" } }, "maxEmails": { "title": "๐Ÿ“Š Maximum Leads per Keyword", "minimum": 1, "maximum": 5000, "type": "integer", "description": "๐ŸŽš๏ธ How many leads (emails) to collect per keyword before moving on. โšก Higher = more leads but longer runs. Default is 20 โœ… (range 1 โ€“ 5,000).", "default": 20 }, "engine": { "title": "โš™๏ธ Engine", "enum": [ "legacy" ], "type": "string", "description": "๐Ÿ”ง The processing engine. Currently 'legacy' ๐Ÿ›ก๏ธ โ€” a reliable, battle-tested extraction pipeline. More engines on the roadmap! ๐Ÿšง", "default": "legacy" }, "searchEngines": { "title": "๐Ÿ”Ž Discovery Sources", "uniqueItems": true, "type": "array", "description": "๐Ÿงญ Which search engines are used to DISCOVER public X/Twitter profiles for your keywords. ๐Ÿฅ‡ `google` is by far the strongest (it indexes X profile bios and paginates deeply), ๐Ÿฆ† `duckduckgo` and ๐Ÿฆ `brave` add extra breadth, ๐Ÿ…ฑ๏ธ `bing` currently indexes very little X content. โœ… Leave empty to use all of them in that order.", "items": { "type": "string", "enum": [ "google", "duckduckgo", "brave", "bing" ], "enumTitles": [ "๐Ÿฅ‡ Google", "๐Ÿฆ† DuckDuckGo", "๐Ÿฆ Brave", "๐Ÿ…ฑ๏ธ Bing" ] } }, "enrichFromLinkedSite": { "title": "๐Ÿ”— Also Check the Website Linked in the Bio", "type": "boolean", "description": "๐ŸŒ When a profile bio has no email but links out to a website (an `t.co` link), follow that link and look for a contact address on the destination site. ๐Ÿ“ˆ Meaningfully raises the number of leads per keyword, at the cost of a few extra requests per profile. โ›” Turn off for the fastest possible runs.", "default": true }, "maxProfilesPerKeyword": { "title": "๐Ÿ‘ฅ Profile Check Budget per Keyword", "minimum": 5, "maximum": 2000, "type": "integer", "description": "โ›ฝ Safety valve: the maximum number of distinct public profiles to open and read per keyword while hunting for the requested number of leads. โฌ†๏ธ Raise it for rare niches where few profiles publish an email, โฌ‡๏ธ lower it to cap run time. Default 120.", "default": 120 }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy Configuration", "type": "object", "description": "๐ŸŒ Controls how the actor loads x.com profile pages and any external site a bio links to. ๐Ÿ  Leave it as-is and the actor uses the RESIDENTIAL group, which is verified to return real logged-out X profile data. ๐Ÿ”„ On any failed or blocked response it rotates to a fresh exit IP and retries. โ„น๏ธ Google search always goes through the dedicated GOOGLE_SERP group regardless of this setting โ€” that group can *only* reach Google, so it is never used for page fetching." } } }, "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 } } } } } } } } } }