Domain Finder Recipe API

Q: Which endpoints are included?

This guide covers 4 public endpoints: POST /v1/domain-discovery/jobs , GET /v1/batches/:job_id , GET /v1/batches/:job_id/results , DELETE /v1/batches/:job_id .

curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \ -H "X-API-Key: $DOMSCAN_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: discovery-com-io-1" \ -d '{"tlds":["com","io"],"limit":25,"min_length":4,"max_length":12,"singular_only":true}'

{ "job": { "id": "bat_...", "status": "queued", "total": 50, "status_url": "https://domscan.net/v1/batches/bat_...", "results_url": "https://domscan.net/v1/batches/bat_.../results" }, "discovery": { "page_words": 25, "tlds": ["com", "io"], "domain_checks": 50, "credits_per_domain": 1, "next_cursor": "..." } }

Category Domain Search & Pricing

Endpoints 4

Credits 0-1/item

Authentication Authentication required

Used by people at amazing companies

Trust signals before you integrate

Transparent docs, authenticated requests, and visible reliability details make it easier to evaluate DomScan before you ship.

Live Service status

Check live service health and documented failure responses before you integrate.

OpenAPI API artifacts

OpenAPI, Swagger, Postman, CLI, SDK, and MCP links are one click away.

API keys Protected access

Authenticated endpoints use API keys with clear credit costs before you call them.

10,000 Free allowance

Start with 10,000 monthly credits and upgrade only when usage grows.

What this API helps you ship

Use this page as a production brief: endpoints, examples, response shape, and the workflow pieces needed to plug DomScan into your own product.

Product workflows

Embed domain checks, DNS intelligence, risk signals, or enrichment into onboarding, search, and internal tools.

Analyst automation

Replace repeated manual lookups with scheduled jobs, alerting, and reproducible investigation steps.

Clean JSON data

Use predictable fields, documented status codes, and credit costs instead of scraping provider pages.

AI and ops tooling

Feed agents, dashboards, SOAR playbooks, and CRMs through OpenAPI, SDK, Postman, or MCP.

Integration workflow

A simple path from first request to repeatable production usage.

Authenticate once

Send your API key with the documented header and keep requests consistent across services.

Query with examples

Start from the curl and HTTP samples, then map the parameters into your application code.

Operate and monitor

Use status codes, credit costs, and response fields to build retries, logs, and alerts.

Developer kit

Jump from this page into machine-readable docs, request collections, SDKs, or agent tooling.

OpenAPI schema

Generate clients or inspect every request and response shape.

Postman collection

Import ready-made requests for manual testing and team handoff.

SDKs and CLI

Use maintained packages and command-line workflows instead of writing boilerplate.

MCP integration

Expose domain intelligence to AI agents and internal assistant workflows.

Parameters and response map

Scan the inputs, output fields, and status codes before wiring the endpoint into your client.

Request parameters

Parameter

tldslimitcursormin_lengthmax_lengthsingular_onlyjob_idafterformat

Response fields

Example Response

jobjob.idjob.statusjob.totaljob.status_urljob.results_urldiscoverydiscovery.page_wordsdiscovery.tldsdiscovery.domain_checksdiscovery.credits_per_domaindiscovery.next_cursor

Status coverage

HTTP Status Codes

200202400401402409429

Endpoints

POST /v1/domain-discovery/jobs

Credits: 1/itemAuthentication: Authentication required

tldslimitcursormin_lengthmax_lengthsingular_only

GET /v1/batches/:job_id

Credits: 0Authentication: Authentication required

job_id

GET /v1/batches/:job_id/results

Credits: 0Authentication: Authentication required

job_idafterlimitformat

DELETE /v1/batches/:job_id

Credits: 0Authentication: Authentication required

job_id

Trust signals before you integrate

Transparent docs, authenticated requests, and visible reliability details make it easier to evaluate DomScan before you ship.

Service status API artifacts

OpenAPI, Swagger, Postman, CLI, SDK, and MCP links are one click away.

API keys Protected access

Authenticated endpoints use API keys with clear credit costs before you call them.

Free allowance Sign Up for Free

Start with 10,000 monthly credits and upgrade only when usage grows.

Active Example Request

Start from the curl and HTTP samples, then map the parameters into your application code.

Key Features

Endpoints

POST /v1/domain-discovery/jobs • GET /v1/batches/:job_id • GET /v1/batches/:job_id/results • DELETE /v1/batches/:job_id

Parameter

tlds, limit, cursor, min_length, max_length, singular_only, job_id, after, format

HTTP Status Codes

200, 202, 400, 401, 402, 409, 429

Credits / Authentication

0-1/item / Authentication required

Example Request

POST /v1/domain-discovery/jobs bash

curl -X POST "https://domscan.net/v1/domain-discovery/jobs" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: discovery-com-io-1" \
  -d '{"tlds":["com","io"],"limit":25,"min_length":4,"max_length":12,"singular_only":true}'

Example Response

202 Accepted json

{
  "job": {
    "id": "bat_...",
    "status": "queued",
    "total": 50,
    "status_url": "https://domscan.net/v1/batches/bat_...",
    "results_url": "https://domscan.net/v1/batches/bat_.../results"
  },
  "discovery": {
    "page_words": 25,
    "tlds": ["com", "io"],
    "domain_checks": 50,
    "credits_per_domain": 1,
    "next_cursor": "..."
  }
}

Frequently Asked Questions

Which endpoints are included?

This guide covers 4 public endpoints: POST /v1/domain-discovery/jobs, GET /v1/batches/:job_id, GET /v1/batches/:job_id/results, DELETE /v1/batches/:job_id.

Does this API require authentication?

Yes. Send your API key with the `X-API-Key` or `Authorization: Bearer` header when calling Domain Finder Recipe.

How many credits does it use?

Requests in these guides use 0-1/item credits depending on the endpoint. For bulk endpoints, credits use the standard per-item rate.

Where can I see the full parameters and related endpoints?

Use the full docs for Domain Finder Recipe to review parameter details, authentication notes, and related endpoints in the same API family.

Related Tools & Resources

HTTP Status Codes

We document the HTTP status codes you should handle so you can distinguish successful responses, auth issues, credits, rate limits, missing data, and upstream failures.

OK 200

Request successful

Accepted 202

Cache-only subdomain miss accepted for background refresh. No credits are charged; retry after the Retry-After delay.

Bad Request 400

Invalid parameters

Unauthorized 401

Missing or invalid API key/session.

Payment Required 402

Not enough credits to run this request.

HTTP 409 409

We document the HTTP status codes you should handle so you can distinguish successful responses, auth issues, credits, rate limits, missing data, and upstream failures.

Too Many Requests 429

Rate limit exceeded

Start free with 10,000 credits per month. Use any public API and add credits only when you need them.

Start Free View documentation