yfinance

Documentation

Overview

Copyright 2022

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• func Download(asset *common.Asset)
• func Enrich(assets []*common.Asset, max int)
• func NumAssetsNeedingUpdate(assets []*common.Asset) int
• func RateLimit() *rate.Limiter
• type YFinanceAssetProfile
• type YFinanceESG
• type YFinancePrice
• type YFinanceQuoteSummary
• type YFinanceQuoteSummaryWrapper
• type YFinanceResult

Functions

func Download

func Download(asset *common.Asset)

Download retrieves data for the list of assets from Yahoo! Finance

func Enrich

func Enrich(assets []*common.Asset, max int)

func NumAssetsNeedingUpdate

func NumAssetsNeedingUpdate(assets []*common.Asset) int

func RateLimit

func RateLimit() *rate.Limiter

Types

type YFinanceAssetProfile

type YFinanceAssetProfile struct {
	Website           string `json:"website"`
	Industry          string `json:"industry"`
	Sector            string `json:"sector"`
	Summary           string `json:"longBusinessSummary"`
	FullTimeEmployees int    `json:"fullTimeEmployees"`
}

type YFinanceESG

type YFinanceESG struct {
	PeerGroup string `json:"peerGroup"`
}

type YFinancePrice

type YFinancePrice struct {
	Name string `json:"longName"`
}

type YFinanceQuoteSummary

type YFinanceQuoteSummary struct {
	AssetProfile *YFinanceAssetProfile `json:"assetProfile"`
	Price        *YFinancePrice        `json:"price"`
	Esg          *YFinanceESG          `json:"esgScores"`
}

type YFinanceQuoteSummaryWrapper

type YFinanceQuoteSummaryWrapper struct {
	Result []*YFinanceQuoteSummary `json:"result"`
}

type YFinanceResult

type YFinanceResult struct {
	Profile *YFinanceQuoteSummaryWrapper `json:"quoteSummary"`
}