alpha

package

v0.0.0-...-988b7e1 Latest Latest Go to latest Published: Aug 23, 2022 License: MIT Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mhamm84/gofinance-alpha

Links

Open Source Insights

Documentation ¶

Index ¶

func GetAndDecode(ctx context.Context, httpClient *http.Client, endpoint string, dst interface{}) error
type Client
- func NewClient(baseUrl, token string) *Client
type Interval
- func (c Interval) String() string
type Maturity
- func (c Maturity) String() string
type Options
type ReportType

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetAndDecode ¶

func GetAndDecode(ctx context.Context, httpClient *http.Client, endpoint string, dst interface{}) error

GetAndDecode creates a new HTTP request with a Context using the passed in endpoint url The body is then JSON decoded to the dst pointer passed in

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func NewClient ¶

func NewClient(baseUrl, token string) *Client

NewClient creates a new Alpha Vantage client using a baseUrl and the token

func (*Client) EconomicData ¶

func (c *Client) EconomicData(ctx context.Context, reportType ReportType, opts *Options) (*data.EconomicResponse, error)

EconomicData Gets the monthly manufacturers' new orders of durable goods in the United States.

func (*Client) WithBaseUrl ¶

func (c *Client) WithBaseUrl(url string) *Client

WithBaseUrl overrides the baseUrl

func (*Client) WithHttpClient ¶

func (c *Client) WithHttpClient(httpClient *http.Client) *Client

WithHttpClient overrides the httpClient

type Interval ¶

type Interval int8

const (
	Daily Interval = iota + 1
	Monthly
	Quarterly
	SemiAnnual
	Annual
)

func (Interval) String ¶

func (c Interval) String() string

type Maturity ¶

type Maturity int8

const (
	ThreeMonth Maturity = iota + 1
	TwoYear
	FiveYear
	SevenYear
	TenYear
	ThirtyYear
)

func (Maturity) String ¶

func (c Maturity) String() string

type Options ¶

type Options struct {
	Interval Interval `url:"interval"`
	Maturity Maturity `url:"maturity"`
}

type ReportType ¶

type ReportType int

const (
	CPI ReportType = iota
	CONSUMER_SENTIMENT
	TREASURY_YIELD
	RETAIL_SALES
	REAL_GDP
	REAL_GDP_PER_CAPITA
	FED_FUNDS_RATE
	DURABLE_GOODS
	UNEMPLOYMENT
	NONFARM_PAYROLL
	INFLATION
	INFLATION_EXPECTATION
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
data

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL