Site Crawler and Sitemap API

API ID 15233

Polite same-site crawl plus sitemap parsing, with broken internal links called out.

API Documentation

Endpoints

Request
Crawl a public site breadth-first, respect robots.txt, and return page statuses plus broken internal links.
Endpoint ID: 40757
GET https://zylalabs.com/api/15233/site+crawler+and+sitemap+api/40757/crawl+a+site
INPUT PARAMETERS

Crawl a site — Endpoint Features

Object Description
url Required Crawl start. Only http and https. A bare host is treated as https.
max_pages Optional Maximum HTML pages to fetch. Default 50. Hard maximum 200.
max_depth Optional Link depth from the start URL. The start page is depth 0. Default 3, maximum 8.
same_host_only Optional Stay on the start host. www and the apex count as the same host. Default true.
check_external Optional Probe off-site links. They are classified, not crawled. Default false.
include_sitemap Optional Parse the sitemap and list URLs that no crawled page linked to. Default false.
refresh Optional Ignore the cached crawl report. Default false.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
max_pages
max_depth
same_host_only
check_external
include_sitemap
refresh
API EXAMPLE RESPONSE
JSON
{
    "url": "https://example.com/",
    "final_url": "https://example.com/",
    "host": "example.com",
    "truncated": false,
    "elapsed_ms": 51,
    "robots": {
        "present": false,
        "status_code": 404,
        "error": null
    },
    "summary": {
        "pages_crawled": 1,
        "pages_ok": 1,
        "broken_internal": 0,
        "unverified": 0,
        "redirects": 0,
        "orphans": 0,
        "external_checked": 0,
        "max_pages": 5,
        "max_depth": 1
    },
    "pages": [
        {
            "url": "https://example.com/",
            "final_url": "https://example.com/",
            "status": 200,
            "title": "Example Domain",
            "depth": 0,
            "inbound": 0,
            "kind": "ok",
            "reason": null,
            "error": null,
            "redirect_chain": [
                {
                    "url": "https://example.com/",
                    "status_code": 200
                }
            ]
        }
    ],
    "broken_internal_links": [],
    "unverified_links": [],
    "external_links": [],
    "orphans": [],
    "sitemap": null,
    "cached": true
}
Crawl a site — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/15233/site+crawler+and+sitemap+api/40757/crawl+a+site?url=https://example.com/&max_pages=5&max_depth=1&same_host_only=true&check_external=false&include_sitemap=false&refresh=false' --header 'Authorization: Bearer YOUR_API_KEY' 


    
Request
Fetch a sitemap or discover one from a page URL, expand indexes, and return URLs, counts, and validation issues.
Endpoint ID: 40758
GET https://zylalabs.com/api/15233/site+crawler+and+sitemap+api/40758/parse+a+sitemap
INPUT PARAMETERS

Parse a sitemap — Endpoint Features

Object Description
url Required A page URL or a sitemap URL. Only http and https.
refresh Optional Ignore the cached result and fetch again. Default false.

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
refresh
API EXAMPLE RESPONSE
JSON
{
    "url": "https://example.com/",
    "sitemaps": [
        {
            "url": "https://example.com/sitemap.xml",
            "type": "invalid",
            "count": 0,
            "status_code": 404
        }
    ],
    "urls": [],
    "counts": {
        "urls": 0,
        "sitemaps": 1,
        "children_fetched": 1
    },
    "issues": [
        {
            "url": "https://example.com/sitemap.xml",
            "issue": "http_404"
        }
    ],
    "truncated": false,
    "cached": true
}
Parse a sitemap — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/15233/site+crawler+and+sitemap+api/40758/parse+a+sitemap?url=https://example.com/&refresh=false' --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 Site Crawler and Sitemap 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

Polite same-site crawl plus sitemap parsing, with broken internal links called out.

Site Crawler and Sitemap API FAQs

No. Timeouts and 400, 401, 403, and 429 are unverified, not broken.

Default 50, hard maximum 200. The walk also stops around 60 seconds and sets truncated to true.

Yes. The crawl is breadth-first, polite, and respects robots.txt.

Yes. Set include_sitemap=true on the crawl endpoint to list sitemap URLs that no crawled page linked to.

Crawl reports can be cached. Pass refresh=true to ignore the cached crawl report.

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