Parses and manipulates HTML and XML using a user-friendly API, supporting tasks like URL fetching, DOM traversal, and content cleaning to prevent XSS attacks. Offers robust DOM and CSS selector capabilities.
Ksoup is a Kotlin Multiplatform library for working with real-world HTML and XML. It's a port of the renowned Java library, jsoup, and offers an easy-to-use API for URL fetching, data parsing, extraction, and manipulation using DOM and CSS selectors.
The following extension libraries are deprecated and will be removed in a future release:
ksoup-network-ktor2(Network extension)Recommendation:
Ksoup implements the WHATWG HTML5 specification, parsing HTML to the same DOM as modern browsers do, but with support for Android, JVM, and native platforms.
Ksoup is adept at handling all varieties of HTML found in the wild.
Ksoup follows a modular architecture:
com.fleeksoft.ksoup:ksoup): The main library that provides HTML/XML parsing from stringsInclude the dependencies in your commonMain. Latest version
Start with the core library. This is all you need if you're only parsing HTML/XML from strings.
// Required core library
implementation("com.fleeksoft.ksoup:ksoup:<version>")
Add one of these extensions only if you need to parse HTML/XML from files or other sources.
Choose one of the following I/O libraries:
kotlinx-io (Recommended)
implementation()
Add one of these extensions only if you need to fetch and parse HTML/XML directly from URLs.
Choose one of the following network libraries:
Ktor 3 (Recommended)
com.fleeksoft.charset:charset-ext, For more details, visit the Charsets DocumentationFor API documentation you can check Jsoup. Most of the APIs work without any changes.
val html = "<html><head><title>One</title></head><body>Two</body></html>"
val doc: Document = Ksoup.parse(html = html)
println("title => ${doc.title()}") // One
println("bodyText => ${doc.body().text()}") // Two
This snippet demonstrates how to use Ksoup.parse for parsing an HTML string and extracting the title and body text.
//Please note that the com.fleeksoft.ksoup:ksoup-network library is required for Ksoup.parseGetRequest.
val doc: Document = Ksoup.parseGetRequest(url = "https://en.wikipedia.org/") // suspend function
// or
val doc: Document = Ksoup.parseGetRequestBlocking(url = "https://en.wikipedia.org/")
println()
headlines: Elements = doc.select()
headlines.forEach { headline: Element ->
headlineTitle = headline.attr()
headlineLink = headline.absUrl()
println()
}
val doc: Document = Ksoup.parse(xml, parser = Parser = Parser.xmlParser())
//Please note that the com.fleeksoft.ksoup:ksoup-network library is required for Ksoup.parseGetRequest.
val doc: Document = Ksoup.parseGetRequest(url = )
metadata: Metadata = Ksoup.parseMetaData(element = doc)
metadata: Metadata = Ksoup.parseMetaData(html = HTML)
println()
println()
println()
println()
println()
println()
In this example, Ksoup.parseGetRequest fetches and parses HTML content from Wikipedia, extracting and printing news headlines and their corresponding links.
Ksoup is an open source project, a Kotlin Multiplatform port of jsoup, distributed under the MIT License, Version 2.0. The source code of Ksoup is available on GitHub.
For questions about usage and general inquiries, please refer to GitHub Discussions.
If you wish to contribute, please read the Contributing Guidelines.
To report any issues, visit our GitHub issues, Please ensure to check for duplicates before submitting a new issue.
Ksoup is open source software licensed under the MIT License.
This project is a Kotlin Multiplatform port of Jsoup, created by Jonathan Hedley.
Portions of this library are derived from jsoup and retain their original MIT License,
© 2009–2025 Jonathan Hedley.
ksoup-kotlinx extensionksoup-network extension (based on Ktor 3)// Optional: Add this if you need file parsing capabilities
// Provides Ksoup.parseFile, Ksoup.parseSource & Other InputStream APIs
implementation("com.fleeksoft.ksoup:ksoup-okio:<version>")
// Optional: Add this if you need to fetch HTML/XML from URLs
// Provides Ksoup.parseGetRequest, Ksoup.parseSubmitRequest, Ksoup.parsePostRequest
implementation("com.fleeksoft.ksoup:ksoup-network:<version>")
Ktor 2 (DEPRECATED: Use Ktor 3 instead)
// Deprecated: Not recommended for new projects
// Provides Ksoup.parseGetRequest, Ksoup.parseSubmitRequest, Ksoup.parsePostRequest
implementation("com.fleeksoft.ksoup:ksoup-network-ktor2:<version>")
Surfaced from shared tags and platforms — no rankings paid for.