> For the complete documentation index see https://domscan.net/llms.txt. Markdown versions of every docs page are available by appending .md to the page URL.

Source: https://domscan.net/zh/docs/products/subdomains

# 子域名查找器 API 参考

使用各种枚举技术发现域名的子域名。 通过本参考选择合适的端点，并准确了解它返回的内容。

[查看产品页](https://domscan.net/zh/subdomain-finder-api)

## 操作

GET `/v1/subdomains` [查看 API 参考](https://domscan.net/zh/docs/products/subdomains#getSubdomains)

POST `/v1/subdomains/bulk` [查看 API 参考](https://domscan.net/zh/docs/products/subdomains#bulkGetSubdomains)

## GET `/v1/subdomains`

操作: `getSubdomains`
积分和身份验证: 4-5
需要身份验证

GET /v1/subdomains 积分: 4-5

#### 查询参数

| 参数 | 类型 | 必需 |
| --- | --- | --- |
| domain | string | 必需 |
| sources | string 允许的值 `ct` 默认值 `ct` | 可选 |
| verify | string 允许的值 `true`, `false`, `1`, `0`, `yes`, `no` 默认值 `false` | 可选 |
| include_wildcards | string 允许的值 `true`, `false`, `1`, `0`, `yes`, `no` 默认值 `false` | 可选 |
| limit | integer 默认值 `500` | 可选 |
| prefer_cache | string 允许的值 `true`, `false`, `1`, `0`, `yes`, `no` 默认值 `false` | 可选 |
| cursor | string | 可选 |

#### 响应字段

| 字段 | 类型 |
| --- | --- |
| `has_more` | boolean |
| `next_cursor` | string \| null |
| `cache_age_s` | integer |
| `domain` | string |
| `subdomains[]` | object[] |
| `subdomains[]` | object |
| `subdomains[].name` | string |
| `subdomains[].source` | string |
| `subdomains[].first_seen` | string \| null |
| `subdomains[].verified` | boolean \| null |
| `subdomains[].dns_records` | object |
| `subdomains[].dns_records.A[]` | string[] |
| `subdomains[].dns_records.AAAA[]` | string[] |
| `subdomains[].dns_records.CNAME` | string \| null |
| `wildcards[]` | object[] |
| `wildcards[]` | object |
| `wildcards[].pattern` | string |
| `wildcards[].source` | string |
| `wildcards[].first_seen` | string \| null |
| `summary` | object |
| `summary.total_found` | integer |
| `summary.returned` | integer |
| `summary.verified_count` | integer |
| `summary.unverified_count` | integer |
| `summary.verification_unknown_count` | integer |
| `summary.sources_used[]` | string[] |
| `summary.apex_included` | boolean |
| `summary.wildcard_suppressed_count` | integer |
| `summary.wildcard_returned_count` | integer |
| `intelligence_summary` | object |
| `intelligence_summary.data_sources[]` | string[] |
| `intelligence_summary.source_count` | integer |
| `intelligence_summary.cache_status` | string |
| `intelligence_summary.returned_count` | integer |
| `intelligence_summary.total_found` | integer |
| `intelligence_summary.truncated` | boolean |
| `intelligence_summary.limit` | integer |
| `intelligence_summary.verification_requested` | boolean |
| `intelligence_summary.include_wildcards` | boolean |
| `intelligence_summary.verified_count` | integer |
| `intelligence_summary.verified_ratio` | number \| null |
| `intelligence_summary.live_dns_record_count` | integer |
| `intelligence_summary.apex_included` | boolean |
| `intelligence_summary.wildcard_suppressed_count` | integer |
| `intelligence_summary.wildcard_returned_count` | integer |
| `intelligence_summary.first_seen_oldest` | string \| null |
| `intelligence_summary.first_seen_newest` | string \| null |
| `intelligence_summary.warning_count` | integer |
| `warnings[]` | string[] |
| `meta` | object |
| `meta.query_time_ms` | integer |
| `meta.cached` | boolean |
| `meta.stale` | boolean |

#### 请求示例

```bash
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/subdomains?domain=example.com&sources=ct&verify=yes&include_wildcards=1&limit=500&prefer_cache=false"
```

```javascript
const response = await fetch("https://domscan.net/v1/subdomains?domain=example.com&sources=ct&verify=yes&include_wildcards=1&limit=500&prefer_cache=false", {
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY },
});
const data = await response.json();
console.log(data);
```

```python
import os
import requests

response = requests.get(
    "https://domscan.net/v1/subdomains?domain=example.com&sources=ct&verify=yes&include_wildcards=1&limit=500&prefer_cache=false",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
)
print(response.json())
```

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(http.MethodGet, "https://domscan.net/v1/subdomains?domain=example.com&sources=ct&verify=yes&include_wildcards=1&limit=500&prefer_cache=false", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))

```ruby
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/subdomains?domain=example.com&sources=ct&verify=yes&include_wildcards=1&limit=500&prefer_cache=false")
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")

#### 响应示例

```json
{
  "domain": "example.com",
  "subdomains": [
    {
      "name": "api.example.com",
      "source": "crtsh",
      "first_seen": "2025-01-15T00:00:00Z",
      "verified": true,
      "dns_records": {
        "A": [
          "example"
        ],
        "AAAA": [
          "example"
        ],
        "CNAME": "example"
      }
    }
  ],
  "summary": {
    "total_found": 1,
    "returned": 1,
    "verified_count": 1,
    "unverified_count": 1,
    "verification_unknown_count": 1,
    "sources_used": [
      "ct"
    ],
    "apex_included": false,
    "wildcard_suppressed_count": 1,
    "wildcard_returned_count": 1
  },
  "intelligence_summary": {
    "data_sources": [
      "ct"
    ],
    "source_count": 1,
    "cache_status": "live",
    "returned_count": 1,
    "total_found": 1,
    "truncated": false,
    "limit": 1,
    "verification_requested": false,
    "include_wildcards": false,
    "verified_count": 1,
    "verified_ratio": 0.5,
    "live_dns_record_count": 1,
    "apex_included": false,
    "wildcard_suppressed_count": 1,
    "wildcard_returned_count": 1,
    "first_seen_oldest": "example",
    "first_seen_newest": "example",
    "warning_count": 1
  },
  "meta": {
    "query_time_ms": 1,
    "cached": false,
    "stale": false
  },
  "has_more": false,
  "next_cursor": "example",
  "cache_age_s": 1,
  "wildcards": [
    {
      "pattern": "*.example.com",
      "source": "ct",
      "first_seen": "example"
    }
  ],
  "warnings": [
    "example"
  ]
}
```

#### HTTP 状态码

- `200` 成功
- `202` 已接受
- `400` 请求错误
- `401` 未授权
- `402` 需要付款
- `429` 请求过多
- `503` 服务不可用
- `504` 网关超时

## POST `/v1/subdomains/bulk`

操作: `bulkGetSubdomains`
积分和身份验证: 4-5
需要身份验证

POST /v1/subdomains/bulk 积分: 4-5/item

#### 查询参数

| 参数 | 类型 | 必需 |
| --- | --- | --- |
| dry_run | string 允许的值 `true` | 可选 |

#### 正文参数

| 参数 | 类型 | 必需 |
| --- | --- | --- |
| domains | string[] | 必需 |
| verify | boolean 默认值 `false` | 可选 |
| include_wildcards | boolean 默认值 `false` | 可选 |
| limit | integer 默认值 `500` | 可选 |

#### 响应字段

| 字段 | 类型 |
| --- | --- |
| `results[]` | unknown[] |
| `meta` | object |
| `meta.total` | integer |
| `meta.succeeded` | integer |
| `meta.failed` | integer |
| `meta.max_items` | integer |
| `meta.credits_per_item` | integer |
| `meta.duration_ms` | integer |

#### 请求示例

```bash
curl -X POST "https://domscan.net/v1/subdomains/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "domains": [
    "example.com",
    "cloudflare.com"
  ],
  "verify": false,
  "limit": 500
}'
```

```javascript
const response = await fetch("https://domscan.net/v1/subdomains/bulk", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "domains": [
      "example.com",
      "cloudflare.com"
    ],
    "verify": false,
    "limit": 500
  }),
});
const data = await response.json();
console.log(data);
```

```python
import os
import requests

