Web Page Reader API

API ID 14966

Turn a public web page into clean Markdown, metadata, links or an SEO report. Honours robots.txt.

100% uptime 10,012 ms avg response

API Documentation

Endpoints

Request
Convert a web page to clean Markdown. Fetches the page, removes navigation, ads and boilerplate, and returns the main content as Markdown, ready to pass to a language model. JavaScript is not executed, so pages that render entirely in the browser return little content.
Endpoint ID: 39299
GET https://zylalabs.com/api/14966/web+page+reader+api/39299/convert+a+web+page+to+clean+markdown
INPUT PARAMETERS

Convert a web page to clean Markdown — Endpoint Features

Object Description
url Required Full page URL, starting with http:// or https://.
format Optional markdown or text.
include_links Optional Keep hyperlinks in the Markdown.
include_images Optional Keep image references in the Markdown.
include_tables Optional The include tables to use.
main_content_only Optional Drop navigation, footers and sidebars. Set false to keep more of the page.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
format
include_links
include_images
include_tables
main_content_only
API EXAMPLE RESPONSE
JSON
{
    "url": "https://example.com/",
    "title": "Example Domain",
    "author": null,
    "published": null,
    "site_name": "example.com",
    "description": null,
    "language": "en",
    "format": "markdown",
    "content": "This domain is for use in documentation examples without needing permission. This is not a service; avoid relying on it for testing and monitoring purposes.",
    "word_count": 25,
    "characters": 156,
    "empty": false,
    "fetched_in_ms": 64
}
Convert a web page to clean Markdown — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/14966/web+page+reader+api/39299/convert+a+web+page+to+clean+markdown?url=https://example.com/&format=markdown&include_links=true&include_images=false&include_tables=true&main_content_only=true' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
Link preview: title, description, image and Open Graph data. Everything needed to render a link preview card, plus the page's raw Open Graph, Twitter card and structured-data types.
Endpoint ID: 39300
GET https://zylalabs.com/api/14966/web+page+reader+api/39300/link+preview+metadata+and+open+graph+data
INPUT PARAMETERS

Link preview metadata and Open Graph data — Endpoint Features

Object Description
url Required Full page URL, starting with http:// or https://.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
API EXAMPLE RESPONSE
JSON
{
    "url": "https://example.com/",
    "title": "Example Domain",
    "description": null,
    "image": null,
    "site_name": null,
    "type": null,
    "author": null,
    "published": null,
    "language": "en",
    "canonical": null,
    "favicon": "data:,",
    "theme_color": null,
    "twitter_card": null,
    "open_graph": [],
    "twitter": [],
    "structured_data_types": [],
    "status": 200,
    "redirected_from": []
}
Link preview metadata and Open Graph data — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/14966/web+page+reader+api/39300/link+preview+metadata+and+open+graph+data?url=https://example.com/' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
List the links on a page. Returns JSON from the Web Page Reader API.
Endpoint ID: 39301
GET https://zylalabs.com/api/14966/web+page+reader+api/39301/list+the+links+on+a+page
INPUT PARAMETERS

List the links on a page — Endpoint Features

Object Description
url Required Full page URL, starting with http:// or https://.
scope Optional The scope to use.
limit Optional The limit to use.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
scope
limit
API EXAMPLE RESPONSE
JSON
{
    "url": "https://example.com/",
    "total": 0,
    "internal": 0,
    "external": 0,
    "links": []
}
List the links on a page — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/14966/web+page+reader+api/39301/list+the+links+on+a+page?url=https://example.com/&scope=all&limit=200' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
On-page SEO audit. Checks the title, meta description, headings, images, canonical link, indexability, mobile viewport, structured data and social tags of one page, and returns a pass / warn / fail list with a score.
Endpoint ID: 39302
GET https://zylalabs.com/api/14966/web+page+reader+api/39302/on-page+seo+audit
INPUT PARAMETERS

On-page SEO audit — Endpoint Features

