API reference

Unified URL Intelligence API

Extract normalized page metadata, preview fields, structured data, and public identity signals from a URL. Use this reference to choose an operation and integrate its documented response contract.

Operations

GET /v1/url-intelligence View API reference
POST /v1/url-intelligence/bulk View API reference

GET /v1/url-intelligence

Operation: getUrlIntelligence Credits and authentication: 2 Authentication required
GET /v1/url-intelligence

Query Parameters

Parameter Type required
url string required
skip_cache string
Allowed values 1
optional

Response Fields

Field Type
requested_url string
final_url string
status integer
fetch_state string
content_type string | null
redirects integer
title string | null
description string | null
canonical_url string | null
language string | null
favicon_url string | null
preview_image_url string | null
manifest_url string | null
theme_color string | null
open_graph object
twitter_card object
structured_data object
structured_data.types[] string[]
structured_data.items integer
structured_data.parse_errors integer
robots object
robots.meta[] string[]
robots.header[] string[]
robots.indexable boolean | null
security_headers object
links object
links.total integer
links.internal integer
links.external integer
social_profiles[] object[]
social_profiles[] object
social_profiles[].platform string
social_profiles[].type string
social_profiles[].handle string | null
social_profiles[].url string
social_profiles[].source string
social_profiles[].confidence string
contacts object
contacts.emails[] string[]
contacts.phones[] string[]
meta object
meta.checked_at string
meta.cached boolean
meta.fetch_transport string

Example Request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/url-intelligence?url=https%3A%2F%2Fexample.com&skip_cache=example.com"

Example Response

{
  "requested_url": "https://example.com",
  "final_url": "https://example.com",
  "status": 1,
  "fetch_state": "ok",
  "content_type": "string",
  "redirects": 1,
  "title": "string",
  "description": "198.51.100.10",
  "canonical_url": "https://example.com",
  "language": "string",
  "favicon_url": "https://example.com",
  "preview_image_url": "https://example.com",
  "manifest_url": "https://example.com",
  "theme_color": "string",
  "open_graph": {},
  "twitter_card": {},
  "structured_data": {
    "types": [
      "string"
    ],
    "items": 1,
    "parse_errors": 1
  },
  "robots": {
    "meta": [
      "string"
    ],
    "header": [
      "string"
    ],
    "indexable": true
  },
  "security_headers": {},
  "links": {
    "total": 1,
    "internal": 1,
    "external": 1
  },
  "social_profiles": [
    {
      "platform": "github",
      "type": "social",
      "handle": "example",
      "url": "https://example.com",
      "source": "same_as",
      "confidence": "high"
    }
  ],
  "contacts": {
    "emails": [
      "[email protected]"
    ],
    "phones": [
      "string"
    ]
  },
  "meta": {
    "checked_at": "2026-04-15T12:00:00Z",
    "cached": true,
    "fetch_transport": "worker"
  }
}

POST /v1/url-intelligence/bulk

Operation: bulkGetUrlIntelligence Credits and authentication: 2 Authentication required
POST /v1/url-intelligence/bulk

Body Parameters

Parameter Type required
urls string[] required

Response Fields

Field Type
results[] object[]
results[] object
results[].input string
results[].data object
results[].error object
results[].error.error object
results[].error.error.code string
results[].error.error.message string
results[].error.error.suggestion string
results[].error.error.details object
results[].error.error.retry_after integer
results[].error.error.docs_url string
meta object
meta.total integer
meta.succeeded integer
meta.failed integer
meta.max_items integer
meta.credits_per_item integer
meta.duration_ms integer

Example Request

curl -X POST "https://domscan.net/v1/url-intelligence/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $DOMSCAN_API_KEY" \
  -d '{
  "urls": [
    "https://example.com",
    "https://github.com/about"
  ]
}'

Example Response

{
  "results": [
    {
      "input": "string",
      "data": {},
      "error": {
        "error": {
          "code": "INVALID_DOMAIN",
          "message": "Invalid domain format",
          "suggestion": "string",
          "details": {},
          "retry_after": 300,
          "docs_url": "/docs#parameters"
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "succeeded": 1,
    "failed": 1,
    "max_items": 10,
    "credits_per_item": 2,
    "duration_ms": 1
  }
}

Reference resources