Get a list of URLs from one or more sitemaps
Last updated 3 months ago by larabuli .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @larabuli/sitemap-stream-parser 
SYNC missed versions from official npm registry.


A streaming parser for sitemap files. It is able to deal with GBs of deeply nested sitemaps with hundreds of URLs in them. Maximum memory usage is just over 100Mb at any time.


The main method to extract URLs for a site is with the parseSitemaps(urls, url_cb, done) method. You can call it with both a single URL or an Array of URLs. The url_cb is called for every URL that is found. The done callback is passed an error and/or a list of all the sitemaps that were checked.


var sitemaps = require('sitemap-stream-parser');

sitemaps.parseSitemaps('http://example.com/sitemap.xml', console.log, function(err, sitemaps) {
    console.log('All done!');


var sitemaps = require('sitemap-stream-parser');

var urls = ['http://example.com/sitemap-posts.xml', 'http://example.com/sitemap-pages.xml'];

all_urls = [];
sitemaps.parseSitemaps(urls, function(url) { all_urls.push(url); }, function(err, sitemaps) {
    console.log('All done!');

Sometimes sites advertise their sitemaps in their robots.txt file. To parse this file to see if that is the case use the method sitemapsInRobots(url, cb). You can easily combine those 2 methods.

var sitemaps = require('sitemap-stream-parser');

sitemaps.sitemapsInRobots('http://example.com/robots.txt', function(err, urls) {
    if(err || !urls || urls.length == 0)
    sitemaps.parseSitemaps(urls, console.log, function(err, sitemaps) {

Current Tags

  • 1.7.1                                ...           latest (3 months ago)

2 Versions

  • 1.7.1                                ...           3 months ago
  • 1.7.0                                ...           3 months ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 2
Last Month 2
Dependencies (4)
Dev Dependencies (1)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |