# Subdomain Discovery API (`crawland/subdomain-discovery-api`) Actor Paginated subdomain enumeration for any registered domain — DNS records, registrar, WHOIS, vendor reputation, and category labels per subdomain, served from the Crawland threat-intelligence backend. - **URL**: https://apify.com/crawland/subdomain-discovery-api.md - **Developed by:** [Crawland](https://apify.com/crawland) (community) - **Categories:** Developer tools, Other, Automation - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $1.00 / 1,000 subdomain discoveries This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Subdomain Discovery API Paginated subdomain enumeration for any registered domain — DNS records, registrar, WHOIS, vendor reputation, and category labels per subdomain. ### API Overview Subdomain Discovery API answers a single, high-value question: **"What does this domain's attack surface actually look like?"** Send a registered domain — `example.com` — and get back the discovered subdomains along with the per-subdomain context you need to triage exposure: DNS records, registrar, WHOIS, popularity ranks, vendor reputation stats, tags, and category labels. ### What you get on every request - **`subdomains`** — an array of per-subdomain objects, each with: - `subdomain` — the FQDN (e.g. `staging-api.example.com`). - `dns_records` — A / AAAA / CNAME / MX records with TTLs. - `registrar`, `whois` — registrar string and the raw WHOIS block. - `popularity_ranks` — Alexa / Cisco Umbrella / Cloudflare Radar / Majestic ranks where available. - `reputation`, `security_vendor_analysis_stats` — vendor verdict tally so you can spot the subdomain that flipped malicious without re-enriching. - `tags`, `categories`, `tld`, `modification_date`, `dns_records_update_date`. - **`cursor`** — opaque pagination token. Pass it back as the `cursor` query parameter to fetch the next page. Empty / missing cursor means "no more results". Page size is fixed at 10 subdomains per request. ### Pagination pattern 1. First request: `GET /scan?query=example.com` — returns the first 10 subdomains plus a `cursor`. 2. Subsequent requests: `GET /scan?query=example.com&cursor=` — returns the next 10 subdomains plus the next cursor. 3. Stop when the response carries no `cursor` (or an empty one). Cursors are tied to the `query` they were issued for — do not mix cursors across different domains. ### What can you do with this API? - 🎯 **Attack surface in one call** — no juggling between DNS, WHOIS, and reputation APIs. One request, full per-subdomain context. - 🧠 **Reputation built in** — every subdomain already comes with `security_vendor_analysis_stats`, so you can flag a leaked staging subdomain on the first pass. - 📚 **Cursor pagination** — bounded payloads, simple to integrate into any ASM crawl pipeline. - 🔒 **Battle-tested** — used in production by ASM platforms, pentest teams, and bug-bounty hunters. ### Response model Every successful request returns: ```json { "is_success": true, "response_code": 200, "message": "Success", "data": { "search_type": "domain", "subdomains": [ { "subdomain": "staging-api.example.com", "tld": "com", "registrar": "MarkMonitor Inc.", "dns_records": [{ "type": "A", "value": "1.2.3.4", "ttl": 300 }], "security_vendor_analysis_stats": { "harmless": 0, "malicious": 0, "undetected": 91 } } ], "cursor": "eyJsaW1pdCI6IDEwLCAib2Zmc2V0IjogMTB9" } } ```` Always inspect `is_success` rather than relying on the HTTP status — invalid inputs and lookup misses are also returned with HTTP 200 and `is_success: false`. ### Use cases - **Attack surface management (ASM)** — continuously enumerate an organisation's external footprint and flag staging / preproduction / forgotten subdomains. - **Penetration testing reconnaissance** — fast pivot from a single domain to the full subdomain inventory. - **Subdomain takeover detection** — surface dangling subdomains pointing at unclaimed cloud resources. - **Brand protection** — catch lookalike subdomains and verify ownership. - **Bug bounty scoping** — quickly understand what targets are in scope. ### How is this different from IoC Lookup / IoC Enrichment? Subdomain Discovery takes one domain and returns its subdomains. IoC Lookup takes one indicator and returns reputation + vendor verdicts. IoC Enrichment takes one indicator and returns OSINT context (adversary, malware family, MITRE ATT\&CK). They are complementary — discovery finds the subdomains, then enrichment / lookup tells you which matter. ### Need something custom or need support? Looking for bulk / streaming / on-prem, a different response format, or help with setup? Send us a DM and we'll be happy to help you find the best setup for your use case. # Actor input Schema ## `query` (type: `string`): The registered domain to enumerate subdomains for (no scheme, no path). ## `cursor` (type: `string`): Opaque pagination cursor from a previous response. Omit on the first request; pass the returned cursor to fetch the next 10 subdomains. ## Actor input object example ```json { "query": "tesla.com" } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "query": "tesla.com" }; // Run the Actor and wait for it to finish const run = await client.actor("crawland/subdomain-discovery-api").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "query": "tesla.com" } # Run the Actor and wait for it to finish run = client.actor("crawland/subdomain-discovery-api").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "query": "tesla.com" }' | apify call crawland/subdomain-discovery-api --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawland/subdomain-discovery-api", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Subdomain Discovery API", "description": "Paginated subdomain enumeration for any registered domain — DNS records, registrar, WHOIS, vendor reputation, and category labels per subdomain, served from the Crawland threat-intelligence backend.", "version": "0.1", "x-build-id": "a6veH08Bbj6ehPqUI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawland~subdomain-discovery-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawland-subdomain-discovery-api", "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/crawland~subdomain-discovery-api/runs": { "post": { "operationId": "runs-sync-crawland-subdomain-discovery-api", "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/crawland~subdomain-discovery-api/run-sync": { "post": { "operationId": "run-sync-crawland-subdomain-discovery-api", "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": [ "query" ], "properties": { "query": { "title": "Domain", "type": "string", "description": "The registered domain to enumerate subdomains for (no scheme, no path)." }, "cursor": { "title": "Cursor (pagination)", "type": "string", "description": "Opaque pagination cursor from a previous response. Omit on the first request; pass the returned cursor to fetch the next 10 subdomains." } } }, "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 } } } } } } } } } } ```