{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Account Location | $0.00015/User | Pay-Per-Result", "description": "Check where X (Twitter) accounts are based with no cookies or login, from $0.00015 per delivered account on every Apify plan. Get X's \"Account based in\" label, \"connected via\" & username changes in bulk. World's fastest & cheapest X (Twitter) scraper service. Not affiliated with X Corp.", "version": "1.0", "x-build-id": "Kx3DVKIAw5yKRqWeS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xquik~x-account-location-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xquik-x-account-location-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-account-location-scraper/runs": { "post": { "operationId": "runs-sync-xquik-x-account-location-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-account-location-scraper/run-sync": { "post": { "operationId": "run-sync-xquik-x-account-location-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": { "twitterHandles": { "title": "X Accounts", "type": "array", "description": "Usernames with or without @, x.com or twitter.com profile URLs, or numeric user IDs, in any mix.", "items": { "type": "string" } }, "startUrls": { "title": "Profile URLs", "type": "array", "description": "Public x.com or twitter.com profile URLs. Use strings or {\"url\":\"...\"} objects. For example, [\"https://x.com/nasa\", {\"url\":\"https://x.com/OpenAI\"}]." }, "userIds": { "title": "Numeric User IDs", "type": "array", "description": "Numeric X user IDs.", "items": { "type": "string" } }, "userNames": { "title": "User Names", "type": "array", "description": "Another name for X Accounts, for inputs that use it.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum Delivered Accounts", "minimum": 1, "type": "integer", "description": "Global cap on delivered accounts, kept in input order. The form starts at 1,000. A run can return 100,000 rows & more, so raise it for a full export.", "default": 100000 }, "dedupeAcrossTargets": { "title": "Deduplicate Across Accounts", "type": "boolean", "description": "Remove repeated canonical rows before billing.", "default": true }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 128, "type": "integer", "description": "How many accounts to check 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 accountBasedIn.value. 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": [ "accountBasedIn", "accountBasedInUnavailable", "accountBasedInAccurate", "connectedVia", "connectedViaAccurate", "affiliateUsername", "usernameChanges", "birthdate", "accountBasedInCountryCode", "connectedViaPlatform", "connectedViaCountryCode", "accountAgeDays", "profileUrl", "username", "name", "description", "url", "id", "followers", "following", "verified", "location", "createdAt", "profilePicture", "profilePictureOriginal", "coverPicture", "profileBannerUrl", "statusesCount", "mediaCount", "isBlueVerified", "isVerified", "verifiedType", "grokTranslatedBio", "professional", "protected", "favouritesCount", "pinnedTweetIds", "withheldScope", "unavailable", "unavailableReason", "affiliatesHighlightedLabel", "automatedBy", "businessAccountAffiliatesCount", "communityRole", "creatorSubscriptionsCount", "hasCustomTimelines", "hasGraduatedAccess", "hasHiddenSubscriptionsOnProfile", "highlightsInfo", "identityVerification", "isAutomated", "isProfileTranslatable", "isTranslator", "parodyCommentaryFanLabel", "possiblySensitive", "profileDescriptionLanguage", "profileImageShape", "profileInterstitialType", "profileSortEnabled", "profileTranslatorType", "redirectsToUsername", "profile_bio", "superFollowEligible", "superFollowsUserProfileActive", "tipJar", "withheldInCountries", "email", "contactInfo", "listedCount", "fastFollowersCount", "normalFollowersCount", "defaultProfile", "defaultProfileImage", "hasExtendedProfile", "isTranslationEnabled", "geoEnabled", "advertiserAccountType", "advertiserAccountServiceLevels", "businessProfileState", "subscribersCount", "verificationReason", "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": [ "accountBasedIn", "accountBasedInUnavailable", "accountBasedInAccurate", "connectedVia", "connectedViaAccurate", "affiliateUsername", "usernameChanges", "birthdate", "accountBasedInCountryCode", "connectedViaPlatform", "connectedViaCountryCode", "accountAgeDays", "profileUrl", "username", "name", "description", "url", "id", "followers", "following", "verified", "location", "createdAt", "profilePicture", "profilePictureOriginal", "coverPicture", "profileBannerUrl", "statusesCount", "mediaCount", "isBlueVerified", "isVerified", "verifiedType", "grokTranslatedBio", "professional", "protected", "favouritesCount", "pinnedTweetIds", "withheldScope", "unavailable", "unavailableReason", "affiliatesHighlightedLabel", "automatedBy", "businessAccountAffiliatesCount", "communityRole", "creatorSubscriptionsCount", "hasCustomTimelines", "hasGraduatedAccess", "hasHiddenSubscriptionsOnProfile", "highlightsInfo", "identityVerification", "isAutomated", "isProfileTranslatable", "isTranslator", "parodyCommentaryFanLabel", "possiblySensitive", "profileDescriptionLanguage", "profileImageShape", "profileInterstitialType", "profileSortEnabled", "profileTranslatorType", "redirectsToUsername", "profile_bio", "superFollowEligible", "superFollowsUserProfileActive", "tipJar", "withheldInCountries", "email", "contactInfo", "listedCount", "fastFollowersCount", "normalFollowersCount", "defaultProfile", "defaultProfileImage", "hasExtendedProfile", "isTranslationEnabled", "geoEnabled", "advertiserAccountType", "advertiserAccountServiceLevels", "businessProfileState", "subscribersCount", "verificationReason", "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 accountBasedInValue. 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": [ "accountBasedIn", "accountBasedInUnavailable", "accountBasedInAccurate", "connectedVia", "connectedViaAccurate", "affiliateUsername", "usernameChanges", "birthdate", "accountBasedInCountryCode", "connectedViaPlatform", "connectedViaCountryCode", "accountAgeDays", "profileUrl", "username", "name", "description", "url", "id", "followers", "following", "verified", "location", "createdAt", "profilePicture", "profilePictureOriginal", "coverPicture", "profileBannerUrl", "statusesCount", "mediaCount", "isBlueVerified", "isVerified", "verifiedType", "grokTranslatedBio", "professional", "protected", "favouritesCount", "pinnedTweetIds", "withheldScope", "unavailable", "unavailableReason", "affiliatesHighlightedLabel", "automatedBy", "businessAccountAffiliatesCount", "communityRole", "creatorSubscriptionsCount", "hasCustomTimelines", "hasGraduatedAccess", "hasHiddenSubscriptionsOnProfile", "highlightsInfo", "identityVerification", "isAutomated", "isProfileTranslatable", "isTranslator", "parodyCommentaryFanLabel", "possiblySensitive", "profileDescriptionLanguage", "profileImageShape", "profileInterstitialType", "profileSortEnabled", "profileTranslatorType", "redirectsToUsername", "profile_bio", "superFollowEligible", "superFollowsUserProfileActive", "tipJar", "withheldInCountries", "email", "contactInfo", "listedCount", "fastFollowersCount", "normalFollowersCount", "defaultProfile", "defaultProfileImage", "hasExtendedProfile", "isTranslationEnabled", "geoEnabled", "advertiserAccountType", "advertiserAccountServiceLevels", "businessProfileState", "subscribersCount", "verificationReason", "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 } } } } } } } } } }