TorrentSearch-Kotlin

KO | EN

gitlite — search

#javascript #python #hacktoberfest #llm #android #linux #macos #awesome #cli #vue #pytorch #ios #mcp #open-source

TorrentSearch-Kotlin

(★ 23)

Kotlin multiplatform torrent provider search client

TorrentSearch-Kotlin Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TorrentSearch Kotlin

![Maven Central](https://img.shields.io/maven-central/v/org.drewcarlson/torrentsearch-jvm?label=maven&color=blue)
![](https://github.com/DrewCarlson/TorrentSearch-Kotlin/workflows/Jvm/badge.svg)
![](https://github.com/DrewCarlson/TorrentSearch-Kotlin/workflows/Js/badge.svg)
![](https://github.com/DrewCarlson/TorrentSearch-Kotlin/workflows/Native/badge.svg)

Multiplatform Torrent and NZB Provider API client written in Kotlin.

## About

TorrentSearch-Kotlin enables you to query multiple torrent & NZB provides in one request and handle all the results. Supported
providers can be found in [`src/commonMain/kotlin/providers`](src/commonMain/kotlin/providers).

## Usage

```kotlin
val torrentSearch = TorrentSearch()

// Only the content string or imdbId/tmdbId/tvdbId is required
val result = torrentSearch.search {
    content = "big buck bunny"

category = Category.ALL // Optional: Filter by category
    imdbId = "tt..." // Optional: Find by IMDB id instead of content
    tmdbId = 534 // Optional: Find by TMDB id instead of content
    tvdbId = 874 // Optional: Find by TVDB id instead of content
    limit = 20 // Optional: Limit results per provider endpoint
}

println(result.torrents().toList())
// [TorrentDescription(provider=Libre, title=Big Buck Bunny, magnetUrl=magnet:?xt=urn:btih:...]
```

Some providers may require additional requests to resolve download information for a `TorrentDescription`.
This can be checked on the individual `TorrentDescription`s or for the whole collection returned by a provider.

```kotlin
val searchResult = torrentSearch.search { /* ... */ }

val unresolved = searchResult.providerResults().filter { it.requiresResolution }.toList()

val resultSet = torrentSearch.resolve(unresolved.flatMap { it.torrents })

val torrent = resultSet.torrents.first()

// Now you can access `torrent.magnetUrl` and `torrent.infoHash`
```

## Caching

An optional [`TorrentProviderCache`](src/commonMain/kotlin/TorrentProviderCache.kt)
can be provided to `TorrentSearch` enabled caching for authentication tokens and search results.

The default cache will store auth tokens in memory and does not cache torrent results. To add custom caching behavior,
implement a [`TorrentProviderCache`](src/commonMain/kotlin/TorrentProviderCache.kt) and use it when
constructing `TorrentSearch`.

## Web Demo

The [`web`](web) demo helps with debugging the api and provider implementations, it can be run with
`./gradlew jsBrowserProductionRun` and open [http://localhost:8080](http://localhost:8080) in your browser.

## Download

![Maven Central](https://img.shields.io/maven-central/v/org.drewcarlson/torrentsearch-jvm?label=maven&color=blue)
![Sonatype Nexus (Snapshots)](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fcentral.sonatype.com%2Frepository%2Fmaven-snapshots%2Forg%2Fdrewcarlson%2Ftorrentsearch-jvm%2Fmaven-metadata.xml&label=nexus)

![](https://img.shields.io/static/v1?label=&message=Platforms&color=grey)
![](https://img.shields.io/static/v1?label=&message=Js&color=blue)
![](https://img.shields.io/static/v1?label=&message=Jvm&color=blue)
![](https://img.shields.io/static/v1?label=&message=Linux&color=blue)
![](https://img.shields.io/static/v1?label=&message=macOS&color=blue)
![](https://img.shields.io/static/v1?label=&message=Windows&color=blue)
![](https://img.shields.io/static/v1?label=&message=iOS&color=blue)

```kotlin
repositories {
    mavenCentral()
    // Or snapshots
    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
}

dependencies {
    implementation("org.drewcarlson:torrentsearch:$torrentsearch_version")

// For Jvm only:
    implementation("org.drewcarlson:torrentsearch-jvm:$torrentsearch_version")
}
```

Note: it is required to specify a Ktor client engine implementation.
([Documentation](https://ktor.io/clients/http-client/multiplatform.html))

```kotlin
dependencies {
    // Jvm/Android
    implementation("io.ktor:ktor-client-okhttp:$ktor_version")
    implementation("io.ktor:ktor-client-android:$ktor_version")
    // iOS
    implementation("io.ktor:ktor-client-darwin:$ktor_version")
    // macOS/Windows/Linux
    implementation("io.ktor:ktor-client-curl:$ktor_version")
    // Javascript/NodeJS
    implementation("io.ktor:ktor-client-js:$ktor_version")
}
```

## License

MIT, see [LICENSE](LICENSE)

TorrentSearch-Kotlin

TorrentSearch-Kotlin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

TorrentSearch-Kotlin

TorrentSearch-Kotlin Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README