{
"openapi": "3.0.1",
"info": {
"title": "Discord Server Discovery & Invite Scraper - Members & Links",
"description": "Scrape Discord's public server directory by keyword and category (name, description, member and online counts, badge, invite link), resolve invite links to server data (id, name, counts, boost tier, verification), read server widgets and check username availability. No token, no login.",
"version": "0.1",
"x-build-id": "hH2WCX5Qu41a3Y0pc"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~discord-public-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-discord-public-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/scrapesage~discord-public-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-discord-public-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/scrapesage~discord-public-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-discord-public-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": {
"searchQueries": {
"title": "Server discovery keywords",
"type": "array",
"description": "Keywords to search in Discord's public server directory (discord.com/servers), e.g. music, anime, crypto, study. Each keyword is searched separately, 12 servers per page.",
"items": {
"type": "string"
}
},
"category": {
"title": "Discovery category",
"enum": [
"all",
"gaming",
"music",
"education",
"science-and-tech",
"entertainment"
],
"type": "string",
"description": "Restrict discovery results to one of Discord's directory categories.",
"default": "all"
},
"maxServersPerQuery": {
"title": "Max servers per keyword",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "How many directory results to collect per keyword (12 per page).",
"default": 48
},
"includeServerDetails": {
"title": "Open each server's directory page",
"type": "boolean",
"description": "Fetch every discovered server's own directory page to add the invite link, the long 'About' text, the category and precise member / online counts. One extra request per server.",
"default": false
},
"inviteLinks": {
"title": "Invite links or codes to resolve",
"type": "array",
"description": "Discord invite links or bare codes, e.g. https://discord.gg/python, discord.com/invite/discord-developers or just python. Each is resolved to its server (id, name, description, member and online counts, boost tier, verification level, vanity URL, channel) without joining.",
"items": {
"type": "string"
}
},
"urlsFromFile": {
"title": "Import invite links from a file (one per line)",
"type": "string",
"description": "Bulk-load invite links. Either paste the whole list (one per line), or give a single link to a public .txt/.csv, a Google Sheet or Drive share link, or an Apify key-value-store record. A file that cannot be read says so and charges nothing."
},
"guildIdsForWidget": {
"title": "Server IDs to read the widget of",
"type": "array",
"description": "Numeric server (guild) ids whose public widget you want: online member list (names, status, game), voice channels and presence count. Works only for servers that enabled 'Server Widget'; others are reported as disabled and not charged.",
"items": {
"type": "string"
}
},
"usernamesToCheck": {
"title": "Usernames to check for availability",
"type": "array",
"description": "Discord usernames to test for availability (2-32 chars, letters, digits, underscore, period).",
"items": {
"type": "string"
}
},
"maxResults": {
"title": "Max records",
"minimum": 1,
"type": "integer",
"description": "Cap on the total number of records this run emits across all sections.",
"default": 200
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Discord's public endpoints answer Apify datacenter proxies; the default is enough. Requests are paced to respect Discord's rate limits.",
"default": {
"useApifyProxy": true
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}