{
"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
}
]
}
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'
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.
| 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.
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.
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.
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.
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.
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.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund