{ "openapi": "3.0.1", "info": { "title": "X (Twitter) User Search | $0.00015/Profile | Pay-Per-Result", "description": "Twitter user search. Find X users by name, handle, bio & location. Get the emails, phones & links each profile publishes, from $0.00015 per delivered profile. Filter by followers, age & email. No X login. World's fastest & cheapest X (Twitter) scraper service. Not affiliated with X Corp.", "version": "1.0", "x-build-id": "ChBTx3mQjp7i2g6NZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xquik~x-user-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xquik-x-user-search-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/xquik~x-user-search-scraper/runs": { "post": { "operationId": "runs-sync-xquik-x-user-search-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/xquik~x-user-search-scraper/run-sync": { "post": { "operationId": "run-sync-xquik-x-user-search-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": { "searchTerms": { "title": "Search Terms", "type": "array", "description": "Names, usernames, companies, topics, professions, or locations.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "search", "autocomplete" ], "type": "string", "description": "Profile Search returns full profiles. Search Autocomplete returns the accounts, topics, hashtags & cashtags X suggests for each search term.", "default": "search" }, "suggestionTypes": { "title": "Suggestion Types", "type": "array", "description": "Search Autocomplete only. Choose which suggestions to return. All 4 run by default. Start a search term with # for hashtags or $ for cashtags.", "items": { "type": "string", "enum": [ "users", "topics", "hashtags", "cashtags" ], "enumTitles": [ "Accounts", "Topics", "Hashtags", "Cashtags" ] }, "default": [ "users", "topics", "hashtags", "cashtags" ] }, "maxItems": { "title": "Maximum Delivered Profiles", "minimum": 1, "type": "integer", "description": "Global delivered-profile cap across all queries. The form starts at 1,000. A run can return 100,000 rows & more, so raise it for a full export.", "default": 100000 }, "maxItemsPerTarget": { "title": "Profiles per Query", "minimum": 1, "type": "integer", "description": "Optional delivered-profile cap for each query." }, "minFollowers": { "title": "Minimum Followers", "minimum": 0, "type": "integer", "description": "Keep profiles with at least this many followers." }, "maxFollowers": { "title": "Maximum Followers", "minimum": 0, "type": "integer", "description": "Keep profiles with no more than this many followers." }, "minFollowing": { "title": "Minimum Following", "minimum": 0, "type": "integer", "description": "Keep profiles following at least this many accounts." }, "maxFollowing": { "title": "Maximum Following", "minimum": 0, "type": "integer", "description": "Keep profiles following no more than this many accounts." }, "minStatuses": { "title": "Minimum Posts", "minimum": 0, "type": "integer", "description": "Keep profiles with at least this many posts." }, "maxStatuses": { "title": "Maximum Posts", "minimum": 0, "type": "integer", "description": "Keep profiles with no more than this many posts." }, "minAccountAgeDays": { "title": "Minimum Account Age in Days", "minimum": 0, "type": "integer", "description": "Keep accounts at least this old." }, "verifiedOnly": { "title": "Verified Only", "type": "boolean", "description": "Keep only profiles with an X verification badge.", "default": false }, "blueVerifiedOnly": { "title": "Blue Verified Only", "type": "boolean", "description": "Keep only profiles X marks as blue verified. X marks many business & government accounts blue too.", "default": false }, "verifiedType": { "title": "Verification Type", "enum": [ "any", "blue", "legacy", "business", "government" ], "type": "string", "description": "Keep profiles with the selected verification type." }, "hasWebsite": { "title": "Has Website", "type": "boolean", "description": "Keep profiles that publish a website.", "default": false }, "hasLocation": { "title": "Has Location", "type": "boolean", "description": "Keep profiles that publish a location.", "default": false }, "hasEmail": { "title": "Has Email", "type": "boolean", "description": "Only include users whose profile publishes an email.", "default": false }, "businessEmailOnly": { "title": "Business Email Only", "type": "boolean", "description": "Only include users who publish an email outside free webmail, such as Gmail.", "default": false }, "emailDomains": { "title": "Email Domains", "type": "string", "description": "Only include users with an email at one of these domains. Separate domains with commas. Subdomains match. For example, acme.com, stanford.edu." }, "bioContains": { "title": "Bio Contains", "type": "string", "description": "Keep profiles whose bio contains any of these words, ignoring case. Separate words with commas." }, "locationContains": { "title": "Location Contains", "type": "string", "description": "Case-insensitive text required in the profile location." }, "usernameContains": { "title": "Username Contains", "type": "string", "description": "Case-insensitive text required in the username." }, "startCursor": { "title": "Saved Cursor", "type": "string", "description": "Continue one matching query from a saved cursor. Pass it unchanged." }, "dedupeAcrossTargets": { "title": "Deduplicate Across Queries", "type": "boolean", "description": "Return each matching profile once across all queries.", "default": true }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 128, "type": "integer", "description": "How many searches to run at once. The default is the fastest safe setting.", "default": 100 }, "fields": { "title": "Fields to keep", "type": "array", "description": "Keep only these fields in each row. Pick names or type your own. Use a dot for a field inside an object, such as contactInfo.emails. Columns arrive in the order & spelling you write. Every row keeps its id. Leave empty for every field. The price per row stays the same. A wrong name stops the run before it reads, at no charge. If names cannot be checked, the run reads on & lists unseen names last.", "items": { "type": "string", "enumSuggestedValues": [ "username", "name", "description", "url", "id", "email", "contactInfo", "followers", "following", "verified", "verifiedType", "location", "createdAt", "profilePicture", "profilePictureOriginal", "coverPicture", "statusesCount", "mediaCount", "author", "grokTranslatedBio", "professional", "withheldScope", "text", "media", "suggestionType", "suggestion", "isBlueVerified", "isVerified", "protected", "badges", "isPersonaMediaGenable", "score", "tokens", "inline", "ticker", "smartTag", "currency", "price", "marketCap", "dailyChangePercent", "logoUrl", "exchangeShortName", "contractAddress", "chainLogoUrl", "actor", "actorVersion", "timestamp", "resultType", "sourceTarget", "status", "message" ] } }, "omitFields": { "title": "Fields to drop", "type": "array", "description": "Drop these fields & keep the rest. Every row keeps its id.", "items": { "type": "string", "enumSuggestedValues": [ "username", "name", "description", "url", "id", "email", "contactInfo", "followers", "following", "verified", "verifiedType", "location", "createdAt", "profilePicture", "profilePictureOriginal", "coverPicture", "statusesCount", "mediaCount", "author", "grokTranslatedBio", "professional", "withheldScope", "text", "media", "suggestionType", "suggestion", "isBlueVerified", "isVerified", "protected", "badges", "isPersonaMediaGenable", "score", "tokens", "inline", "ticker", "smartTag", "currency", "price", "marketCap", "dailyChangePercent", "logoUrl", "exchangeShortName", "contractAddress", "chainLogoUrl", "actor", "actorVersion", "timestamp", "resultType", "sourceTarget", "status", "message" ] } }, "renameFields": { "title": "Rename fields", "type": "array", "description": "Give a field a new column name. The key is the field. The value is the new name. A renamed field becomes a top-level column.", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "flatten": { "title": "Flat columns", "type": "boolean", "description": "Turn each nested object into top-level columns, such as contactInfoEmails. Lists stay lists. Use it for CSV & spreadsheets.", "default": false }, "fillMissingFields": { "title": "Fill missing fields with null", "type": "boolean", "description": "With Fields to keep, a field a row lacks arrives as null. Every row then has the same columns. Turn it off to leave such fields out.", "default": true }, "joinFields": { "title": "Lists to join", "type": "array", "description": "Turn each of these lists into 1 text value. Use it for CSV cells.", "items": { "type": "string", "enumSuggestedValues": [ "username", "name", "description", "url", "id", "email", "contactInfo", "followers", "following", "verified", "verifiedType", "location", "createdAt", "profilePicture", "profilePictureOriginal", "coverPicture", "statusesCount", "mediaCount", "author", "grokTranslatedBio", "professional", "withheldScope", "text", "media", "suggestionType", "suggestion", "isBlueVerified", "isVerified", "protected", "badges", "isPersonaMediaGenable", "score", "tokens", "inline", "ticker", "smartTag", "currency", "price", "marketCap", "dailyChangePercent", "logoUrl", "exchangeShortName", "contractAddress", "chainLogoUrl", "actor", "actorVersion", "timestamp", "resultType", "sourceTarget", "status", "message" ] } }, "joinSeparator": { "title": "Join separator", "type": "string", "description": "Text between the items of a joined list.", "default": ", " }, "constantFields": { "title": "Constant columns", "type": "array", "description": "Add a column with the same text on every row. The key is the column name, such as campaign. The value is its text.", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "alwaysSaveRunRecords": { "title": "Always save run records", "type": "boolean", "description": "Save run-report on every run. When off, small runs that go well skip it & cost less.", "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 } } } } } } } } } }