Check live service health and documented failure responses before you integrate.
Trust signals before you integrate
Transparent docs, authenticated requests, and visible reliability details make it easier to evaluate DomScan before you ship.
OpenAPI, Swagger, Postman, CLI, SDK, and MCP links are one click away.
Authenticated endpoints use API keys with clear credit costs before you call them.
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.
Embed domain checks, DNS intelligence, risk signals, or enrichment into onboarding, search, and internal tools.
Replace repeated manual lookups with scheduled jobs, alerting, and reproducible investigation steps.
Use predictable fields, documented status codes, and credit costs instead of scraping provider pages.
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.
Send your API key with the documented header and keep requests consistent across services.
Start from the curl and HTTP samples, then map the parameters into your application code.
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.
Generate clients or inspect every request and response shape.
Postman collectionImport ready-made requests for manual testing and team handoff.
SDKs and CLIUse maintained packages and command-line workflows instead of writing boilerplate.
MCP integrationExpose 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.
Parameter
Example Response
HTTP Status Codes
Endpoints
/v1/url-intelligence
/v1/url-intelligence/bulk
Trust signals before you integrate
Transparent docs, authenticated requests, and visible reliability details make it easier to evaluate DomScan before you ship.
OpenAPI, Swagger, Postman, CLI, SDK, and MCP links are one click away.
Authenticated endpoints use API keys with clear credit costs before you call them.
Start with 10,000 monthly credits and upgrade only when usage grows.
Start from the curl and HTTP samples, then map the parameters into your application code.
Key Features
Extract title, description, language, content type, final URL, and canonical URL.
Build preview cards from normalized images, favicons, Open Graph tags, and Twitter Cards.
Identify JSON-LD types and report malformed blocks without returning unbounded page data.
Read indexability directives and an allow-listed set of public security headers.
Extract declared email, telephone, social, developer, and creator links.
Inspect up to 10 URLs per request with bounded concurrency and per-item errors.
Example Request
curl -G -H "X-API-Key: $DOMSCAN_API_KEY" --data-urlencode "url=https://example.com" https://domscan.net/v1/url-intelligence
curl -X POST -H "X-API-Key: $DOMSCAN_API_KEY" -H "Content-Type: application/json" \
-d '{"urls":["https://example.com","https://github.com/about"]}' https://domscan.net/v1/url-intelligence/bulk
Example Response
{
"requested_url": "https://example.com/",
"final_url": "https://example.com/",
"status": 200,
"title": "Example Domain",
"canonical_url": "https://example.com/",
"open_graph": {},
"structured_data": { "types": [], "items": 0, "parse_errors": 0 },
"meta": { "cached": false, "fetch_transport": "worker" }
}
Frequently Asked Questions
An Open Graph API focuses on social tags. DomScan also returns canonical, redirect, robots, structured-data, security, contact, and identity signals.
Open Graph fields remain empty while standard title, description, icons, structured data, and other available signals are still returned.
No. The initial version inspects bounded public HTML responses and does not claim metadata that only appears after client-side JavaScript runs.
Yes. Redirects are bounded and every destination is checked to prevent access to private or internal network targets.
Yes. The bulk endpoint accepts up to 10 public URLs and preserves their input order.
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.
Request successful
Invalid parameters
Missing or invalid API key/session.
Not enough credits to run this request.
Rate limit exceeded
Internal error
Upstream RDAP error
Upstream service unavailable or temporarily rate limited.
Upstream lookup timed out.
Build with URL Intelligence