{ "openapi": "3.0.1", "info": { "title": "Vercel Domain Scraper", "description": "Check domain-name availability and pricing across TLDs using Vercel's official Registrar API. Generate keyword x TLD combinations, list supported registrar TLDs, get standard/premium/renewal pricing, and surface alternative domains for names that are already taken.", "version": "0.1", "x-build-id": "ljMkZWOEAyG781Xrc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~vercel-domain-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-vercel-domain-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/crawlerbros~vercel-domain-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-vercel-domain-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/crawlerbros~vercel-domain-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-vercel-domain-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": { "mode": { "title": "Mode", "enum": [ "domainCheck", "supportedTlds", "tldPricing" ], "type": "string", "description": "Choose what to fetch from Vercel Registrar: domain availability checks, supported TLDs, or TLD pricing.", "default": "domainCheck" }, "vercelApiToken": { "title": "Vercel API token", "type": "string", "description": "Your personal Vercel API token, created at vercel.com/account/tokens. This actor calls Vercel's own Registrar API on your behalf and cannot return domain data without it." }, "teamId": { "title": "Vercel team ID", "type": "string", "description": "Optional. Set this if your API token is scoped to a Vercel team (starts with `team_`).", "default": "" }, "domains": { "title": "Exact domains", "type": "array", "description": "Optional exact apex domains to check directly, e.g. `example.com`, `brand.dev`, or `https://example.com/path`. These are checked before generated keyword x TLD combinations.", "default": [], "items": { "type": "string" } }, "keywords": { "title": "Keywords / base domain names", "type": "array", "description": "Base names to check across TLDs, e.g. `mystartup`. Full URLs or existing domains are also accepted; only the base label is used. Use this or `domains`.", "default": [], "items": { "type": "string" } }, "tlds": { "title": "TLDs to check", "type": "array", "description": "TLDs to check or price, with or without the leading dot (e.g. `com`, `.dev`, `br.com`, or `xn--q9jyb4c`). Leave empty to use a curated list of popular TLDs for domain checks and TLD pricing.", "default": [], "items": { "type": "string" } }, "maxCombinations": { "title": "Max output rows / combinations", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on exact domains plus keyword x TLD combinations checked. In `supportedTlds` and `tldPricing` modes, this caps emitted TLD rows.", "default": 50 }, "includePremiumPricing": { "title": "Include pricing", "type": "boolean", "description": "Fetch purchase/renewal/transfer pricing for each available domain, and derive whether it is premium-priced.", "default": true }, "includeAlternatives": { "title": "Include alternatives", "type": "boolean", "description": "For taken domains, list available same-keyword domains on other TLDs as alternatives.", "default": true }, "pricingYears": { "title": "Pricing term (years)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of registration years to price. Only used when `includePremiumPricing` is on.", "default": 1 } } }, "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 } } } } } } } } } }