APIリファレンス

ドメイン検索レシピ APIリファレンス

対応する多数の API リクエストをキューに追加し、クライアント接続を開いたままにせず結果を取得できます。 このリファレンスで、最適なエンドポイントを選び、返される内容を正確に確認できます。

操作

POST /v1/domain-discovery/jobs APIリファレンスを見る

POST /v1/domain-discovery/jobs

操作: createDomainDiscoveryJob クレジットと認証: 1 認証が必要
POST /v1/domain-discovery/jobs クレジット: 1/item

ボディパラメータ

パラメータ タイプ 必須
notify_webhook unknown オプション
tlds string[] 必須
limit integer オプション
cursor string オプション
min_length integer
デフォルト 3
オプション
max_length integer
デフォルト 16
オプション
singular_only boolean
デフォルト false
オプション

レスポンスフィールド

フィールド タイプ
job object
job.id string
job.status string
job.total integer
job.counts object
job.counts.pending integer
job.counts.processing integer
job.counts.succeeded integer
job.counts.failed integer
job.counts.cancelled integer
job.billing object
job.billing.credits_charged integer
job.billing.credits_refunded integer
job.billing.credits_net integer
job.webhook object
job.webhook.configured boolean
job.webhook.status string
job.webhook.attempts integer
job.status_url string
job.results_url string
job.results_csv_url string
job.poll_after_ms integer | null
job.created_at string
job.started_at string | null
job.completed_at string | null
job.cancelled_at string | null
job.updated_at string
job.processing_deadline_at string
job.results_expires_at string
discovery object
discovery.corpus string
discovery.corpus_version string
discovery.total_matching_words integer
discovery.page_offset integer
discovery.page_words integer
discovery.domain_checks integer
discovery.tlds[] string[]
discovery.filters object
discovery.filters.min_length integer
discovery.filters.max_length integer
discovery.filters.singular_only boolean
discovery.credits_per_domain integer
discovery.next_cursor string | null

リクエスト例

curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "tlds": [
    "io",
    "ai"
  ],
  "limit": 50,
  "min_length": 4,
  "max_length": 8,
  "singular_only": true
}'
const response = await fetch("https://domscan.net/v1/domain-discovery/jobs", {
  method: "POST",
  headers: { "X-API-Key": process.env.DOMSCAN_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({
    "tlds": [
      "io",
      "ai"
    ],
    "limit": 50,
    "min_length": 4,
    "max_length": 8,
    "singular_only": true
  }),
});
const data = await response.json();
console.log(data);
import os
import requests

response = requests.post(
    "https://domscan.net/v1/domain-discovery/jobs",
    headers={"X-API-Key": os.environ["DOMSCAN_API_KEY"]},
    json={
        "tlds": [
            "io",
            "ai",
        ],
        "limit": 50,
        "min_length": 4,
        "max_length": 8,
        "singular_only": True,
    },
)
print(response.json())
package main

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

func main() {
	body := strings.NewReader(`{
	  "tlds": [
	    "io",
	    "ai"
	  ],
	  "limit": 50,
	  "min_length": 4,
	  "max_length": 8,
	  "singular_only": true
	}`)
	req, err := http.NewRequest(http.MethodPost, "https://domscan.net/v1/domain-discovery/jobs", 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))
}
require "json"
require "net/http"

uri = URI("https://domscan.net/v1/domain-discovery/jobs")
request = Net::HTTP::Post.new(uri)
request["X-API-Key"] = ENV.fetch("DOMSCAN_API_KEY")
request["Content-Type"] = "application/json"
request.body = JSON.generate({
  "tlds" => [
    "io",
    "ai"
  ],
  "limit" => 50,
  "min_length" => 4,
  "max_length" => 8,
  "singular_only" => true
})

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))

レスポンス例

{
  "job": {
    "id": "example-id",
    "status": "queued",
    "total": 1,
    "counts": {
      "pending": 1,
      "processing": 1,
      "succeeded": 1,
      "failed": 1,
      "cancelled": 1
    },
    "billing": {
      "credits_charged": 1,
      "credits_refunded": 1,
      "credits_net": 1
    },
    "webhook": {
      "configured": false,
      "status": "not_configured",
      "attempts": 1
    },
    "status_url": "https://example.com",
    "results_url": "https://example.com",
    "results_csv_url": "https://example.com",
    "created_at": "2026-08-27T12:00:00Z",
    "updated_at": "2026-08-27T12:00:00Z",
    "processing_deadline_at": "2026-08-27T12:00:00Z",
    "results_expires_at": "2026-08-27T12:00:00Z",
    "poll_after_ms": 1,
    "started_at": "2026-08-27T12:00:00Z",
    "completed_at": "2026-08-27T12:00:00Z",
    "cancelled_at": "2026-08-27T12:00:00Z"
  },
  "discovery": {
    "corpus": "iannuttall/unclaimed",
    "corpus_version": "example",
    "total_matching_words": 1,
    "page_offset": 1,
    "page_words": 1,
    "domain_checks": 1,
    "tlds": [
      "com",
      "net",
      "org"
    ],
    "filters": {
      "min_length": 1,
      "max_length": 1,
      "singular_only": false
    },
    "credits_per_domain": 1,
    "next_cursor": "example"
  }
}

HTTP ステータスコード

  • 200 成功
  • 202 受理済み
  • 400 不正なリクエスト
  • 401 未認証
  • 402 支払いが必要
  • 409 HTTP 409
  • 429 リクエスト過多

リファレンスリソース