Sitemap Generator API

This is an application that enables you to generate a sitemap for your website by simply passing in your site url to the api endpoint shown below. The app has no limit to the number of pages that can be crawled. Generate a sitemap for as many pages as possible.

Use case

You can setup a CRON job to call this application on a regular basis to crawl your site and generate a new sitemap that you can use to keep your sitemap updated.

Simply fetch your sitemap and save it to your filesystem for webcrawlers to index your site.

How to use this application

[GET] {root}/api/createSitemap

Parameters

Mandatory fields

• site_url (string): The url of the site which you want to create its sitemap eg https://example.com

Optional fields

• allow_external_links (boolean) : Default value is false. If this is set to true, external links will also be crawled and added to the sitemap. Possible values are true or false
• allow_element_links (boolean) : Default value is false. If this is set to true, anchor tags with #id links will be crawled and added to the sitemap. Possible values are true or false
• priority (integer) : Default value is 1.0. Sitemap content priority. Possible values are 0.0 to 1.0
• change_frequency (string) : Default value is "daily". How often should crawlers crawl your site. Possible values are daily, weekly, monthly, or yearly
• keywords_to_skip (string) : Default value is "". A comma seperated list of words in href to match. If there is a match, the link will not be crawled. Possible values are "mailto:,tel:,/recommends/"

Example Response

Success response

        {
            "status":"success",
            "sitemap":"
            < urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
                
                < url>
                    < loc>https://example.com/< /loc>
                    < lastmod>2021-11-29T16:20:02+00:00< /lastmod>
                    < changefreq>daily< /changefreq> 
                    < priority>1.00< /priority>
                < /url>
                < url>
                    < loc>https://example.com/category/getting-started< /loc>
                    < lastmod>2021-11-29T16:20:02+00:00< /lastmod>
                    < changefreq>daily< /changefreq> 
                    < priority>1.00< /priority>
                < /url>

                ...

            < /urlset>
            ";
        }
    

Failure response

        {
            "status":"failed",
            "message": "'site_url' should not be empty. Please enter the url to crawl"
        }