An open API service indexing awesome lists of open source software.

https://github.com/sonjek/go-lastfm

Golang wrapper for the Last.fm API 2.0
https://github.com/sonjek/go-lastfm

api-wrapper go golang lastfm lastfm-api

Last synced: 5 months ago
JSON representation

Golang wrapper for the Last.fm API 2.0

Awesome Lists containing this project

README

          

# go-lastfm

[![Go build status](https://github.com/sonjek/go-lastfm/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/sonjek/go-lastfm/actions/workflows/ci.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/sonjek/go-lastfm)](https://goreportcard.com/report/github.com/sonjek/go-lastfm) [![API reference](https://img.shields.io/badge/api-reference-blue.svg)](https://pkg.go.dev/github.com/sonjek/go-lastfm) [![Contributors](https://img.shields.io/github/contributors/sonjek/go-lastfm)](https://github.com/sonjek/go-lastfm/graphs/contributors) [![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/sonjek/go-lastfm?include_prereleases)](https://github.com/sonjek/go-lastfm/releases) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/sonjek/go-lastfm/blob/master/LICENSE)

[sonjek/go-lastfm](https://github.com/sonjek/go-lastfm) is a fork of [shkh/lastfm-go](https://github.com/shkh/lastfm-go) that hasn't been maintained since the end of 2019.

## Purpose
Golang wrapper for the [Last.fm API 2.0](https://www.last.fm/api/)

## Setup

Get the source codes from github:

```bash
go get github.com/sonjek/go-lastfm/lastfm
```

Import the package:

```go
import "github.com/sonjek/go-lastfm/lastfm"
```

## Usage

First, create an API instance with your `API KEY` and `API SECRET`.

```go
api := lastfm.New(ApiKey, ApiSecret)
```

Note that some API methods require your user's permission, so make sure that your requests are authenticated before calling these methods. See "Authentication" section.

API instances contain the structs which represent API classes, and each struct has methods corresponding to their API methods.
So you can call `artist.getTopTracks` for example as following:

```go
// with discarding error
result, _ := api.Artist.GetTopTracks(lastfm.P{"artist": "Avicii"})
for _, track := range result.Tracks {
fmt.Println(track.Name)
}
```

Methods that fetch some data return their result as a struct named `ClassMethod` (e.g. api.User.GetInfo returns its result of type UserGetInfo).
They can be found in `class_result.go`.
Please look at the file to see which fields are exported.

You can use `lastfm.P` for arguments.
It's just an alias to `map[string]interface{}`, but values must be `string`, `int`, `int64` (for unix timestamp) or `[]string`.
Slice of string, []string, can be used for passing multiple values for a key.

```go
// album.addTags (auth required)
api.Album.AddTags(lastfm.P{
"artist": "Kaene",
"album": "Strangeland",
"tags": []string{"britpop", "alternative rock", "2012"},
})
```

## Authentication
There are three ways to authenticate your requests, which to choose depends on what kind of application you are making.

- for Mobile Apps

```go
err := api.Login(username, password)
```

- for Desktop Apps

```go
token, _ := api.GetToken()
authUrl := api.GetAuthTokenUrl(token)
// Send your user to "authUrl"
// Once the user grant permission, then authorize the token.
api.LoginWithToken(token)
```

- for Web Apps

```go
callback := "https://spam.hum"
authUrl, _ := api.GetAuthRequestUrl(callback)
// Send your user to "authUrl"
// Get the token embeded in the redirected URL, then authorize the token.
api.LoginWithToken(token)
```

## Examples

More usage examples can be found in [examples directory](examples).

## Supported APIs

### Album
* [album.addTags](https://www.last.fm/api/show/album.addTags)
* [album.getInfo](https://www.last.fm/api/show/album.getInfo)
* [album.getTags](https://www.last.fm/api/show/album.getTags)
* [album.getTopTags](https://www.last.fm/api/show/album.getTopTags)
* [album.removeTag](https://www.last.fm/api/show/album.removeTag)
* [album.search](https://www.last.fm/api/show/album.search)

### Artist
* [artist.addTags](https://www.last.fm/api/show/artist.addTags)
* [artist.getCorrection](https://www.last.fm/api/show/artist.getCorrection)
* [artist.getInfo](https://www.last.fm/api/show/artist.getInfo)
* [artist.getSimilar](https://www.last.fm/api/show/artist.getSimilar)
* [artist.getTags](https://www.last.fm/api/show/artist.getTags)
* [artist.getTopAlbums](https://www.last.fm/api/show/artist.getTopAlbums)
* [artist.getTopTags](https://www.last.fm/api/show/artist.getTopTags)
* [artist.getTopTracks](https://www.last.fm/api/show/artist.getTopTracks)
* [artist.removeTag](https://www.last.fm/api/show/artist.removeTag)
* [artist.search](https://www.last.fm/api/show/artist.search)

### Auth
* [auth.getMobileSession](https://www.last.fm/api/show/auth.getMobileSession)
* [auth.getSession](https://www.last.fm/api/show/auth.getSession)
* [auth.getToken](https://www.last.fm/api/show/auth.getToken)

### Chart
* [chart.getTopArtists](https://www.last.fm/api/show/chart.getTopArtists)
* [chart.getTopTags](https://www.last.fm/api/show/chart.getTopTags)
* [chart.getTopTracks](https://www.last.fm/api/show/chart.getTopTracks)

### Geo
* [geo.getTopArtists](https://www.last.fm/api/show/geo.getTopArtists)
* [geo.getTopTracks](https://www.last.fm/api/show/geo.getTopTracks)

### Library
* [library.getArtists](https://www.last.fm/api/show/library.getArtists)

### Tag
* [tag.getInfo](https://www.last.fm/api/show/tag.getInfo)
* [tag.getSimilar](https://www.last.fm/api/show/tag.getSimilar)
* [tag.getTopAlbums](https://www.last.fm/api/show/tag.getTopAlbums)
* [tag.getTopArtists](https://www.last.fm/api/show/tag.getTopArtists)
* [tag.getTopTags](https://www.last.fm/api/show/tag.getTopTags)
* [tag.getTopTracks](https://www.last.fm/api/show/tag.getTopTracks)
* [tag.getWeeklyChartList](https://www.last.fm/api/show/tag.getWeeklyChartList)

### Track
* [track.addTags](https://www.last.fm/api/show/track.addTags)
* [track.getCorrection](https://www.last.fm/api/show/track.getCorrection)
* [track.getInfo](https://www.last.fm/api/show/track.getInfo)
* [track.getSimilar](https://www.last.fm/api/show/track.getSimilar)
* [track.getTags](https://www.last.fm/api/show/track.getTags)
* [track.getTopTags](https://www.last.fm/api/show/track.getTopTags)
* [track.love](https://www.last.fm/api/show/track.love)
* [track.removeTag](https://www.last.fm/api/show/track.removeTag)
* [track.scrobble](https://www.last.fm/api/show/track.scrobble)
* [track.search](https://www.last.fm/api/show/track.search)
* [track.unlove](https://www.last.fm/api/show/track.unlove)
* [track.updateNowPlaying](https://www.last.fm/api/show/track.updateNowPlaying)

### User
* [user.getFriends](https://www.last.fm/api/show/user.getFriends)
* [user.getInfo](https://www.last.fm/api/show/user.getInfo)
* [user.getLovedTracks](https://www.last.fm/api/show/user.getLovedTracks)
* [user.getPersonalTags](https://www.last.fm/api/show/user.getPersonalTags)
* [user.getRecentTracks](https://www.last.fm/api/show/user.getRecentTracks)
* [user.getTopAlbums](https://www.last.fm/api/show/user.getTopAlbums)
* [user.getTopArtists](https://www.last.fm/api/show/user.getTopArtists)
* [user.getTopTags](https://www.last.fm/api/show/user.getTopTags)
* [user.getTopTracks](https://www.last.fm/api/show/user.getTopTracks)
* [user.getWeeklyAlbumChart](https://www.last.fm/api/show/user.getWeeklyAlbumChart)
* [user.getWeeklyArtistChart](https://www.last.fm/api/show/user.getWeeklyArtistChart)
* [user.getWeeklyChartList](https://www.last.fm/api/show/user.getWeeklyChartList)
* [user.getWeeklyTrackChart](https://www.last.fm/api/show/user.getWeeklyTrackChart)

## Licence
MIT Licenced. See [LICENCE](https://github.com/sonjek/go-lastfm/blob/master/LICENSE).