Skip to content

Repository files navigation

GoPaper

GO documentation

A Go library for interacting with the Wallhaven API to search and retrieve wallpapers.

Installation

Installing the wrapper for use is as simple as:

go get github.com/Yustinia/gopaper

Usage

Quickstart:

package main

import (
    "fmt"
    "github.com/Yustinia/gopaper"
)

func main() {
    // Create a client without API Key
    // Note the empty "" string
    client := gopaper.NewClient("")

    // Use this if you have a valid API key
    // client := gopaper.NewClient("APIKey")

    // Create new search with defaults
    params := gopaper.NewSearch()
    // Filter content to Anime
    params.Categories = "010"
    // Filter content rating to SFW
    params.Purity = "100"

    // Configure the search parameters
    params.KeySearch = "japan"

    // Perform the search and provide
    result, err := client.Search(params)
    if err != nil {
        panic(err)
    }

    for i, wall := range result.Wallpapers {
        fmt.Printf("[%d] %s\n", i, wall.Path)
    }

    // Get full details for a specific wallpaper from the result
    details, err := client.GetWallpaperDetails(result.Wallpapers[0].ID)
    // or by providing the ID as the argument
    // details, err := client.GetWallpaperDetails("poyzl3")
}

Features

  • Search Wallpapers
  • Get wallpaper details
  • Filter through search parameters:
    • Categories
    • Purity
    • Sorting
    • Order
    • At Least
    • Resolution
    • Ratios
    • Page
    • Seed

About

A wallhaven (v1) API wrapper written in Golang

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages