morningstar

Documentation

Index

• Constants
• type Client
  • func NewClient(_ context.Context, roundtripper transport.T) (*Client, error)
• type Token
  • func NewBearerToken(url, username, password string) (*Token, error)

Examples

• NewBearerToken

Constants

const (
	HouseholdsPath rawPath
)

const (
	HouseholdsRatelimiter ratelimiter
)

Types

type Client

type Client struct{ http.Client }

Client is a wrapper for http.Client.

func NewClient

func NewClient(_ context.Context, roundtripper transport.T) (*Client, error)

NewClient will return a new HTTP client to interface with the Morningstar API.

type Token

type Token struct {
	AccessToken string `bson:"access_token" json:"access_token" sql:"access_token"`
	ExpiresIn   int    `bson:"expires_in" json:"expires_in" sql:"expires_in"`
	TokenType   string `bson:"token_type" json:"token_type" sql:"token_type"`
}

Token is an OAuth bearer token authorized using a base64-encoded user id and password.

func NewBearerToken

func NewBearerToken(url, username, password string) (*Token, error)

NewBearerToken will generate a bearer token with base64-encrypted username and password.

Example

package main

import (
	"log"
	"os"

	"github.com/alpine-hodler/web/pkg/morningstar"
)

func main() {
	url := "https://www.us-api.morningstar.com/token/oauth"
	username := os.Getenv("MORNINGSTAR_USERNAME")
	password := os.Getenv("MORNINGSTAR_PASSWORD")

	token, err := morningstar.NewBearerToken(url, username, password)
	if err != nil {
		log.Fatalf("error posting client credentials: %v", err)
	}

	// Do something with our token
	os.Setenv("MORNINGSTAR_BEARER_TOKEN", token.AccessToken)
}