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/identity-assets
/v1/identity-assets/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
Find logo candidates declared through structured data and public website metadata.
Extract favicons, Apple touch icons, mask icons, and web manifest references.
Return Open Graph preview images and declared theme colors alongside identity assets.
Each candidate identifies the source, asset kind, MIME type, and declared size when available.
Include normalized public profiles linked by the website, with source and confidence.
Process up to 10 domains in one request with ordered results and per-item errors.
Example Request
curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/identity-assets?domain=example.com"
curl -X POST -H "X-API-Key: $DOMSCAN_API_KEY" -H "Content-Type: application/json" \
-d '{"domains":["example.com","github.com"]}' https://domscan.net/v1/identity-assets/bulk
Example Response
{
"domain": "example.com",
"organization_name": "Example",
"assets": {
"logo_url": "https://example.com/logo.svg",
"favicon_url": "https://example.com/favicon.ico",
"theme_color": "#111827",
"candidates": []
},
"confidence": 0.8,
"evidence": ["organization_name", "structured_logo", "declared_icon"]
}
Frequently Asked Questions
DomScan prioritizes logos explicitly declared in Organization structured data and keeps other website icons and preview images as separate candidates.
A logo represents the organization, while a favicon is a small website icon. The API reports them separately so your application can choose the right asset.
No. The API returns the original public asset URLs and their provenance. Your application remains responsible for permitted use, caching, and presentation.
The logo field remains null. Other declared icons or preview images can still appear as separate candidates without being mislabeled as logos.
Yes. Send up to 10 domains to the bulk endpoint. Results preserve input order and individual failures do not hide successful items.
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 Website Identity Data