Web Data

Structured data validation API

Extract every JSON-LD, Microdata and RDFa item from a page and validate it against schema.org property rules for the most common rich result types. Get errors, warnings and the exact property that needs fixing.

View documentation Try the free tool Explore all APIs

Endpoints Active

GET /v1/structured-data

Example request

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/structured-data?url=example.com/shoes/trail-runner"

Example response 200 OK

{
  "status": "ok",
  "summary": { "json_ld": 2, "microdata": 1, "rdfa": 0, "total_items": 9, "errors": 1, "warnings": 5 },
  "types": ["AggregateRating", "BreadcrumbList", "ListItem", "Offer", "Product", "Review"],
  "items": [
    {
      "format": "json-ld",
      "types": ["Product"],
      "status": "warnings",
      "errors": [],
      "warnings": [{ "
...

Example request GET /v1/structured-data

Key Features 4

Frequently asked questions 4

HTTP status codes 200 / 400 / 401 / 402 / 429

Category Web Data

Endpoints 1

Key Features 4

Frequently asked questions 4

Used by people at these 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

urlrender

Response fields

Example response

statussummarysummary.json_ldsummary.microdatasummary.rdfasummary.total_itemssummary.errorssummary.warningstypesitems

Status coverage

HTTP status codes

200400401402429

Endpoints

GET /v1/structured-data

Credits: 2-6Authentication: Authentication required

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

Three formats

JSON-LD blocks with @graph flattened, Microdata items and RDFa items, with nested objects such as offers, ratings and authors kept as children.

Rich result rules

Required and recommended properties for 26 types, including Product, Offer, Article, Organization, LocalBusiness, BreadcrumbList, FAQPage, Event, Recipe, VideoObject and JobPosting.

Value checks

Dates, prices, ratings and URLs are checked for format, and invalid JSON or a non schema.org context is reported for the whole block.

Rendered markup

Set render=true to read structured data that tag managers or JavaScript frameworks inject after the page loads.

Example request

GET /v1/structured-data?url=example.com/shoes/trail-runner bash

curl -H "X-API-Key: $DOMSCAN_API_KEY" "https://domscan.net/v1/structured-data?url=example.com/shoes/trail-runner"

Example response

200 OK json

{
  "status": "ok",
  "summary": { "json_ld": 2, "microdata": 1, "rdfa": 0, "total_items": 9, "errors": 1, "warnings": 5 },
  "types": ["AggregateRating", "BreadcrumbList", "ListItem", "Offer", "Product", "Review"],
  "items": [
    {
      "format": "json-ld",
      "types": ["Product"],
      "status": "warnings",
      "errors": [],
      "warnings": [{ "code": "missing_recommended", "property": "description" }]
    }
  ]
}

Frequently asked questions

Is this the same as a rich results eligibility test?

No. It checks markup against published schema.org property rules. Search engines decide eligibility with their own policies and quality signals, so a valid item is not a guarantee of a rich result.

What happens with types that have no rules?

They are still extracted with all their properties and returned with status unchecked, so you can see them without false errors.

Can I see the property values?

Yes. Every item lists its properties and a preview of the first 200 characters of each text value.

How many credits does it cost?

Two credits for raw HTML and six credits with render=true. Results that end in status unknown are refunded.

Related tools and resources

HTTP status codes

These are the HTTP status codes to handle, so you can tell apart successful responses, auth issues, credits, rate limits, missing data, and upstream failures.

OK 200

Request successful

Bad Request 400

Invalid parameters

Unauthorized 401

Missing or invalid API key/session.

Payment Required 402

Not enough credits to run this request.

Too Many Requests 429

Rate limit exceeded

Validate structured data

Start free View documentation Try the free tool