Developer Reference

Portfolio Audit Recipe API Documentation

Portfolio Audit Recipe API Documentation: Audit entire domain portfolios for health, valuation, and optimization opportunities.

Portfolio Audit Recipe

Audit entire domain portfolios for health, valuation, and optimization opportunities.

POST /v1/recipes/portfolio-audit

Request Body

{
                "domains": [
                "domain1.com",
                "domain2.io",
                "domain3.app"
                ]
                }

Response Includes

Health status for each domain
Valuation estimates
Expiration date tracking
SSL certificate status
DNS configuration issues
Portfolio-level insights and recommendations

Response Fields

Field	Type
`success`	boolean
`data`	object
`data.summary`	object
`data.summary.total_domains`	number
`data.summary.total_value_low`	number
`data.summary.total_value_high`	number
`data.summary.average_health_score`	number
`data.summary.expiring_soon`	number
`data.summary.renewal_cost_annual`	number
`data.alerts[]`	object[]
`data.alerts[]`	object
`data.alerts[].domain`	string
`data.alerts[].type`	string
`data.alerts[].severity`	string
`data.alerts[].message`	string
`data.alerts[].action`	string
`data.optimization`	object
`data.optimization.registrar_consolidation`	object
`data.optimization.registrar_consolidation.current_registrars`	number
`data.optimization.registrar_consolidation.recommendation`	string
`data.optimization.registrar_consolidation.potential_savings`	number
`data.optimization.underperforming[]`	string[]
`data.optimization.top_valuable[]`	string[]
`data.domains[]`	object[]
`data.domains[]`	object
`data.domains[].domain`	string
`data.domains[].status`	string
`data.domains[].value_estimate`	object
`data.domains[].value_estimate.low`	number
`data.domains[].value_estimate.mid`	number
`data.domains[].value_estimate.high`	number
`data.domains[].health_score`	number
`data.domains[].health_grade`	string
`data.domains[].expiry_date`	string
`data.domains[].days_until_expiry`	number
`data.domains[].renewal_price`	number
`data.domains[].issues[]`	array
`meta`	object
`meta.recipe_name`	string
`meta.credits_used`	number
`meta.credits_saved`	number
`meta.duration_ms`	number
`meta.components_called[]`	string[]
`meta.cached_components[]`	string[]
`meta.timestamp`	string
`errors[]`	array

Example Response

{
  "success": true,
  "data": {
    "summary": {
      "total_domains": 3,
      "total_value_low": 3200,
      "total_value_high": 12400,
      "average_health_score": 78,
      "expiring_soon": 1,
      "renewal_cost_annual": 98.4
    },
    "alerts": [
      {
        "domain": "brandold.com",
        "type": "expiration",
        "severity": "high",
        "message": "Expires in 12 days.",
        "action": "Renew immediately"
      }
    ],
    "optimization": {
      "registrar_consolidation": {
        "current_registrars": 3,
        "recommendation": "Move long-tail domains to a single low-cost registrar.",
        "potential_savings": 48
      },
      "underperforming": [
        "brandold.com"
      ],
      "top_valuable": [
        "brand.com"
      ]
    },
    "domains": [
      {
        "domain": "brand.com",
        "status": "owned",
        "value_estimate": {
          "low": 2500,
          "mid": 4600,
          "high": 9000
        },
        "health_score": 92,
        "health_grade": "A",
        "expiry_date": "2027-02-01",
        "days_until_expiry": 292,
        "renewal_price": 12.99,
        "issues": []
      }
    ]
  },
  "meta": {
    "recipe_name": "portfolio-audit",
    "credits_used": 20,
    "credits_saved": 280,
    "duration_ms": 1298,
    "components_called": [
      "availability",
      "whois",
      "valuation",
      "health",
      "pricing"
    ],
    "cached_components": [
      "valuation"
    ],
    "timestamp": "2026-04-15T10:31:00Z"
  },
  "errors": []
}

GET /v1/recipes/portfolio-audit

Query Parameters

Parameter	Type	required
domains	string	required
include_valuation	boolean	optional
include_health	boolean	optional
alert_expiring_days	integer	optional

Response Fields

Field	Type
`success`	boolean
`data`	object
`data.summary`	object
`data.summary.total_domains`	number
`data.summary.total_value_low`	number
`data.summary.total_value_high`	number
`data.summary.average_health_score`	number
`data.summary.expiring_soon`	number
`data.summary.renewal_cost_annual`	number
`data.alerts[]`	object[]
`data.alerts[]`	object
`data.alerts[].domain`	string
`data.alerts[].type`	string
`data.alerts[].severity`	string
`data.alerts[].message`	string
`data.alerts[].action`	string
`data.optimization`	object
`data.optimization.registrar_consolidation`	object
`data.optimization.registrar_consolidation.current_registrars`	number
`data.optimization.registrar_consolidation.recommendation`	string
`data.optimization.registrar_consolidation.potential_savings`	number
`data.optimization.underperforming[]`	string[]
`data.optimization.top_valuable[]`	string[]
`data.domains[]`	object[]
`data.domains[]`	object
`data.domains[].domain`	string
`data.domains[].status`	string
`data.domains[].value_estimate`	object
`data.domains[].value_estimate.low`	number
`data.domains[].value_estimate.mid`	number
`data.domains[].value_estimate.high`	number
`data.domains[].health_score`	number
`data.domains[].health_grade`	string
`data.domains[].expiry_date`	string
`data.domains[].days_until_expiry`	number
`data.domains[].renewal_price`	number
`data.domains[].issues[]`	array
`meta`	object
`meta.recipe_name`	string
`meta.credits_used`	number
`meta.credits_saved`	number
`meta.duration_ms`	number
`meta.components_called[]`	string[]
`meta.cached_components[]`	string[]
`meta.timestamp`	string
`errors[]`	array

Example Request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/recipes/portfolio-audit?domains=example.com%2Cexample.net&include_valuation=example.com&include_health=example.com&alert_expiring_days=example.com"

Example Response

{
  "success": true,
  "data": {
    "summary": {
      "total_domains": 3,
      "total_value_low": 3200,
      "total_value_high": 12400,
      "average_health_score": 78,
      "expiring_soon": 1,
      "renewal_cost_annual": 98.4
    },
    "alerts": [
      {
        "domain": "brandold.com",
        "type": "expiration",
        "severity": "high",
        "message": "Expires in 12 days.",
        "action": "Renew immediately"
      }
    ],
    "optimization": {
      "registrar_consolidation": {
        "current_registrars": 3,
        "recommendation": "Move long-tail domains to a single low-cost registrar.",
        "potential_savings": 48
      },
      "underperforming": [
        "brandold.com"
      ],
      "top_valuable": [
        "brand.com"
      ]
    },
    "domains": [
      {
        "domain": "brand.com",
        "status": "owned",
        "value_estimate": {
          "low": 2500,
          "mid": 4600,
          "high": 9000
        },
        "health_score": 92,
        "health_grade": "A",
        "expiry_date": "2027-02-01",
        "days_until_expiry": 292,
        "renewal_price": 12.99,
        "issues": []
      }
    ]
  },
  "meta": {
    "recipe_name": "portfolio-audit",
    "credits_used": 20,
    "credits_saved": 280,
    "duration_ms": 1298,
    "components_called": [
      "availability",
      "whois",
      "valuation",
      "health",
      "pricing"
    ],
    "cached_components": [
      "valuation"
    ],
    "timestamp": "2026-04-15T10:31:00Z"
  },
  "errors": []
}