# 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:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 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/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases.
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.

In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md):

```bash
npm install apify-client
```

In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md):

```bash
pip install apify-client
```

In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md):

````bash
# MacOS / Linux
curl -fsSL https://apify.com/install-cli.sh | bash
# Windows
irm https://apify.com/install-cli.ps1 | iex
```bash

In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md).

If your project is in a different language, use 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). Pages that fail to load or an unsupported `schemaType` are **not charged**.

### 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`):

Mode A — a list of { "schemaType": "Product", "fields": { ... } } objects. Supported types: Product, Article, FAQPage, LocalBusiness, Organization, BreadcrumbList, Review, Recipe, Event, JobPosting, HowTo, VideoObject, WebSite.

## `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": [
    {
      "schemaType": "Product",
      "fields": {
        "name": "Wireless Mechanical Keyboard",
        "description": "Compact 65% wireless mechanical keyboard with hot-swappable switches.",
        "image": "https://images.unsplash.com/photo-1587829741301-dc798b83add3",
        "url": "https://example.com/products/keyboard",
        "price": "89.99",
        "priceCurrency": "USD",
        "availability": "InStock",
        "brand": "Example Brand",
        "sku": "KB-65-WL"
      }
    }
  ],
  "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": [
        {
            "schemaType": "Product",
            "fields": {
                "name": "Wireless Mechanical Keyboard",
                "description": "Compact 65% wireless mechanical keyboard with hot-swappable switches.",
                "image": "https://images.unsplash.com/photo-1587829741301-dc798b83add3",
                "url": "https://example.com/products/keyboard",
                "price": "89.99",
                "priceCurrency": "USD",
                "availability": "InStock",
                "brand": "Example Brand",
                "sku": "KB-65-WL"
            }
        }
    ],
    "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": [{
            "schemaType": "Product",
            "fields": {
                "name": "Wireless Mechanical Keyboard",
                "description": "Compact 65% wireless mechanical keyboard with hot-swappable switches.",
                "image": "https://images.unsplash.com/photo-1587829741301-dc798b83add3",
                "url": "https://example.com/products/keyboard",
                "price": "89.99",
                "priceCurrency": "USD",
                "availability": "InStock",
                "brand": "Example Brand",
                "sku": "KB-65-WL",
            },
        }],
    "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("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).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": [
    {
      "schemaType": "Product",
      "fields": {
        "name": "Wireless Mechanical Keyboard",
        "description": "Compact 65% wireless mechanical keyboard with hot-swappable switches.",
        "image": "https://images.unsplash.com/photo-1587829741301-dc798b83add3",
        "url": "https://example.com/products/keyboard",
        "price": "89.99",
        "priceCurrency": "USD",
        "availability": "InStock",
        "brand": "Example Brand",
        "sku": "KB-65-WL"
      }
    }
  ],
  "pageUrls": []
}' |
apify call raional/schema-markup-generator --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=raional/schema-markup-generator",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

