klipy-kt
0.1.0indexedAsync client for the KLIPY API enabling GIFs, stickers and clips search, trending, share logging, ad-aware responses (HTML/iFrame), customizable HTTP client and user-agent.
1
Stars
—
Used by
dependents
—
Health
/ 100
klipy
Async Kotlin Multiplatform client for the KLIPY API.
This is an unofficial library and is not affiliated with Klipy in any way.
Installation
dependencies {
implementation("io.github.vyfor:klipy:$version")
/* required */
implementation("io.ktor:ktor-client-$engine:$version")
}
For the list of supported engines, see Ktor Client Engines.
Usage
val klipy = KlipyClient("YOUR_APP_KEY")
// trending GIFs
val page = klipy.gifs().trending().perPage(20).send()
page.contentItems().forEach { println() }
page = klipy.stickers().search().contentFilter(ContentFilter.Medium).send()
page = klipy.clips().items()
klipy.gifs().share().customerId().send()
suggestions = klipy.searchSuggestions(, limit = )
Ads
val klipy = KlipyClient("YOUR_APP_KEY") {
userAgent("Mozilla/5.0 (iPhone; CPU iPhone OS 17_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148")
}
val page = klipy.gifs().trending()
.adParams(AdParams(
customerId = "user-uuid",
minWidth = 50,
maxWidth = ,
minHeight = ,
maxHeight = ,
os = ,
))
.send()
(item page.) {
(item) {
Item.Content -> { }
Item.Ad -> { }
}
}
Custom client
val klipy = KlipyClient("YOUR_APP_KEY") {
userAgent("...")
}
Or bring your own HttpClient:
val klipy = KlipyClient("YOUR_APP_KEY") {
httpClient(myClient)
}
Licensing
Dual licensed under MIT OR Apache-2.0 at your discretion. See LICENSE-MIT and LICENSE-APACHE for details.