Feedscout


Advanced feed autodiscovery for JavaScript. Collect feed information from any webpage using multiple discovery methods.

Finds feeds by scanning links and anchors in HTML content, parsing HTTP headers, and guessing common paths, then validates each URL by fetching and parsing the feed.

Read full docs ↗
  ·  
Quick Start

---

Features

$3

- Feeds — RSS, Atom, JSON Feed, and RDF. Each feed is validated and returns metadata like format, title, description, and site URL.
- Blogrolls — OPML files containing feed subscriptions. Validated and returns title.
- WebSub hubs — Find hubs for real-time feed update notifications.

$3

- Platform — Generates feed URLs for YouTube, GitHub, WordPress, and other popular platforms using URL pattern matching.
- HTML — Scans elements with feed MIME types and elements matching feed patterns or labels like "RSS", "Subscribe".
- Headers — Parses HTTP Link headers for rel="alternate" with feed MIME types per RFC 8288.
- Guess — Tests common paths (e.g. /feed, /rss.xml, /atom.xml) against the base URL as a fallback.

$3

- Custom extractors — Override the default parser to extract additional metadata from feeds and blogrolls.
- Configurable methods — Enable/disable discovery methods or customize their options.
- Adapter system — Use native fetch or easily integrate with Axios, Got, or Ky.
- Concurrency control — Limit parallel requests during validation.
- Progress tracking — Monitor discovery progress with callbacks.
- Type-safe — Full TypeScript support with exported types.
- Tree-shakable — Import only what you need.

Quick Start

This is a short guide on how to get you up and running with Feedscout.

For a full overview of all the features, visit the documentation.

$3

``bash
npm install feedscout
`

$3

`typescript
import { discoverFeeds } from 'feedscout'

const feeds = await discoverFeeds('https://example.com')

// [{
// url: 'https://example.com/feed.xml',
// isValid: true,
// format: 'rss',
// title: 'Example Blog',
// description: 'A blog about examples',
// siteUrl: 'https://example.com',
// }]
`

`typescript
const feeds = await discoverFeeds('https://example.com', {
methods: ['html', 'headers'],
})
`

Or with existing HTML content:

`html





RSS Feed


`

`typescript
const feeds = await discoverFeeds(
{ url: 'https://example.com', content: html },
{ methods: ['html'] },
)

// [
// {
// url: 'https://example.com/feed.xml',
// isValid: true,
// format: 'rss',
// title: 'Example Blog',
// description: 'A blog about examples',
// siteUrl: 'https://example.com',
// },
// {
// url: 'https://example.com/rss',
// isValid: true,
// format: 'rss',
// title: 'Example Blog',
// description: 'A blog about examples',
// siteUrl: 'https://example.com',
// },
// ]
`

Or with HTTP headers:

`http
Link: ; rel="alternate"; type="application/rss+xml"
`

`typescript
const feeds = await discoverFeeds(
{ url: 'https://example.com', headers },
{ methods: ['headers'] },
)

// [{
// url: 'https://example.com/feed.xml',
// isValid: true,
// format: 'rss',
// title: 'Example Blog',
// description: 'A blog about examples',
// siteUrl: 'https://example.com',
// }]
`

$3

`typescript
import { discoverBlogrolls } from 'feedscout'

const blogrolls = await discoverBlogrolls('https://example.com')

// [{
// url: 'https://example.com/blogroll.opml',
// isValid: true,
// title: 'My Blogroll',
// }]
`

$3

`typescript
import { discoverHubs } from 'feedscout'

const hubs = await discoverHubs('https://example.com/feed.xml')

// [{
// hub: 'https://pubsubhubbub.appspot.com',
// topic: 'https://example.com/feed.xml',
// }]
``