Structured Data Validator
Extract and validate structured data (JSON-LD, Microdata, RDFa) from a web page
Parameters
| name | in | type | required | description |
|---|---|---|---|---|
url |
query | string | required | URL of the page to check for structured data |
Request
Send your key in the X-API-Key header. More languages and patterns live on the
code examples page.
curl -s "https://apixies.io/api/v1/validate-structured-data?url=https%3A%2F%2Fexample.com" \ -H "X-API-Key: YOUR_API_KEY"
Response
The result sits under data in the standard envelope. See the
response format guide for errors and status codes.
returns
- data.items
- Each item with its format, type, properties, warnings and errors.
- data.summary
- Types found, error and warning totals, and formats present.
- data.has_structured_data
- True when the page has any structured data.
- data.formats_found
- Formats detected, like json-ld or microdata.
- data.total_items
- Number of items extracted.
{
"status": "success",
"http_code": 200,
"code": "SUCCESS",
"message": "Structured data validation completed",
"data": {
"url": "https://example.com",
"has_structured_data": true,
"formats_found": [
"json-ld"
],
"total_items": 2,
"items": [
{
"format": "json-ld",
"type": "Organization",
"properties": {
"@context": "https://schema.org",
"@type": "Organization",
"name": "Example Corp",
"url": "https://example.com",
"logo": "https://example.com/logo.png",
"sameAs": [
"https://github.com/example"
]
},
"warnings": [],
"errors": []
},
{
"format": "json-ld",
"type": "WebSite",
"properties": {
"@context": "https://schema.org",
"@type": "WebSite",
"name": "Example Corp",
"url": "https://example.com"
},
"warnings": [
"Missing recommended property: 'potentialAction' for WebSite (needed for sitelinks search box)"
],
"errors": []
}
],
"summary": {
"types_found": [
"Organization",
"WebSite"
],
"total_errors": 0,
"total_warnings": 1,
"has_json_ld": true,
"has_microdata": false,
"has_rdfa": false
}
}
}
Authentication and limits
This endpoint needs an API key. Use the sandbox ("try it" above) to test it without registering. See the authentication guide for details.
Standard rate limits apply to this endpoint.
related endpoints
More documentation
Get a free API key
A temporary key takes one click and no signup. Register and you get 75 requests/day. Free tier is for development & small projects.