{ "openapi": "3.0.1", "info": { "title": "Domain WHOIS and DNS Lookup", "description": "WHOIS registry data and DNS records for a list of domains, one row per domain, with the mail provider, SPF record and DMARC policy read from the records. A list of subdomains can be added, and scheduled runs can return only domains that changed.", "version": "0.1", "x-build-id": "wGoRMcqXQzJu9oWEw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deriverge~domain-whois-dns-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deriverge-domain-whois-dns-lookup", "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/deriverge~domain-whois-dns-lookup/runs": { "post": { "operationId": "runs-sync-deriverge-domain-whois-dns-lookup", "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/deriverge~domain-whois-dns-lookup/run-sync": { "post": { "operationId": "run-sync-deriverge-domain-whois-dns-lookup", "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": { "domains": { "title": "Domains", "type": "array", "description": "Domain names in any form: bare names, URLs, email addresses, hostnames with a subdomain. Each is reduced to its registrable domain with the public suffix list, so blog.example.co.uk becomes example.co.uk.", "items": { "type": "string" } }, "includeWhois": { "title": "Registry data (WHOIS via RDAP)", "type": "boolean", "description": "Registrar, dates, statuses, nameservers and DNSSEC from the registry. Charged per domain.", "default": true }, "includeDns": { "title": "DNS records", "type": "boolean", "description": "A, AAAA, CNAME, MX, NS, TXT, SOA and CAA records through DNS over HTTPS. Charged per domain.", "default": true }, "includeSubdomains": { "title": "Subdomains", "type": "boolean", "description": "Hostnames under the domain from the subdomain.center index, plus certificate transparency logs when the run can search them, up to 500 per domain. One extra lookup per domain, charged separately.", "default": false }, "dnsTypes": { "title": "DNS record types", "type": "array", "description": "Which record types to read. Leave empty for all eight.", "items": { "type": "string" } }, "emailChecks": { "title": "Email setup checks", "type": "boolean", "description": "Read the SPF record, the DMARC record and policy, and name the mail provider from the MX hosts. Two extra DNS queries per domain, no extra charge.", "default": true }, "expiringWithinDays": { "title": "Only domains expiring within N days", "minimum": 1, "type": "integer", "description": "Keep only domains whose registry expiry date is within this many days. Other domains are dropped and never charged. Leave empty to keep everything." }, "changesOnly": { "title": "Return only domains that changed since the last run", "type": "boolean", "description": "Keeps a snapshot per watch name (or per saved task) and returns only domains whose registrar, expiry, status, nameservers, A, MX, NS, SPF or DMARC changed, plus new domains. Schedule it daily and you have a domain monitor that bills only for what moved; the CHANGES record lists every difference.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the snapshot used by the changes-only mode, for example \"our-domains\". Runs from a saved task get a snapshot automatically even without a name." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Hard cap on returned domains in the run.", "default": 10000 } } }, "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 } } } } } } } } } }