Structured data
GET /api/v1/structured-data
Pull every piece of structured data off a page — JSON-LD, Microdata and Open Graph — parsed into schema types and fields, with validation messages flagging missing required properties.
Query parameters
| Name | Type | Description |
|---|---|---|
url required | string | The page to parse. |
validate optional | boolean | Run schema.org validation and return errors/warnings. Default: true. |
Request
Response
200 · application/json
- {
- "url": "https://example.com",
- "summary": {
- "count": 2,
- "formats": { "jsonLd": 1, "microdata": 1 },
- "detectedTypes": ["Organization", "BreadcrumbList"]
- },
- "items": [
- {
- "format": "json_ld",
- "types": ["Organization"],
- "fields": { "@context": "https://schema.org", "@type": "Organization", "name": "Example", "url": "https://example.com" }
- },
- {
- "format": "microdata",
- "types": ["BreadcrumbList"],
- "fields": { "name": "Home", "item": "https://example.com/" }
- }
- ],
- "openGraph": { "title": "Example", "description": "An example site", "type": "website" }
- }
Response fields
| Field | Type | Description |
|---|---|---|
summary.count | integer | Total structured-data blocks found. |
summary.formats | object | Counts by format: jsonLd and microdata. |
summary.detectedTypes | string[] | Every schema.org type found across all blocks, deduped (e.g. Organization, Product, FAQPage, BreadcrumbList). |
items[].format | string | json_ld or microdata. |
items[].types | string[] | schema.org @type values in the block. |
items[].fields | object | The parsed properties — the full JSON-LD object, or the itemprop name/value map for microdata. |
openGraph | object | Parsed Open Graph (og:*) tags as a key/value map. |
See Errors for status codes.