API reference

Domain Finder Recipe API

Queue many supported API requests and collect their results without keeping a client connection open. Use this reference to choose an operation and integrate its documented response contract.

View product page

Operations

POST /v1/domain-discovery/jobs View API reference

POST `/v1/domain-discovery/jobs`

Operation: createDomainDiscoveryJob Credits and authentication: 1 Authentication required

POST /v1/domain-discovery/jobs

Body Parameters

Parameter	Type	required
tlds	string[]	required
limit	integer	optional
cursor	string	optional
min_length	integer Default `3`	optional
max_length	integer Default `16`	optional
singular_only	boolean Default `false`	optional

Response Fields

Field	Type
`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

Example Request

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
}'

Example Response

{
  "job": {
    "id": "string",
    "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": true,
      "status": "not_configured",
      "attempts": 1
    },
    "status_url": "https://example.com",
    "results_url": "https://example.com",
    "results_csv_url": "https://example.com",
    "poll_after_ms": 1,
    "created_at": "2026-04-15T12:00:00Z",
    "started_at": "2026-04-15T12:00:00Z",
    "completed_at": "2026-04-15T12:00:00Z",
    "cancelled_at": "2026-04-15T12:00:00Z",
    "updated_at": "2026-04-15T12:00:00Z",
    "processing_deadline_at": "2026-04-15T12:00:00Z",
    "results_expires_at": "2026-04-15T12:00:00Z"
  },
  "discovery": {
    "corpus": "iannuttall/unclaimed",
    "corpus_version": "string",
    "total_matching_words": 1,
    "page_offset": 1,
    "page_words": 1,
    "domain_checks": "example.com",
    "tlds": [
      "string"
    ],
    "filters": {
      "min_length": 1,
      "max_length": 1,
      "singular_only": true
    },
    "credits_per_domain": "example.com",
    "next_cursor": "string"
  }
}

Reference resources

OpenAPI 3.0 Postman MCP