▣ DATA EXTRACTION · DEVELOPER TOOLS

Extract Structured Data API

What it does

Structured Data Extractor pulls schema-related metadata from a website when you send a URL. It returns the page URL, a schemaCount, booleans for hasBreadcrumbs and hasOrganization, and a structuredData array containing the structured data objects found on the page.

Use it when you need to audit a site for JSON-LD or other structured-data signals without building your own crawler. A single request can tell you whether a page exposes breadcrumbs or organization markup, and how much structured data is present overall. That makes it useful for SEO checks, content QA, and automated site analysis.

The response is straightforward to consume in downstream workflows: compare pages, flag missing schema on key templates, or feed the extracted objects into your own validation and reporting pipeline. If you are checking a site migration or monitoring structured-data coverage at scale, this gives you the page-level data you need in a compact format.

POST

Extract structured data from a website

https://api.eu.apyverse.com/namastesumalya/extract-structured-data

QUICKSTART

GUIDE

Quickstart

Send a webpage URL to extract any structured data found on it.

curl -X POST "https://api.eu.apyverse.com/namastesumalya/extract-structured-data" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://schema.org"}'

What you'll get back

Returns a JSON object with these top-level fields: url string, schemaCount integer, hasBreadcrumbs boolean, structuredData array of objects, and hasOrganization boolean.

{
  "url": "https://schema.org",
  "schemaCount": 1,
  "hasBreadcrumbs": false,
  "structuredData": [
    {
      "url": "https://schema.org",
      "name": "Schema.org",
      "@type": "WebSite",
      "@context": "https://schema.org"
    }
  ],
  "hasOrganization": false
}

TRY ITLIVE · 100 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Extracts structured data from a website given its URL and returns a JSON object describing what was found. The response includes the analyzed url, counts and flags for detected structured data, and a structuredData array of objects.

Request Body

Parameter	Type	Mandatory	Description
url	String	Yes	The website URL to analyze.

Response

Returns a JSON object with url as a string, schemaCount as an integer, hasBreadcrumbs as a boolean, structuredData as an array of objects, and hasOrganization as a boolean.

Parameter	Type	Mandatory	Description
url	String	No	The analyzed website URL.
schemaCount	Integer	No	The number of structured data items found.
hasBreadcrumbs	Boolean	No	Indicates whether breadcrumb structured data was detected.
structuredData	Object Array	No	The structured data objects extracted from the website.
hasOrganization	Boolean	No	Indicates whether organization structured data was detected.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.