```json
{
    "openapi": "3.0.1",
    "info": {
        "title": "Schema Markup Generator: JSON-LD for Google Rich Results",
        "description": "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.",
        "version": "0.1",
        "x-build-id": "NFwOEoj0xs7aITJ5d"
    },
    "servers": [
        {
            "url": "https://api.apify.com/v2"
        }
    ],
    "paths": {
        "/acts/raional~schema-markup-generator/run-sync-get-dataset-items": {
            "post": {
                "operationId": "run-sync-get-dataset-items-raional-schema-markup-generator",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        },
        "/acts/raional~schema-markup-generator/runs": {
            "post": {
                "operationId": "runs-sync-raional-schema-markup-generator",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor and returns information about the initiated run in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/runsResponseSchema"
                                }
                            }
                        }
                    }
                }
            }
        },
        "/acts/raional~schema-markup-generator/run-sync": {
            "post": {
                "operationId": "run-sync-raional-schema-markup-generator",
                "x-openai-isConsequential": false,
                "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
                "tags": [
                    "Run Actor"
                ],
                "requestBody": {
                    "required": true,
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/inputSchema"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "token",
                        "in": "query",
                        "required": true,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Enter your Apify token here"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "OK"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "inputSchema": {
                "type": "object",
                "properties": {
                    "items": {
                        "title": "Structured items to generate",
                        "type": "array",
                        "description": "Mode A — a list of { \"schemaType\": \"Product\", \"fields\": { ... } } objects. Supported types: Product, Article, FAQPage, LocalBusiness, Organization, BreadcrumbList, Review, Recipe, Event, JobPosting, HowTo, VideoObject, WebSite."
                    },
                    "pageUrls": {
                        "title": "Page URLs to auto-detect schema from",
                        "type": "array",
                        "description": "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.",
                        "items": {
                            "type": "object",
                            "required": [
                                "url"
                            ],
                            "properties": {
                                "url": {
                                    "type": "string",
                                    "title": "URL of a web page",
                                    "format": "uri"
                                }
                            }
                        }
                    },
                    "outputFormat": {
                        "title": "Output format",
                        "enum": [
                            "jsonld",
                            "scriptTag",
                            "both"
                        ],
                        "type": "string",
                        "description": "How to format the generated schema in each result row.",
                        "default": "both"
                    },
                    "renderJs": {
                        "title": "Render JavaScript (advanced)",
                        "type": "boolean",
                        "description": "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.",
                        "default": false
                    }
                }
            },
            "runsResponseSchema": {
                "type": "object",
                "properties": {
                    "data": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "type": "string"
                            },
                            "actId": {
                                "type": "string"
                            },
                            "userId": {
                                "type": "string"
                            },
                            "startedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "finishedAt": {
                                "type": "string",
                                "format": "date-time",
                                "example": "2025-01-08T00:00:00.000Z"
                            },
                            "status": {
                                "type": "string",
                                "example": "READY"
                            },
                            "meta": {
                                "type": "object",
                                "properties": {
                                    "origin": {
                                        "type": "string",
                                        "example": "API"
                                    },
                                    "userAgent": {
                                        "type": "string"
                                    }
                                }
                            },
                            "stats": {
                                "type": "object",
                                "properties": {
                                    "inputBodyLen": {
                                        "type": "integer",
                                        "example": 2000
                                    },
                                    "rebootCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "restartCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "resurrectCount": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "computeUnits": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "options": {
                                "type": "object",
                                "properties": {
                                    "build": {
                                        "type": "string",
                                        "example": "latest"
                                    },
                                    "timeoutSecs": {
                                        "type": "integer",
                                        "example": 300
                                    },
                                    "memoryMbytes": {
                                        "type": "integer",
                                        "example": 1024
                                    },
                                    "diskMbytes": {
                                        "type": "integer",
                                        "example": 2048
                                    }
                                }
                            },
                            "buildId": {
                                "type": "string"
                            },
                            "defaultKeyValueStoreId": {
                                "type": "string"
                            },
                            "defaultDatasetId": {
                                "type": "string"
                            },
                            "defaultRequestQueueId": {
                                "type": "string"
                            },
                            "buildNumber": {
                                "type": "string",
                                "example": "1.0.0"
                            },
                            "containerUrl": {
                                "type": "string"
                            },
                            "usage": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "integer",
                                        "example": 1
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            },
                            "usageTotalUsd": {
                                "type": "number",
                                "example": 0.00005
                            },
                            "usageUsd": {
                                "type": "object",
                                "properties": {
                                    "ACTOR_COMPUTE_UNITS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATASET_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "KEY_VALUE_STORE_WRITES": {
                                        "type": "number",
                                        "example": 0.00005
                                    },
                                    "KEY_VALUE_STORE_LISTS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_READS": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "REQUEST_QUEUE_WRITES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_INTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "DATA_TRANSFER_EXTERNAL_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                                        "type": "integer",
                                        "example": 0
                                    },
                                    "PROXY_SERPS": {
                                        "type": "integer",
                                        "example": 0
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}
```