▣ DATA EXTRACTION · SEO

Extract Structured Data API

What it does

Structured Data Extractor checks a website URL and returns the structured data it finds on the page. Send a url, and you get back the same url, a schemaCount, booleans for hasBreadcrumbs and hasOrganization, and a structuredData array containing the parsed objects.

Use it when you need to inspect a site’s schema markup for SEO audits, content validation, or competitive analysis. It gives you a quick way to confirm whether a page exposes breadcrumb data or organization markup without parsing HTML yourself.

The response is compact and easy to consume in automation pipelines. You can use schemaCount to spot pages with no structured data, branch on hasBreadcrumbs for navigation-rich pages, or process the structuredData array directly when you need the underlying objects.

Structured Data Extractor is a good fit for crawlers, SEO tooling, and internal QA checks where you need a simple structured-data snapshot from a webpage.

POST

Extract structured data from a website

http://localhost:8080/namastesumalya/extract-structured-data

QUICKSTARTGUIDE

Quickstart

Send the page URL to extract its structured data.

curl -X POST "http://localhost:8080/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 the website at the given URL and returns a JSON object summarizing what was found, including the source url, counts/flags, and the extracted structuredData array.

Request Body

Parameter	Type	Mandatory	Description
url	String	Yes	The website URL to extract structured data from.

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 source URL processed by the endpoint.
schemaCount	Integer	No	The number of structured data items found.
hasBreadcrumbs	Boolean	No	Indicates whether breadcrumb structured data was found.
structuredData	Object Array	No	The extracted structured data objects returned from the website.
hasOrganization	Boolean	No	Indicates whether organization structured data was found.

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.