# goodreads

**Repository Path**: mirrors_rubenv/goodreads

## Basic Information

- **Project Name**: goodreads
- **Description**: Goodreads API client written in Go.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# goodreads

[![GoDoc](https://godoc.org/github.com/KyleBanks/goodreads?status.svg)](https://godoc.org/github.com/KyleBanks/goodreads)  
[![Build Status](https://travis-ci.org/KyleBanks/goodreads.svg?branch=master)](https://travis-ci.org/KyleBanks/goodreads) 
[![Go Report Card](https://goreportcard.com/badge/github.com/KyleBanks/goodreads)](https://goreportcard.com/report/github.com/KyleBanks/goodreads) 
[![Coverage Status](https://coveralls.io/repos/github/KyleBanks/goodreads/badge.svg?branch=master)](https://coveralls.io/github/KyleBanks/goodreads?branch=master)

An unofficial [Goodreads API](https://www.goodreads.com/api/index) client written in Go. 

## Usage

The first thing you'll need to do is register for a Goodreads API Key: [https://www.goodreads.com/api/keys](https://www.goodreads.com/api/keys)

Once you have your key, you can initialize a Goodreads client like so:

```
package main

import (
    "os"
    "github.com/KyleBanks/goodreads"
)

func main() {
    key := os.Getenv("API_KEY")	
    c := goodreads.NewClient(key)
}
```

With a client initialized, simply call the API methods as needed:

```
u, err := c.UserShow("38763538")
if err != nil {
    panic(err)
}
fmt.Printf("Loaded user details of %s:\n", u.Name)
```

The client function names match those of the Goodreads API documentation. For example, `user.show` is `UserShow` above. To see the full list of supported methods:

```
$ go doc github.com/KyleBanks/goodreads Client 
```

## Examples

Example code is available in the [examples/](./examples) directory.

After you've obtained a Goodreads API Key, you can run the examples like so:

```
$ API_KEY="api key" go run example/example.go
```