equinox

Usage • Example • Todo • About

Features

• Riot APIs implemented:
  • Riot Account
  • League of Legends
  • Teamfight Tactics
  • Valorant
  • Legends of Runeterra
• Data Dragon and Community Dragon (Incomplete)
• Rate limit (WIP)
• Caching
• Retry n times

equinox currently uses the proposed jsonv2 package, read more about it here.

Usage

Get the library:

go get github.com/Kyagara/equinox # or: go get github.com/Kyagara/equinox@master

Create a new instance of the Equinox client:

client, err := equinox.NewClient("RIOT_API_KEY")

A client without a configuration comes with the default options:

• Key: The provided key.
• LogLevel: zerolog.WarnLevel. zerolog.Disabled disables logging.
• Retries: Retries a request n times if the API returns an error, defaults to 3.
• HTTPClient: http.Client with a timeout of 15 seconds.
• Cache: BigCache with an eviction time of 4 minutes.
• RateLimit: Internal rate limiter.

A custom Client can be created using equinox.NewClientWithConfig().

A different storage can be provided to the client using cache.NewRedis() or cache.NewBigCache(), passing nil in config.Cache disables caching.

You can disable rate limiting by passing nil in config.RateLimit, this can be useful if you have Equinox passing through a proxy that handles rate limiting.

See Cache and Rate limit for more details.

Using different endpoints:

// This method uses a lol.PlatformRoute. Can be accessed with a Development key.
summoner, err := client.LOL.SummonerV4.ByPUUID(lol.BR1, "summoner_puuid")

// This method uses a api.RegionalRoute. Can be accessed with a Development key.
match, err := client.LOL.MatchV5.ByID(api.AMERICAS, "match_id")

// This method uses a api.RegionalRoute. Can be accessed with a Development key.
account, err := client.Riot.AccountV1.ByPUUID(api.AMERICAS, "puuid")

// This method uses a val.PlatformRoute. May not be available in your policy.
matches, err := client.VAL.MatchV1.Recent(val.BR, "competitive")

Example

For a slightly more advanced example, check out lol-match-crawler.

package main

import (
	"fmt"

	"github.com/Kyagara/equinox"
	"github.com/Kyagara/equinox/clients/lol"
)

func main() {
	client, err := equinox.NewClient("RIOT_API_KEY")
	if err != nil {
		fmt.Println("error creating client: ", err)
		return
	}
	// Get this week's champion rotation.
	rotation, err := client.LOL.ChampionV3.Rotation(lol.BR1)
	if err != nil {
		fmt.Println("error retrieving champion rotation: ", err)
		return
	}
	fmt.Printf("%+v\n", rotation)
	// &{FreeChampionIDs:[17 43 56 62 67 79 85 90 133 145 147 157 201 203 245 518]
	// FreeChampionIDsForNewPlayers:[222 254 427 82 131 147 54 17 18 37]
	// MaxNewPlayerLevel:10}
}

Todo

• Maybe create a custom BigCache config
• More tests for the internal client and rate limit
• Maybe implement custom HTTP traffic mocking, removing gock
• Improve DDragon/CDragon support

About

This is my first time developing and publishing an API client, I am constantly changing the project as I test and learn new things, please, check the commits for any breaking changes, this will change coming 1.0.0.

These projects helped me learn a lot:

• go-github
• golio
• Riven

Disclaimer

equinox isn't endorsed by Riot Games and doesn't reflect the views or opinions of Riot Games or anyone officially involved in producing or managing Riot Games properties. Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc.