api

Documentation

Index

• Constants
• Variables
• type EquinoxConfig
• type ErrorResponse
  • func (e ErrorResponse) Error() string
• type LOLRegion
• type Route
• type Status

Constants

const (
	// Base API URL format
	BaseURLFormat = "https://%s.api.riotgames.com"
)

Variables

var (
	NotFoundError = ErrorResponse{
		Status: Status{
			Message:    "Not Found",
			StatusCode: http.StatusNotFound,
		},
	}

	ForbiddenError = ErrorResponse{
		Status: Status{
			Message:    "Forbidden",
			StatusCode: http.StatusForbidden,
		},
	}

	UnauthorizedError = ErrorResponse{
		Status: Status{
			Message:    "Unauthorized",
			StatusCode: http.StatusUnauthorized,
		},
	}
)

Types

type EquinoxConfig

type EquinoxConfig struct {
	// Riot API Key.
	Key string
	// Debug mode. Default: false
	Debug bool
	// Timeout for http.Request in seconds, 0 disables it. Default: 10
	Timeout time.Duration
	// Retry request if it returns a 429 status code. Default: true
	Retry bool
}

An config object for the EquinoxClient.

type ErrorResponse

type ErrorResponse struct {
	Status Status `json:"status"`
}

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

type LOLRegion

type LOLRegion string

const (
	LOLRegionBR1  LOLRegion = "br1"
	LOLRegionEUN1 LOLRegion = "eun1"
	LOLRegionEUW1 LOLRegion = "euw1"
	LOLRegionJP1  LOLRegion = "jp1"
	LOLRegionKR   LOLRegion = "kr"
	LOLRegionLA1  LOLRegion = "la1"
	LOLRegionLA2  LOLRegion = "la2"
	LOLRegionNA1  LOLRegion = "na1"
	LOLRegionOC1  LOLRegion = "oc1"
	LOLRegionRU   LOLRegion = "ru"
	LOLRegionTR1  LOLRegion = "tr1"
)

League of Legends and Teamfight Tactics regions

type Route

type Route string

const (
	RouteAmericas Route = "americas"
	RouteEurope   Route = "europe"
	RouteAsia     Route = "asia"
)

Riot API routes

type Status

type Status struct {
	Message    string `json:"message"`
	StatusCode int    `json:"status_code"`
}