votesmart

README

go-votesmart

A golang client for the Votesmart API.

Installation

$ go get dev.freespoke.com/go-votesmart

Usage

Create an API client instance using your API Key.

client, err := votesmart.New(os.Getenv("VOTESMART_API_KEY"))
if err != nil {
    t.Fatal(err)
}

Make requests by providing a VoteSmart response object, and a *url.Values containing desired URL params:

var resp votesmarttypes.CandidatesGetByLastname
vals := url.Values{}
vals.Add("lastName", "desantis")
vals.Add("electionYear", "2022")

if err := client.Invoke(context.Background(), &vals, &resp); err != nil {
    log.Fatal(err)
}

log.Println(resp)

Refer to the API Documentation for required and optional parameters. Do not set o or key, as the library handles these for you.

License

MIT

Documentation

Index

• type Client
  • func New(apiKey string, options ...Option) (Client, error)
• type Error
  • func (e Error) Error() string
• type Method
• type Option
  • func WithBaseURL(v string) Option
  • func WithClient(v *http.Client) Option

Types

type Client

type Client interface {
	Invoke(ctx context.Context, params *url.Values, dst Method) error
}

func New

func New(apiKey string, options ...Option) (Client, error)

type Error

type Error struct {
	ErrorMessage string `json:"errorMessage"`
}

func (Error) Error

func (e Error) Error() string

type Method

type Method interface {
	Method() string
}

type Option

type Option func(clientOptions) clientOptions

func WithBaseURL

func WithBaseURL(v string) Option

func WithClient

func WithClient(v *http.Client) Option