{ "openapi": "3.0.1", "info": { "title": "UltraFast Discord Username Checker", "description": "High-throughput Discord username availability checker with route-capacity mode, structured Apify dataset output, and optional Discord webhook alerts.", "version": "0.1", "x-build-id": "i01Knotzo8scyBIYk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spy5~ultrafast-discord-username-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spy5-ultrafast-discord-username-checker", "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/spy5~ultrafast-discord-username-checker/runs": { "post": { "operationId": "runs-sync-spy5-ultrafast-discord-username-checker", "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/spy5~ultrafast-discord-username-checker/run-sync": { "post": { "operationId": "run-sync-spy5-ultrafast-discord-username-checker", "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": { "usernames": { "title": "Usernames", "minItems": 1, "type": "array", "description": "Explicit lowercase Discord usernames to check. Duplicate values are ignored.", "items": { "type": "string" } }, "usernamesText": { "title": "Usernames text", "type": "string", "description": "Paste newline-separated or comma-separated Discord usernames here instead of using the JSON usernames array. Lines starting with # are ignored." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Number of concurrent username checks. Default: 5000 for the measured residential route-capacity preset.", "default": 5000 }, "maxRetries": { "title": "Max retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retry attempts for network, Cloudflare, or other non-429 retryable errors. Default: 0 because route-capacity mode retires bad routes and requeues the username.", "default": 0 }, "maxRateLimitRetries": { "title": "Max rate-limit retries", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Consecutive 429 recovery attempts allowed per username outside route-capacity mode. Default: 1; route-capacity mode requeues usernames onto fresh routes instead.", "default": 1 }, "requestTimeoutSeconds": { "title": "Request timeout seconds", "minimum": 3, "maximum": 120, "type": "integer", "description": "Per-request timeout. Default: 5, measured as the fastest clean 5k setting that still exits with a successful Apify run status.", "default": 5 }, "baseBackoffSeconds": { "title": "Base backoff seconds", "minimum": 1, "maximum": 60, "type": "integer", "description": "Initial retry backoff when Discord does not provide retry_after. Default: 1.", "default": 1 }, "maxBackoffSeconds": { "title": "Max backoff seconds", "minimum": 1, "maximum": 300, "type": "integer", "description": "Maximum retry backoff. Default: 30.", "default": 30 }, "useProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Use Apify Proxy. Default: true for the measured 5k residential route-capacity preset.", "default": true }, "proxyGroup": { "title": "Proxy group", "pattern": "^$|^[A-Za-z0-9_-]{1,64}$", "type": "string", "description": "Optional Apify Proxy group. Default: RESIDENTIAL for high-throughput 5k verification.", "default": "RESIDENTIAL" }, "skipProxyValidation": { "title": "Skip proxy validation", "type": "boolean", "description": "Skip the startup Apify Proxy probe and let real Discord requests prove whether each route works. Default: true for speed.", "default": true }, "forcePublicProxyEndpoint": { "title": "Force public proxy endpoint", "type": "boolean", "description": "Use proxy.apify.com:8000 instead of Apify's in-actor proxy endpoint. Default: true for explicit residential session routes.", "default": true }, "proxyCountry": { "title": "Proxy country", "pattern": "^[A-Z]{2}(_[A-Z]{2})?$", "type": "string", "description": "Optional Apify Proxy country code, for example US or US_CA." }, "proxySessionMode": { "title": "Proxy session mode", "enum": [ "rotate", "sticky" ], "type": "string", "description": "Rotate creates a new session for each proxy URL. Sticky keeps one session for the provider lifetime unless max session age is exceeded. Default: rotate.", "default": "rotate" }, "proxyMaxSessionAgeSeconds": { "title": "Proxy max session age seconds", "minimum": 0, "type": "integer", "description": "Maximum sticky session age in seconds before rotation. Default: 0 (no age limit).", "default": 0 }, "maxRequestsPerSecond": { "title": "Max requests per second", "minimum": 0, "maximum": 1000, "type": "number", "description": "Legacy fixed-mode global rate limit in requests per second across all workers. Used only when adaptiveRateLimit is false. 0 disables fixed rate limiting.", "default": 0 }, "adaptiveRateLimit": { "title": "Adaptive rate limit", "type": "boolean", "description": "Use the adaptive single-run scheduler. Default: false for the high-throughput route-capacity preset; enable for conservative low-volume runs.", "default": false }, "initialRequestsPerMinute": { "title": "Initial requests per minute", "minimum": 0.01, "maximum": 60000, "type": "number", "description": "Cold-start request launch rate for adaptive mode. Default: 120.", "default": 120 }, "maxRequestsPerMinute": { "title": "Max requests per minute", "minimum": 0.01, "maximum": 60000, "type": "number", "description": "Maximum adaptive request launch rate after successful ramps. Default: 300.", "default": 300 }, "rampEveryVerified": { "title": "Ramp every verified", "minimum": 1, "type": "integer", "description": "Increase adaptive RPM after this many verified usernames without a global 429 burst. Default: 50.", "default": 50 }, "rampStepRequestsPerMinute": { "title": "Ramp step requests per minute", "minimum": 0.01, "maximum": 60000, "type": "number", "description": "RPM increase applied at each adaptive ramp. Default: 30.", "default": 30 }, "cooldownSafetyMultiplier": { "title": "Cooldown safety multiplier", "minimum": 1, "maximum": 10, "type": "number", "description": "Multiplier applied to Discord retry_after for global adaptive cooldowns. Default: 1.15.", "default": 1.15 }, "stopOnGlobalRateLimit": { "title": "Stop on global rate limit", "type": "boolean", "description": "Stop the run immediately after a non-session Discord shared/global 429 and write unresolved usernames as deferred_rate_limit. Default: true to avoid wasting compute on doomed high-rate batches.", "default": true }, "routeCapacityMode": { "title": "Route capacity mode", "type": "boolean", "description": "Bind request launches to explicit routes and stop using each route before its measured Discord quota is depleted. Default: true.", "default": true }, "includeDirectRoute": { "title": "Include direct route", "type": "boolean", "description": "Use the actor's direct outbound route as one capacity-limited route. Default: false for residential-only 5k runs.", "default": false }, "directRouteCount": { "title": "Direct route count", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Number of isolated direct browser sessions to use as capacity-limited routes. Each route has its own cookie jar and fingerprint cache. Default: 1.", "default": 1 }, "maxRequestsPerRoute": { "title": "Max requests per route", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Safe launch budget per route before retiring it. Default: 1, measured fastest for residential route-capacity mode because hot routes are discarded immediately.", "default": 1 }, "apifyProxyRouteCount": { "title": "Apify proxy route count", "minimum": 0, "maximum": 15000, "type": "integer", "description": "When useProxy is true, create this many explicit Apify proxy session routes. Default: 12000, the measured clean 5k buffer.", "default": 12000 }, "externalProxyUrls": { "title": "External proxy URLs", "type": "array", "description": "Optional explicit proxy URLs used as independent capacity-limited routes. Secrets are redacted from logs; route diagnostics only include host and hashes.", "items": { "type": "string" } }, "externalProxyUrlsText": { "title": "External proxy URLs text", "type": "string", "description": "Paste newline, comma, semicolon, or space separated proxy URLs here instead of using JSON externalProxyUrls." }, "discordAPIVersion": { "title": "Discord API version", "enum": [ "v6", "v7", "v8", "v9", "v10" ], "type": "string", "description": "Discord API version for the unauthenticated username attempt endpoint. Default: v10.", "default": "v10" }, "discordAPIVersions": { "title": "Discord API versions", "type": "array", "description": "Optional ordered API-version pool for round-robin username checks. Use only for diagnostics; each version must still return a real taken/available verifier response.", "items": { "type": "string" } }, "discordAPIBaseUrls": { "title": "Discord API base URLs", "type": "array", "description": "Optional ordered Discord-owned API base URL pool for diagnostics, for example stable, canary, and PTB hosts.", "items": { "type": "string" } }, "superProperties": { "title": "X-Super-Properties header", "type": "string", "description": "Base64-encoded X-Super-Properties header sent to Discord. Defaults to the current Chrome 138 Windows web-build fingerprint bundled with the actor. Update if Discord changes its expected format." }, "discordFingerprint": { "title": "Discord fingerprint", "type": "string", "description": "Optional X-Fingerprint header value from Discord's unauthenticated experiments endpoint." }, "useBrowserTLS": { "title": "Use browser TLS", "type": "boolean", "description": "Use a Chrome-like TLS and HTTP/2 client profile instead of Go's default HTTP transport. Experimental speed/anti-429 mode.", "default": true }, "browserTLSProfile": { "title": "Browser TLS profile", "enum": [ "chrome_124", "chrome_133", "chrome_144", "chrome_146" ], "type": "string", "description": "TLS browser profile used when useBrowserTLS is enabled. Default: chrome_133.", "default": "chrome_133" }, "enableHTTP3": { "title": "Enable HTTP/3", "type": "boolean", "description": "Use TLS-client protocol racing so Discord/Cloudflare may select HTTP/3 instead of forcing HTTP/2. Default: false.", "default": false }, "bootstrapBrowserSession": { "title": "Bootstrap browser session", "type": "boolean", "description": "Before username checks, reuse browser cookies and the unauthenticated Discord experiments fingerprint for the same session. Default: false; real 5k tests showed bootstrap was slower.", "default": false }, "outputMode": { "title": "Output mode", "enum": [ "all", "available_only" ], "type": "string", "description": "Choose all to save every checked username, or available_only to save only available usernames and reduce dataset storage/export cost.", "default": "all" }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Optional Discord webhook URL. Available usernames are sent in small batches. Prefer DISCORD_WEBHOOK_URL for secrets." }, "datasetBatchSize": { "title": "Dataset batch size", "minimum": 1, "type": "integer", "description": "Maximum number of result records buffered before flushing to the Apify dataset. Default: 1000 for 5k runs.", "default": 1000 }, "datasetMaxBatchBytes": { "title": "Dataset max batch bytes", "minimum": 1, "type": "integer", "description": "Maximum estimated JSON payload size buffered before flushing to the Apify dataset. Default: 4194304.", "default": 4194304 } } }, "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 } } } } } } } } } }