response = requests.post(
    "https://domscan.net/v1/subdomains/bulk",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "domains": [
            "example.com",
            "cloudflare.com",
        ],
        "verify": False,
        "limit": 500,
    },
)
print(response.json())
```

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{
	  "domains": [
	    "example.com",
	    "cloudflare.com"
	  ],
	  "verify": false,
	  "limit": 500
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/subdomains/bulk", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("X-API-Key", os.Getenv("DOMSCAN_API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	data, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(resp.Status, string(data))
}
```

```ruby
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/subdomains/bulk")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "domains" => [
    "example.com",
    "cloudflare.com"
  ],
  "verify" => false,
  "limit" => 500
})

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end
puts JSON.pretty_generate(JSON.parse(response.body))
```

#### 响应示例

```json
{
  "results": [
    {
      "input": "example",
      "data": {}
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "max_items": 10,
    "credits_per_item": 1,
    "duration_ms": 1
  }
}
```

#### HTTP 状态码

- `200` 成功
- `400` 请求错误
- `401` 未授权
- `402` 需要付款
- `409` HTTP 409
- `422` HTTP 422
- `429` 请求过多

## 参考资源

[OpenAPI 3.0](https://domscan.net/v1/openapi.json)
[Postman](https://domscan.net/v1/postman.json)
[MCP](https://domscan.net/zh/mcp-domain-checker)
