{ "openapi": "3.0.1", "info": { "title": "Domain WHOIS Database Search", "description": "Search registered and recently expired domains by name, TLD, registrar, dates, SEO traffic, paid visibility, and backlink strength. Export up to 200 enriched domain records.", "version": "1.0", "x-build-id": "0Zb0TeDbgma5YSRyz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/opspilot.cc~domain-whois-database-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-opspilot.cc-domain-whois-database-search", "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/opspilot.cc~domain-whois-database-search/runs": { "post": { "operationId": "runs-sync-opspilot.cc-domain-whois-database-search", "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/opspilot.cc~domain-whois-database-search/run-sync": { "post": { "operationId": "run-sync-opspilot.cc-domain-whois-database-search", "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", "required": [ "domain_query", "tld", "registrar", "registration_status", "created_from", "created_to", "expires_before", "min_organic_traffic", "sort_by" ], "properties": { "domain_query": { "title": "Domain Name Contains", "maxLength": 63, "type": "string", "description": "Text that must appear anywhere in the domain name. Use a brand, niche, product, or keyword. Default: seo.", "default": "seo" }, "tld": { "title": "Top-Level Domain", "enum": [ "any", "com", "net", "org", "io", "ai", "co", "app", "dev", "info", "biz", "me", "us", "uk", "de", "fr", "ca", "au", "jp", "in", "cn" ], "type": "string", "description": "Optionally restrict results to one popular domain extension.", "default": "any" }, "registrar": { "title": "Registrar Contains", "maxLength": 100, "type": "string", "description": "Optional registrar name filter, such as GoDaddy, NameCheap, Cloudflare, or MarkMonitor.", "default": "" }, "registration_status": { "title": "Registration Status", "enum": [ "registered", "expired", "any" ], "type": "string", "description": "Choose registered domains, recently expired domains, or both.", "default": "registered" }, "created_from": { "title": "Registered From", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional earliest registration date in YYYY-MM-DD format.", "default": "" }, "created_to": { "title": "Registered To", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional latest registration date in YYYY-MM-DD format.", "default": "" }, "expires_before": { "title": "Expires Before", "pattern": "^$|^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "Optional latest expiration date in YYYY-MM-DD format. Useful for renewal and expiration research.", "default": "" }, "min_organic_traffic": { "title": "Minimum Estimated Organic Traffic", "minimum": 0, "type": "integer", "description": "Only return domains with at least this estimated monthly organic traffic. Default: 0.", "default": 0 }, "sort_by": { "title": "Sort Results By", "enum": [ "organic_traffic_desc", "backlinks_desc", "referring_domains_desc", "newest_registered", "oldest_registered", "expiring_soon", "domain_asc" ], "type": "string", "description": "Choose which domains appear first. The result limit is always 200.", "default": "organic_traffic_desc" } } }, "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 } } } } } } } } } }