Structured Data Validator API

API ID 13845

The Structured Data Validator API enables users to validate JSON-LD documents against schema.org standards, ensuring compliance with rich-result support.

API Documentation

Endpoints

Request
This endpoint allows users to submit a JSON-LD document for validation against schema.org standards. It checks the document for compliance with required and recommended properties, ensuring that the structured data is correctly formatted for rich results in search engines. Users can utilize this endpoint to identify issues such as missing properties, incorrect data types, or invalid formats. The response will include a detailed report of any validation errors found, making it easier for developers and SEO specialists to optimize their structured data for better visibility and performance in search engine results.
Endpoint ID: 31835
POST https://zylalabs.com/api/13845/structured+data+validator+api/31835/validate+json-ld+document
INPUT PARAMETERS

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

This endpoint does not require any input parameters.

API EXAMPLE RESPONSE
JSON
[
    {
        "value": 200
    }
]
Validate json-ld document — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13845/structured+data+validator+api/31835/validate+json-ld+document' --header 'Authorization: Bearer YOUR_API_KEY' --header 'Content-Type: application/json' --data-raw '{}'

Request
This endpoint provides users with a comprehensive list of schema.org types that can be used in JSON-LD documents. It serves as a reference for developers and content creators looking to implement structured data in their web pages. By accessing this endpoint, users can retrieve information about various schema types, including their properties and relationships. This functionality is particularly useful for ensuring that the structured data aligns with the latest schema.org standards and for discovering new types that may enhance the richness of their content. The output will be a structured list of schema types along with their associated properties.
Endpoint ID: 31836
GET https://zylalabs.com/api/13845/structured+data+validator+api/31836/get+schema.org+types
INPUT PARAMETERS

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

This endpoint does not require any input parameters.

API EXAMPLE RESPONSE
JSON
[
    {
        "types": [
            {
                "type": "Article",
                "properties": {
                    "headline": "string",
                    "author": "object"
                }
            },
            {
                "type": "Pers",
                "properties": []
            }
        ]
    }
]
Get schema.org types — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/13845/structured+data+validator+api/31836/get+schema.org+types' --header 'Authorization: Bearer YOUR_API_KEY' --header 'Content-Type: application/json' --data-raw '{}'

API Access Key & Authentication

After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Structured Data Validator API simply include your bearer token in the Authorization header.

Headers
Header Description
Authorization Required Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Overview

The Structured Data Validator API is specifically designed for validating JSON-LD structured data documents in accordance with schema.org standards. This API processes various types of structured data fields, including articles, events, products, and more, by checking for required and recommended properties as defined by schema.org. It utilizes domain-specific terminology such as 'JSON-LD', 'schema.org types', and 'rich results', which are crucial for web developers and SEO specialists aiming to enhance their content's visibility in search engines. The API requires users to submit valid JSON-LD documents, and it performs comprehensive checks to identify issues by path, ensuring that the data adheres to the expected formats for dates, durations, currencies, and nested entities. The output is structured in a clear format that lists all identified issues, making it easy for users to rectify errors. This API is essential for anyone looking to optimize their structured data for better search engine performance.

Structured Data Validator API FAQs

The POST endpoint returns a validation report for submitted JSON-LD documents, detailing compliance with schema.org standards. The GET endpoint returns a structured list of schema.org types, including their properties and relationships, serving as a reference for developers.

The POST endpoint returns a validation report for submitted JSON-LD documents, detailing compliance with schema.org standards. The GET endpoint returns a structured list of schema.org types, including their properties and relationships, useful for implementing structured data.

For the POST endpoint, key fields include validation status and error details. For the GET endpoint, key fields include "type" (the schema type) and "properties" (the attributes associated with that type).

The POST endpoint response includes fields indicating validation status and errors, while the GET endpoint response includes fields for "type" and "properties" of schema.org types, providing essential information for structured data implementation.

The POST endpoint returns a JSON object with validation results, while the GET endpoint returns a JSON array of schema types, each containing a "type" and its associated "properties" in a structured format.

The POST endpoint organizes its response as an array of validation results, each detailing specific issues found in the JSON-LD document. The GET endpoint organizes its response as an array of schema types, each containing a "type" and its associated "properties."

The POST endpoint provides information on validation errors for JSON-LD documents, such as missing properties or incorrect formats. The GET endpoint offers a comprehensive list of schema.org types, including their properties and relationships for structured data.

The POST endpoint provides validation results for JSON-LD documents, identifying issues like missing properties. The GET endpoint offers a comprehensive list of schema.org types, including their properties and relationships for structured data implementation.

Typical use cases include validating structured data for SEO optimization, ensuring compliance with schema.org standards, and referencing schema types to enhance content visibility in search engines.

Users can customize their requests to the POST endpoint by submitting different JSON-LD documents for validation. For the GET endpoint, users can specify queries to retrieve specific schema.org types or properties based on their structured data needs.

Users can customize requests to the POST endpoint by submitting different JSON-LD documents for validation. The GET endpoint does not require parameters, as it returns all available schema types.

Data accuracy is maintained by adhering to the latest schema.org standards and performing comprehensive checks on JSON-LD documents. The API identifies issues by path, ensuring that users can rectify errors effectively.

Data accuracy is maintained through adherence to schema.org standards and comprehensive validation checks performed by the API, ensuring that the structured data meets required formats and properties.

Users can expect standard data patterns such as required properties for schema types, correct data formats for dates and currencies, and nested entities. The API's validation checks help ensure these patterns are followed in submitted JSON-LD documents.

General FAQs

To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.

You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.

The free trial lasts for 7 days and allows you to make up to 50 API requests.

No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.

Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.

Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

You can monitor your API usage through the response headers included with every request:

x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.

Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs