{ "openapi": "3.0.1", "info": { "title": "X (Twitter) Communities Scraper | $0.00015/Row | Pay-Per-Result", "description": "Scrape X Communities & Twitter Communities for info, posts, media, members & moderators. Find Communities by keyword or topic. It costs from $0.00015 per delivered row on every Apify plan. No X login. World's fastest & cheapest X (Twitter) scraper service. Not affiliated with X Corp.", "version": "1.0", "x-build-id": "ssND5CUII2YbvNb2M" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/xquik~x-community-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-xquik-x-community-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-community-scraper/runs": { "post": { "operationId": "runs-sync-xquik-x-community-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-community-scraper/run-sync": { "post": { "operationId": "run-sync-xquik-x-community-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": { "startUrls": { "title": "Community URLs", "type": "array", "description": "Public x.com Community URLs. Use strings or {\"url\":\"...\"} objects. For example, [\"https://x.com/i/communities/1493446837214187523\", {\"url\":\"https://x.com/i/communities/1493446837214187523\"}]." }, "communityIds": { "title": "Community IDs", "type": "array", "description": "Numeric Community IDs.", "items": { "type": "string" } }, "searchTerms": { "title": "Find Communities by Keyword", "type": "array", "description": "Keywords to find Communities by, such as ai. Each found Community is 1 row.", "items": { "type": "string" } }, "topics": { "title": "Popular Communities of Topics", "type": "array", "description": "Topic names or IDs, such as Technology or 301. Returns the most popular Communities of each.", "items": { "type": "string" } }, "includeSuggested": { "title": "Suggested Communities", "type": "boolean", "description": "Add the Communities X suggests to join. X picks them per run.", "default": false }, "listTopics": { "title": "List Community Topics", "type": "boolean", "description": "Add every Community topic with its subtopics, 1 row per topic.", "default": false }, "includeDetails": { "title": "Full Community Records", "type": "boolean", "description": "Add rules, creator, admin & member profiles to each Community found by keyword or topic. Turn off for a faster run.", "default": true }, "resources": { "title": "Resources", "type": "array", "description": "Choose any Community resources. Info and Posts run by default.", "items": { "type": "string", "enum": [ "info", "tweets", "media", "search", "members", "moderators" ], "enumTitles": [ "Community Info", "Posts", "Media", "Keyword Search", "Members", "Moderators" ] }, "default": [ "info", "tweets" ] }, "maxItems": { "title": "Maximum Delivered Rows", "minimum": 1, "type": "integer", "description": "Global result cap across every Community and selected resource. 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": "Rows per Resource", "minimum": 1, "type": "integer", "description": "Optional cap for each Community resource." }, "query": { "title": "Keyword Search", "type": "string", "description": "Required only when Resources includes Keyword Search." }, "memberNames": { "title": "Find Members by Name", "type": "array", "description": "Names or usernames to find among each Community's members, such as marckohlbrugge. X checks up to 10 matching accounts per name. Each member found is 1 row.", "items": { "type": "string" } }, "queryType": { "title": "Search Order", "enum": [ "Latest", "Top" ], "type": "string", "description": "Order keyword-search posts by recency or relevance.", "default": "Latest" }, "postsOrder": { "title": "Posts Order", "enum": [ "Latest", "Top" ], "type": "string", "description": "Newest Posts first, or the Top Posts X ranks highest.", "default": "Latest" }, "sinceDate": { "title": "Posts Since", "type": "string", "description": "Keep posts on or after this date." }, "untilDate": { "title": "Posts Until", "type": "string", "description": "Keep posts on or before this date." }, "language": { "title": "Post Language", "type": "string", "description": "Keep posts with this language code." }, "mediaType": { "title": "Post Media Type", "enum": [ "images", "videos", "gifs", "media", "links", "none" ], "type": "string", "description": "Keep posts with the selected media type." }, "minViews": { "title": "Minimum Post Views", "minimum": 0, "type": "integer", "description": "Keep posts with at least this many views." }, "minLikes": { "title": "Minimum Post Likes", "minimum": 0, "type": "integer", "description": "Keep posts with at least this many likes." }, "minReplies": { "title": "Minimum Post Replies", "minimum": 0, "type": "integer", "description": "Keep posts with at least this many replies." }, "minRetweets": { "title": "Minimum Post Reposts", "minimum": 0, "type": "integer", "description": "Keep posts with at least this many reposts." }, "nativeRetweets": { "title": "Native Reposts Only", "type": "boolean", "description": "Keep only native reposts in Community post resources.", "default": false }, "verifiedOnly": { "title": "Verified Authors or Profiles Only", "type": "boolean", "description": "Keep posts or member profiles with verification.", "default": false }, "blueVerifiedOnly": { "title": "Blue Verified Authors or Profiles Only", "type": "boolean", "description": "Keep posts, or members or moderators, with X's blue mark. X marks many business & government accounts blue too.", "default": false }, "verifiedType": { "title": "Profile Verification Type", "type": "string", "description": "Keep members or moderators with this verification type, such as business." }, "minFollowers": { "title": "Minimum Profile Followers", "minimum": 0, "type": "integer", "description": "Keep members or moderators above this audience size." }, "maxFollowers": { "title": "Maximum Profile Followers", "minimum": 0, "type": "integer", "description": "Keep members or moderators below this audience size." }, "minFollowing": { "title": "Minimum Profile Following", "minimum": 0, "type": "integer", "description": "Keep members or moderators who follow at least this many accounts." }, "maxFollowing": { "title": "Maximum Profile Following", "minimum": 0, "type": "integer", "description": "Keep members or moderators who follow at most this many accounts." }, "minStatuses": { "title": "Minimum Profile Posts", "minimum": 0, "type": "integer", "description": "Keep members or moderators with at least this many posts." }, "maxStatuses": { "title": "Maximum Profile Posts", "minimum": 0, "type": "integer", "description": "Keep members or moderators with at most this many posts." }, "minAccountAgeDays": { "title": "Minimum Account Age in Days", "minimum": 0, "type": "integer", "description": "Keep members or moderators at least this old." }, "hasWebsite": { "title": "Has Website", "type": "boolean", "description": "Keep members or moderators that list a website.", "default": false }, "hasLocation": { "title": "Has Location", "type": "boolean", "description": "Keep members or moderators that list 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 members or moderators with any of these words in their bio. Separate words with commas." }, "locationContains": { "title": "Location Contains", "type": "string", "description": "Keep members or moderators whose location contains this text." }, "usernameContains": { "title": "Username Contains", "type": "string", "description": "Keep members or moderators whose username contains this text." }, "dedupeAcrossTargets": { "title": "Deduplicate Across Communities", "type": "boolean", "description": "Remove repeated canonical rows before billing.", "default": true }, "maxConcurrency": { "title": "Maximum Concurrency", "minimum": 1, "maximum": 128, "type": "integer", "description": "How many Community resources to process 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": [ "name", "description", "url", "id", "member_count", "moderator_count", "communityRole", "rules", "banner_url", "question", "searchTags", "creator", "admin", "membersFacepile", "primary_topic", "is_nsfw", "banner", "subtopics", "username", "text", "author", "createdAt", "likeCount", "replyCount", "retweetCount", "viewCount", "followers", "verified", "email", "contactInfo", "media", "grokTranslatedBio", "professional", "actor", "actorVersion", "timestamp", "resultType", "sourceTarget", "status", "message", "totalEngagement", "engagementRate", "engagementPerView" ] } }, "omitFields": { "title": "Fields to drop", "type": "array", "description": "Drop these fields & keep the rest. Every row keeps its id.", "items": { "type": "string", "enumSuggestedValues": [ "name", "description", "url", "id", "member_count", "moderator_count", "communityRole", "rules", "banner_url", "question", "searchTags", "creator", "admin", "membersFacepile", "primary_topic", "is_nsfw", "banner", "subtopics", "username", "text", "author", "createdAt", "likeCount", "replyCount", "retweetCount", "viewCount", "followers", "verified", "email", "contactInfo", "media", "grokTranslatedBio", "professional", "actor", "actorVersion", "timestamp", "resultType", "sourceTarget", "status", "message", "totalEngagement", "engagementRate", "engagementPerView" ] } }, "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": [ "name", "description", "url", "id", "member_count", "moderator_count", "communityRole", "rules", "banner_url", "question", "searchTags", "creator", "admin", "membersFacepile", "primary_topic", "is_nsfw", "banner", "subtopics", "username", "text", "author", "createdAt", "likeCount", "replyCount", "retweetCount", "viewCount", "followers", "verified", "email", "contactInfo", "media", "grokTranslatedBio", "professional", "actor", "actorVersion", "timestamp", "resultType", "sourceTarget", "status", "message", "totalEngagement", "engagementRate", "engagementPerView" ] } }, "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 } } } } } } } } } }