{ "openapi": "3.0.1", "info": { "title": "X User Search Scraper | $0.15/1K | Pay-Per-Result", "description": "Search X (Twitter) users by handle, bio, and location for $0.15 per 1,000 profiles on every Apify plan. Use follower, verification, age, and location filters. Filters and deduplication run before billing. Apify bills platform usage separately. No X login. Built by Xquik. Not affiliated with X Corp.", "version": "1.0", "x-build-id": "ntVyoRaUiToJvgrvH" }, "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" } }, "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 }, "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 }, "bioContains": { "title": "Bio Contains", "type": "string", "description": "Case-insensitive text required in the profile bio." }, "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 REST cursor. Pass it unchanged." }, "maxItems": { "title": "Maximum Delivered Profiles", "minimum": 1, "type": "integer", "description": "Global delivered-profile cap across all queries.", "default": 10000 }, "maxItemsPerTarget": { "title": "Profiles per Query", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Optional delivered-profile cap for each query." }, "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": "Parallel independent searches. Leave the default for maximum safe throughput.", "default": 100 } } }, "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 } } } } } } } } } }