https://github.com/insanusmokrassar/saucenaoapi

Wrapper on multiplatform kotlin for SauceNaoAPI
https://github.com/insanusmokrassar/saucenaoapi

hacktoberfest hacktoberfest2020 kotlin kotlin-js kotlin-jvm kotlin-library kotlin-multiplatform saucenao-api

Last synced: 3 months ago
JSON representation

Wrapper on multiplatform kotlin for SauceNaoAPI

• Host: GitHub
• URL: https://github.com/insanusmokrassar/saucenaoapi
• Owner: InsanusMokrassar
• License: apache-2.0
• Created: 2019-02-20T03:34:55.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-26T23:08:44.000Z (4 months ago)
• Last Synced: 2024-09-30T09:14:05.796Z (4 months ago)
• Topics: hacktoberfest, hacktoberfest2020, kotlin, kotlin-js, kotlin-jvm, kotlin-library, kotlin-multiplatform, saucenao-api
• Language: Kotlin
• Homepage:
• Size: 318 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SauceNaoAPI

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/dev.inmo/saucenaoapi/badge.svg)](https://maven-badges.herokuapp.com/maven-central/dev.inmo/saucenaoapi)

It is wrapper for [SauceNAO](https://saucenao.com/) API. For now, library is

in preview state. It can be fully used, but some of info can be unavailable from

wrapper classes, but now you can access them via `SauceNaoAnswer#row` field.

## Including

### Gradle

```groovy

implementation "dev.inmo:saucenaoapi:$saucenaoapi_version"

```

## Requester

For the requests we are using `SauceNaoAPI` object. Unfortunately, for now it

supports only url strings as source of request. For example:

```kotlin

val key = // here must be your Sauce NAO API key

val requestUrl = // here must be your link to some image

val api = SauceNaoAPI(key)

api.use {

    println(

        it.request(requestUrl)

    )

}

```

Most of others requests use the same etymology and meaning as in the

`SauceNAO` API docs.