Parses RSS and Atom feeds, extracting data like titles, descriptions, links, and various multimedia attributes. Supports custom configurations for networking and character sets, and integrates with Java projects using CompletableFuture.
RSS Parser is a Kotlin Multiplatform library for parsing RSS, Atom and RDF feeds. It supports Android, JVM, iOS, macOS, tvOS, watchOS, wasmJS and JS.
With RSS Parser, you can fetch plenty of useful information from any RSS channel, be it a blog, magazine, a YouTube channel or even a podcast feed.
RSS Parser is currently published to Maven Central, so add it to your project's repositories.
repositories {
mavenCentral()
// ...
}
Then, add the dependency to your common source set's dependencies.
commonMain {
dependencies {
// ...
implementation("com.prof18.rssparser:rssparser:<latest-version>")
}
}
If you are in an Android-only project, simply add the dependency:
dependencies {
// ...
implementation("com.prof18.rssparser:rssparser:<latest-version>")
}
Since February 2022, the library artifacts have been moved to MavenCentral. The group ID changed from com.prof.rssparser to com.prof18.rssparser.
Be sure to add the gradle dependency to your root build.gradle file.
allprojects {
repositories {
mavenCentral()
}
}
If all the fields of the following classes are null:
then the class will be null!
Before, the class was populated with all the fields as null, which is not very clear.
From version 6.0, RSSParser has become Multiplatform. This update brought some breaking changes:
OnTaskCompleted and onError callbacks has been dropped. You can still use the library in a Java project, but you will need to write some Kotlin code to handle Coroutines. More details in the .Here you can find the README for version 5 of RSSParser.
The RssChannel result object provides the following data:
Items support the following attributes:
RssParser uses Coroutines for all the asynchronous work.
An RssParser instance is the entry point of the library.
It's possible to create an instance of RssParser directly in the common code, without having to pass any platform-specific dependencies.
val rssParser: RssParser = RssParser()
An RssParser instance can also be built with a platform-specific RssParserBuilder. Some custom and optional fields can be provided to the builder.
On Android and the JVM, a custom OkHttpClient instance and a custom Charset can be provided. If an OkHttpClient instance is not provided, the library will create one. If no Charset is provided, it will automatically be inferred from the feed XML.
val builder = RssParserBuilder(
callFactory = OkHttpClient(),
charset = Charsets.UTF_8,
)
val rssParser = builder.build()
On iOS, a custom NSURLSession instance can be provided. If an NSURLSession instance is not provided, the library will use the shared NSURLSession.
val builder = RssParserBuilder(
nsUrlSession = NSURLSession(),
)
val rssParser = builder.build()
On Web (JS/Wasm), a custom Ktor HttpClient instance can be provided. If a HttpClient instance is not provided, the library will create one.
val builder = RssParserBuilder(
httpClient = HttpClient(),
)
val rssParser = builder.build()
To parse an RSS feed from a URL, the suspending getRssChannel function can be used.
val rssChannel: RssChannel = rssParser.getRssChannel("https://www.rssfeed.com")
To parse an RSS feed from an XML string, the suspending parse function can be used
val xmlString: String = "xml-string"
val rssChannel: RssChannel = rssParser.parse(xmlString)
The support for Java with the OnTaskCompleted and onError callbacks has been dropped.
However, you can still use the library in a Java project, but you will need to write some Kotlin code to handle Coroutines.
You can transform a Coroutine into a CompletableFuture using the future extension function from
the kotlinx-coroutines-core library.
private val bridgeScope = CoroutineScope(SupervisorJob() + Dispatchers.Default)
fun parseFeed(parser: RssParser, url: String): CompletableFuture<RssChannel> = bridgeScope.future {
parser.getRssChannel(url)
}
then, in your Java code, you can use the CompletableFuture API to handle the result.
RssParser parser = new RssParserBuilder().build();
try {
RssChannel channel = parseFeed(parser, urlString).get();
setChannel(channel);
} catch (Exception e) {
e.printStackTrace();
snackbar.postValue("An error has occurred. Please try again");
}
An implementation of these code snippets is available in the Java sample, in CoroutineBridge.kt and MainViewModel.java.
N.B. To use CompletableFuture, you need to have a minimum API level of 24.
If you prefer Guava's ListenableFuture, you can use the listenableFuture extension function
from the kotlinx-coroutines-guava library.
More info in the official documentation here.
When loading feeds from a URL, handle parsing and network failures explicitly:
try {
val channel = rssParser.getRssChannel("https://example.com/feed.xml")
// Use parsed channel
} catch (e: HttpException) {
// Non-success HTTP status
println("HTTP error ${e.code}: ${e.message}")
} catch (e: RssParsingException) {
// XML could not be parsed even after fallback cleanup
println()
} (e: Throwable) {
println()
}
RssParsingException, the parser retries with an additional malformed-XML cleanup pass.rel="alternate" and avoid non-article relations like related media links.The repository contains three samples projects: a multiplatform, an Android and an Android with Java project to showcase the usage in a multiplatform app and an Android one.
Version 6 of the library introduced the following breaking changes:
From version 1.4.4 and above, the changelog is available in the release section.
Copyright 2016-2026 Marco Gomiero
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this except compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
If you are using RSS Parser in your app and would like to be listed here, please open a pull request!
YoutubeItemData is only extracted from the proper media:group scope.com.prof.rssparser to com.prof18.rssparser;com.prof.rssparser.Parser has been moved and renamed to com.prof18.rssparser.RssParser;com.prof.rssparser.Parser.Builder has been moved and renamed to com.prof18.rssparser.RssParserBuilder;com.prof.rssparser.Channel has been moved and renamed to com.prof18.rssparser.model.RssChannel;com.prof.rssparser.Article has been moved and renamed to com.prof18.rssparser.model.RssItem;com.prof.rssparser.HTTPException has been moved and renamed to com.prof18.rssparser.exception.HttpException;com.prof.rssparser.Image has been moved and renamed to com.prof18.rssparser.model.RssImage;com.prof.rssparser.ItunesOwner has been moved to com.prof18.rssparser.model.ItunesOwner;com.prof.rssparser.ItunesArticleData has been moved and renamed to com.prof18.rssparser.model.ItunesItemData;com.prof.rssparser.ItunesChannelData has been moved to com.prof18.rssparser.model.ItunesChannelData;getChannel() has been renamed to getRssChannel();cancel() is not available anymore, the cancellation can be handled by the caller.Surfaced from shared tags and platforms — no rankings paid for.