# Schema Markup Generator: JSON-LD for Google Rich Results (`raional/schema-markup-generator`) Actor

Generate valid schema.org JSON-LD structured data for Product, Article, FAQPage, LocalBusiness, Review, Recipe, Event, JobPosting, HowTo, VideoObject, Organization and WebSite — from structured fields, or auto-detected from a page URL. Validated against Google's rich-result requirements.

- **URL**: https://apify.com/raional/schema-markup-generator.md
- **Developed by:** [Raion Al](https://apify.com/raional) (community)
- **Categories:** Developer tools, SEO tools
- **Stats:** 1 total users, 1 monthly users, 100.0% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

from $15.00 / 1,000 schemata

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## Schema Markup Generator: JSON-LD for Google Rich Results

Generate valid **schema.org JSON-LD structured data** ready to paste into your site, or point it at a page URL and it will **auto-detect and generate schema markup** from the page's Open Graph tags. Validated against Google's rich-results requirements, so you know exactly what's missing before you publish.

Great for: **schema markup generator**, **JSON-LD generator**, **structured data**, **Google rich results / rich snippets**, product/article/FAQ schema for SEO, e-commerce catalogs, and content sites.

### Supported types

Product, Article (+ BlogPosting/NewsArticle), FAQPage, LocalBusiness, Organization, BreadcrumbList, Review, Recipe, Event, JobPosting, HowTo, VideoObject, WebSite.

### Two ways to use it

**Mode A: structured input.** Give it `items`: a list of `{ schemaType, fields }` objects. You control every field; the actor validates and emits JSON-LD.

```json
{
  "items": [
    {
      "schemaType": "FAQPage",
      "fields": {
        "faqItems": [
          { "question": "Do you ship internationally?", "answer": "Yes, to over 40 countries." },
          { "question": "What is your return policy?", "answer": "30-day free returns." }
        ]
      }
    }
  ]
}
```

**Mode B: auto-detect from a URL.** Give it `pageUrls`; it reads the page's Open Graph / meta tags and infers Product, Article, or a generic WebPage, then generates the JSON-LD automatically, no fields to fill in.

```json
{ "pageUrls": [{ "url": "https://example.com/blog/my-post" }] }
```

Use both modes in the same run. Only scan pages you own or have permission to analyze.

### Output

One row per item/page:

| Field | Description |
|---|---|
| `schemaType` | The schema.org type generated |
| `jsonLd` | The generated JSON-LD object |
| `scriptTag` | Ready-to-paste `<script type="application/ld+json">` tag |
| `isValid` | `true` if all of Google's required fields were present |
| `missingRequiredFields` | What's missing, if not valid |
| `sourceUrl` | The page it was auto-detected from (Mode B only) |
| `status` | `ok`, `incomplete`, or `error` |

### Field reference (Mode A)

Each type expects a flat `fields` object. Required fields (per Google's rich-results guidelines):

- **Product**: `name`, `image`: plus `description`, `price`, `priceCurrency`, `availability`, `brand`, `sku`, `url`, `ratingValue`, `reviewCount`
- **Article**: `headline`, `image`, `datePublished`, `author`: plus `dateModified`, `description`, `publisherName`, `publisherLogo`, `articleType` (`Article`/`BlogPosting`/`NewsArticle`)
- **FAQPage**: `faqItems` (array of `{question, answer}`)
- **LocalBusiness**: `name`, `streetAddress`, `addressLocality`: plus `telephone`, `openingHours`, `priceRange`, `latitude`/`longitude`
- **Organization**: `name`, `url`: plus `logo`, `sameAs` (social links array)
- **BreadcrumbList**: `crumbs` (array of `{name, url}`)
- **Review**: `itemReviewed`, `authorName`, `ratingValue`: plus `reviewBody`, `bestRating`, `worstRating`
- **Recipe**: `name`, `image`, `ingredients` (array), `instructions` (array): plus `author`, `prepTime`, `cookTime`, `totalTime`
- **Event**: `name`, `startDate`, `locationName`: plus `endDate`, `price`, `organizerName`
- **JobPosting**: `title`, `description`, `datePosted`, `hiringOrgName`, `jobLocality`: plus `salaryMin`/`salaryMax`, `employmentType`
- **HowTo**: `name`, `steps` (array of strings or `{name, text}`)
- **VideoObject**: `name`, `description`, `thumbnailUrl`, `uploadDate`
- **WebSite**: `name`, `url`: plus `searchUrlTemplate` for a sitelinks search box

### Pricing

Billed **per schema generated** (valid or incomplete-but-usable), plus a **$0.02 start fee per run** at the default 4 GB of Actor memory ($0.005 per GB). Beyond the start fee, pages that fail to load or an unsupported `schemaType` are **not charged**.

Each item in the Mode A input box counts as one schema, so clear anything you do not want billed before running.

### FAQ

**How do I add JSON-LD schema to my website?**
Generate the schema here, copy the `scriptTag` output, and paste it inside your page's `<head>`.

**Does this work without knowing all the fields?**
Yes. Point Mode B at your page URL and it auto-detects Product/Article/WebPage schema from your existing meta tags. For richer types like FAQPage or Recipe, use Mode A with structured fields.

**How do I know if my schema is valid for Google rich results?**
Check `isValid` and `missingRequiredFields` in the output. You can also paste the `scriptTag` into [Google's Rich Results Test](https://search.google.com/test/rich-results) to confirm.

**Is this the same as a schema checker/auditor?**
No. Auditors only tell you schema is missing. This generates the actual JSON-LD you need to add.

### Please note

Mode B only reads public meta tags (the same tags social platforms read for link previews). No page content is scraped or stored. Only scan sites you own or have permission to analyze.

Built with [Apify SDK](https://docs.apify.com/sdk/js/) + [Crawlee](https://crawlee.dev/).

# Actor input Schema

## `items` (type: `array`):

Leave this EMPTY unless you want to build schema from fields you type in yourself. Each item here produces one schema and is billed as one, so an item left in this box will show up in your results even if you only meant to scan URLs below.

Supported types: Product, Article, FAQPage, LocalBusiness, Organization, BreadcrumbList, Review, Recipe, Event, JobPosting, HowTo, VideoObject, WebSite.

EXAMPLE ONLY, not included in your run. Copy it, edit the values, and paste it above if you want Mode A:

\[ { "schemaType": "Product", "fields": { "name": "Wireless Mechanical Keyboard", "description": "Compact 65% wireless mechanical keyboard with hot-swappable switches.", "image": "https://example.com/keyboard.jpg", "url": "https://example.com/products/keyboard", "price": "89.99", "priceCurrency": "USD", "availability": "InStock", "brand": "Example Brand", "sku": "KB-65-WL" } } ]

## `pageUrls` (type: `array`):

Mode B: page URLs to scan. The type is inferred (Product, Article, or WebSite/WebPage) from Open Graph meta tags, and JSON-LD is generated automatically. Only scan sites you own or have permission to analyze.

## `outputFormat` (type: `string`):

How to format the generated schema in each result row.

## `renderJs` (type: `boolean`):

Mode B only. Use a full browser to render pages before reading meta tags. Only needed for sites that inject meta tags client-side (rare); most sites render meta tags server-side.

## Actor input object example

```json
{
  "items": [],
  "pageUrls": [],
  "outputFormat": "both",
  "renderJs": false
}
```

# Actor output Schema

## `schemas` (type: `string`):

One dataset row per item or page: schemaType, jsonLd, scriptTag, isValid, missingRequiredFields, sourceUrl, status.

## `summary` (type: `string`):

Counts of schemas generated, valid, and invalid (missing required fields).

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "items": [],
    "pageUrls": []
};

// Run the Actor and wait for it to finish
const run = await client.actor("raional/schema-markup-generator").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "items": [],
    "pageUrls": [],
}

# Run the Actor and wait for it to finish
run = client.actor("raional/schema-markup-generator").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "items": [],
  "pageUrls": []
}' |
apify call raional/schema-markup-generator --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,raional/schema-markup-generator"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/qIqDE4iHLPQQRu1XA/builds/5toFpIgfaixOV7Kp3/openapi.json