---
[](https://github.com/vartanbeno/go-reddit/actions)
[](https://goreportcard.com/report/github.com/vartanbeno/go-reddit)
[](https://pkg.go.dev/github.com/vartanbeno/go-reddit/reddit)
## Overview
**Featured in [issue 327 of Golang Weekly](https://golangweekly.com/issues/327) 🎉**
go-reddit is a Go client library for accessing the Reddit API.
You can view Reddit's official API documentation [here](https://www.reddit.com/dev/api/).
## Install
To get a specific version from the list of [versions](https://github.com/vartanbeno/go-reddit/releases):
```sh
go get github.com/vartanbeno/go-reddit@vX.Y.Z
```
Or for the latest version:
```sh
go get github.com/vartanbeno/go-reddit
```
The repository structure for managing multiple major versions follows the one outlined [here](https://github.com/go-modules-by-example/index/tree/master/016_major_version_repo_strategy#major-branch-strategy).
## Usage
Make sure to have a Reddit app with a valid client id and secret. [Here](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example#first-steps) is a quick guide on how to create an app and get credentials.
```go
package main
import "github.com/vartanbeno/go-reddit/reddit"
func main() {
credentials := reddit.Credentials{ID: "id", Secret: "secret", Username: "username", Password: "password"}
client, _ := reddit.NewClient(credentials)
}
```
You can pass in a number of options to `NewClient` to further configure the client (see [reddit/reddit-options.go](reddit/reddit-options.go)). For example, to use a custom HTTP client:
```go
httpClient := &http.Client{Timeout: time.Second * 30}
client, _ := reddit.NewClient(credentials, reddit.WithHTTPClient(httpClient))
```
### Read-Only Mode
The `DefaultClient` method returns a valid, read-only client with limited access to the Reddit API, much like a logged out user. You can initialize your own and configure it further using options via `NewReadonlyClient`:
```go
client, _ := reddit.NewReadonlyClient()
```
## Examples