Sitemap URL Inventory API

API ID 15007

List every page URL a website publishes in its sitemaps, with lastmod, changefreq and priority. Reads robots.txt, follows sitemap indexes and handles .xml.gz. Up to 10,000 URLs per call.

API Documentation

Endpoints

Request
Point it at a domain or a sitemap URL. Reads the Sitemap: lines in robots.txt (falls back to /sitemap.xml and /sitemap_index.xml), follows index files on the same site (up to 20 sitemap files) and returns up to max URLs (default 1,000, max 10,000) with lastmod, changefreq and priority. truncated is true when more URLs exist. Public https sites only; links to other domains are ignored. Sitemap files over 3 MB (12 MB after gunzip) are skipped and listed with error too_large; if nothing else is left the call returns 413 sitemap_too_large.
Endpoint ID: 39568
GET https://zylalabs.com/api/15007/sitemap+url+inventory+api/39568/get+sitemap+urls
INPUT PARAMETERS

Get sitemap URLs — Endpoint Features

Object Description
url Required Domain (example.com), site URL or direct sitemap URL (.xml or .xml.gz).
max Optional Maximum URLs to return, 1 to 10000 (default 1000).

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

url
max
API EXAMPLE RESPONSE
JSON
{
    "success": true,
    "endpoint": "sitemap.urls",
    "billable": true,
    "count": 3,
    "truncated": true,
    "sitemaps": [
        {
            "sitemap": "https://kubernetes.io/en/sitemap.xml",
            "ok": true,
            "type": "urlset",
            "entries": 1896
        }
    ],
    "items": [
        {
            "url": "https://kubernetes.io/releases/1.37/",
            "lastmod": null,
            "changefreq": null,
            "priority": 0
        },
        {
            "url": "https://kubernetes.io/releases/1.36/",
            "lastmod": null,
            "changefreq": null,
            "priority": 0
        },
        {
            "url": "https://kubernetes.io/releases/1.35/",
            "lastmod": null,
            "changefreq": null,
            "priority": 0
        }
    ]
}
Get sitemap URLs — CODE SNIPPETS

curl --location --request GET 'https://zylalabs.com/api/15007/sitemap+url+inventory+api/39568/get+sitemap+urls?url=https://kubernetes.io/en/sitemap.xml&max=3' --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 Sitemap URL Inventory 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

List every page URL a website publishes in its sitemaps, with lastmod, changefreq and priority. Reads robots.txt, follows sitemap indexes and handles .xml.gz. Up to 10,000 URLs per call.

Sitemap URL Inventory API FAQs

From the Sitemap: lines in robots.txt; if there are none it tries /sitemap.xml and /sitemap_index.xml. You can also pass a sitemap URL directly.

Up to 10,000 URLs and 20 sitemap files per call. Each sitemap file can be up to 3 MB (12 MB after gunzip); larger files are skipped and reported with error too_large. For very large sites, pass a child sitemap URL directly.

The call returns 200 with count 0 and a note. On Zyla every 200 response counts as one request.

No. It only reads the sitemap files the site publishes, so it is fast and light on the target site.

Public https sites only. Private network addresses are refused, and sitemap entries pointing at other domains are ignored.

The endpoint returns a list of URLs published in a website's sitemaps, along with metadata such as lastmod (last modified date), changefreq (change frequency), and priority. This data helps users understand the structure and update frequency of the site's content.

Key fields in the response include "success" (indicating the request status), "count" (number of URLs returned), "truncated" (indicating more URLs exist), and "items" (the actual list of URLs with their metadata).

The response is structured in JSON format, with a top-level object containing success status, count, truncation status, and an array of "items." Each item includes the URL and its associated metadata, making it easy to parse and utilize.

The endpoint provides information on URLs, their last modified dates, change frequency, and priority. This data helps in SEO analysis, content management, and understanding site structure.

Users can customize requests by specifying a domain or a sitemap URL. They can also adjust the maximum number of URLs returned by setting the "max" parameter, up to a limit of 10,000.

"lastmod" indicates when the URL was last modified, "changefreq" suggests how often the content is expected to change, and "priority" reflects the importance of the URL relative to others on the site, aiding in SEO strategies.

Typical use cases include SEO audits, content inventory management, and website analysis. Users can leverage the data to optimize their site structure and improve search engine visibility.

Data accuracy is maintained by directly reading the sitemaps published by the website, ensuring that the information reflects the site's current structure. The API also skips large files, reducing the risk of outdated or incomplete data.

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