Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nicklaw5/kraken

A Twitch Kraken API (v5) client written in Go (Golang).
https://github.com/nicklaw5/kraken

go golang golang-library golang-package twitch twitch-api twitch-tv twitchtv

Last synced: about 2 months ago
JSON representation

A Twitch Kraken API (v5) client written in Go (Golang).

Awesome Lists containing this project

README

        

# kraken

A Twitch Kraken API (v5) client written in Go. If you are looking for a client for Twitch's Helix API, see [helix](https://github.com/nicklaw5/helix).

[![Build Status](https://travis-ci.org/nicklaw5/kraken.svg?branch=master)](https://travis-ci.org/nicklaw5/kraken)
[![Coverage Status](https://coveralls.io/repos/github/nicklaw5/kraken/badge.svg)](https://coveralls.io/github/nicklaw5/kraken)

## Package Status

This project is a work in progress. Below is a list of currently supported endpoints. Until a release is cut, consider this API to be unstable.

## Supported Endpoints

- [ ] Bits
- [ ] Channel Feed
- [ ] Channels
- [ ] Chat
- [x] Clips
- [ ] Collections
- [ ] Communities
- [ ] Games
- [ ] Ingests
- [ ] Search
- [ ] Streams
- [ ] Teams
- [ ] Users
- [ ] Videos

## Getting Started

It's recommended that you use a dependency management tool such as [Dep](https://github.com/golang/dep). If you are using Dep you can import kraken by running:

```bash
dep ensure -add github.com/nicklaw5/kraken
```

Or you can simply import using the Go toolchain:

```bash
go get -u github.com/nicklaw5/kraken
```

## Usage

This is a quick example of how to get a clip.

```go
client, err := kraken.NewClient("your-client-id", nil)
if err != nil {
// handle error
}

clip, err := client.GetClip("AwkwardHelplessSalamanderSwiftRage")
if err != nil {
// handle error
}

fmt.Printf("%+v\n", clip)
```

## License

This package is distributed under the terms of the [MIT](License) License.