Object Description
url Required Full page URL, starting with http:// or https://.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
API EXAMPLE RESPONSE
JSON
{
    "url": "https://example.com/",
    "status": 200,
    "score": 65,
    "title": "Example Domain",
    "meta_description": null,
    "h1": [],
    "headings": {
        "h1": 0,
        "h2": 0,
        "h3": 0,
        "h4": 0,
        "h5": 0,
        "h6": 0
    },
    "canonical": null,
    "robots_meta": null,
    "word_count": 26,
    "images": 0,
    "images_without_alt": 0,
    "html_bytes": 577,
    "response_ms": 64,
    "redirects": [],
    "checks": [
        {
            "check": "title",
            "status": "warn",
            "detail": "14 characters (15 to 60 is the usual target)."
        },
        {
            "check": "meta_description",
            "status": "fail",
            "detail": "Missing meta description."
        },
        {
            "check": "h1",
            "status": "fail",
            "detail": "0 <h1> heading(s); one is expected."
        }
    ],
    "note": "Checks the HTML as delivered; content added by JavaScript is not seen."
}
On-page SEO audit — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/14966/web+page+reader+api/39302/on-page+seo+audit?url=https://example.com/' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
Read a site's robots.txt and test a URL against it
Endpoint ID: 39303
GET https://zylalabs.com/api/14966/web+page+reader+api/39303/read+robots+rules+and+test+a+url+against+them
INPUT PARAMETERS

Read robots rules and test a URL against them — Endpoint Features

Object Description
url Required Full page URL, starting with http:// or https://.
user_agent Optional Crawler name to test, for example Googlebot or GPTBot.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
user_agent
API EXAMPLE RESPONSE
JSON
{
    "host": "example.com",
    "has_robots_txt": false,
    "allowed": true,
    "user_agent": "*",
    "sitemaps": [],
    "crawl_delay": null
}
Read robots rules and test a URL against them — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/14966/web+page+reader+api/39303/read+robots+rules+and+test+a+url+against+them?url=https://example.com/&user_agent=*' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
Parse an XML sitemap. Returns the URLs in a sitemap with last-modified dates, or the child sitemaps when it is a sitemap index. Gzipped sitemaps are supported.
Endpoint ID: 39304
GET https://zylalabs.com/api/14966/web+page+reader+api/39304/parse+an+xml+sitemap
INPUT PARAMETERS

Parse an XML sitemap — Endpoint Features

Object Description
url Required Sitemap URL, or a site URL to discover its sitemap from robots.txt.
limit Optional The limit to use.
offset Optional The offset to use.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
limit
offset
API EXAMPLE RESPONSE
JSON
{
    "sitemap": "https://www.sitemaps.org/sitemap.xml",
    "type": "urls",
    "total": 84,
    "offset": 0,
    "entries": [
        {
            "url": "https://www.sitemaps.org/",
            "last_modified": "2016-11-21"
        },
        {
            "url": "https://www.sitemaps.org/protocol.html",
            "last_modified": "2022-12-15"
        },
        {
            "url": "https://www.sitemaps.org/faq.html",
            "last_modified": "2016-11-21"
        }
    ]
}
Parse an XML sitemap — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/14966/web+page+reader+api/39304/parse+an+xml+sitemap?url=https://www.sitemaps.org/sitemap.xml&limit=500&offset=Optional' --header 'Authorization: Bearer YOUR_API_KEY' 


    

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 Web Page Reader 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.

Starts at
$10,000/Year


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

Overview

Turn a public web page into clean Markdown, metadata, links or an SEO report. Honours robots.txt.

Web Page Reader API FAQs

Fetches the page you name. The fetcher identifies itself and honours robots.txt.

JavaScript is not run, so pages built in the browser return little. Sites that block bots or disallow crawlers in robots.txt return an error instead of content. Pages over 3 MB, non-standard ports and non-public addresses are refused. You are responsible for your right to use the content you fetch.

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