Go YFinance

https://github.com/wnjoon/go-yfinance
Admin
Go YFinance is an unofficial Go port of the popular Python yfinance library that retrieves financial...
Tokens:126,686
Snippets:1,138
Trust Score:7.1
License:Apache-2.0
Update:7 months ago
Show doc for...
Tokens:
Raw
### Get Stock List Example in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Provides an example of how to fetch stocks using the Stock method and then iterate over the results to display the symbol and name of each stock. Error handling for the fetch operation is included.

```go
stocks, err := l.Stock(10)
for _, doc := range stocks {
    fmt.Printf("%s: %s\n", doc.Symbol, doc.Name)
}
```

--------------------------------

### Get Mutual Fund List Example in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

An example demonstrating how to fetch mutual funds using the MutualFund method and iterate through the results to print their symbols and names. It handles potential errors during the fetch operation.

```go
funds, err := l.MutualFund(10)
for _, doc := range funds {
    fmt.Printf("%s: %s\n", doc.Symbol, doc.Name)
}
```

--------------------------------

### Basic Cache Usage Example

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Illustrates the fundamental usage of the cache package, including creating a new cache instance, setting a value with a TTL, and retrieving that value. It demonstrates the common pattern of checking the `ok` boolean returned by `Get`.

```go
c := cache.New(cache.WithTTL(5 * time.Minute))
c.Set("AAPL:tz", "America/New_York")
if tz, ok := c.Get("AAPL:tz"); ok {
    fmt.Println(tz)
}
```

--------------------------------

### Fund Screener Example (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/RELEASE_NOTES_v1.2.0.md

Demonstrates how to use predefined fund screeners to retrieve a list of funds. This example uses `models.ScreenerConservativeForeign` and iterates through the results, printing symbol, category name, and performance rating.

```go
result, err := s.Screen(models.ScreenerConservativeForeign, nil)
for _, quote := range result.Quotes {
    fmt.Printf("%s: %s (Rating: %d)\n",
        quote.Symbol, quote.CategoryName, quote.PerformanceRatingOverall)
}
```

--------------------------------

### Install go-yfinance v1.2.0

Source: https://github.com/wnjoon/go-yfinance/blob/main/RELEASE_NOTES_v1.2.0.md

This command installs a specific version (v1.2.0) of the go-yfinance library using the Go build tool. This is useful for ensuring project compatibility or reproducibility.

```bash
go get github.com/wnjoon/go-yfinance@v1.2.0
```

--------------------------------

### Industry Data Retrieval Example in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Provides an example of how to retrieve and use industry data. It shows initializing a new industry object, fetching its data, and printing the industry name and sector name. This requires the 'industry' package.

```go
i, err := industry.New("semiconductors")
if err != nil {
    log.Fatal(err)
}
data, err := i.Data()
fmt.Printf("Industry: %s in Sector: %s\n", data.Name, data.SectorName)
```

--------------------------------

### Start Listening for WebSocket Messages (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

The Listen method starts a blocking process to receive and handle incoming WebSocket messages. It requires a MessageHandler function to process each message and continues until Close() is called or an error occurs.

```go
func (ws *WebSocket) Listen(handler MessageHandler) error {
    // ... implementation details ...
}
```

--------------------------------

### Get Market Summary Data in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Fetches and displays a summary of major market indices. The example iterates through the returned market summary, printing the short name, regular market price, and regular market change percentage for each exchange.

```go
summary, err := m.Summary()
if err != nil {
    log.Fatal(err)
}
for exchange, item := range summary {
    fmt.Printf("%s: %.2f (%.2f%%)\n",
        item.ShortName,
        item.RegularMarketPrice,
        item.RegularMarketChangePercent)
}
```

--------------------------------

### Install go-yfinance Package

Source: https://github.com/wnjoon/go-yfinance/blob/main/README.md

This command installs the go-yfinance library using the Go toolchain. It fetches the latest version of the package and makes it available for use in your Go projects.

```bash
go get github.com/wnjoon/go-yfinance
```

--------------------------------

### Config: Get the global configuration instance

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

The Get function returns the singleton instance of the global configuration for go-yfinance. This allows access to and modification of the current global settings.

```go
func Get() *Config {
	// ... implementation details ...
}
```

--------------------------------

### Perform HTTP GET Request (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

The Get method executes an HTTP GET request to a specified URL with optional query parameters. It returns a Response object containing the status code, body, and headers, or an error if the request fails. Dependencies include the 'net/url' package for query parameters.

```Go
func (c *Client) Get(rawURL string, params url.Values) (*Response, error) {
  // Implementation details...
}
```

--------------------------------

### GET /calendars/ipos

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves upcoming and recent IPO information from Yahoo Finance.

```APIDOC
## GET /calendars/ipos

### Description
Retrieves upcoming and recent IPO information from Yahoo Finance.

### Method
GET

### Endpoint
`/calendars/ipos`

### Query Parameters
- **Limit** (int) - Optional - Maximum number of results to return (capped at 100).
- **Offset** (int) - Optional - Pagination offset.
- **Start** (time.Time) - Optional - Start date for the query.
- **End** (time.Time) - Optional - End date for the query.

### Request Example
```go
ipos, err := cal.IPOs(nil)

// With specific options
opts := &models.CalendarOptions{
    Limit: 20,
}
ipos, err := cal.IPOs(opts)
```

### Response
#### Success Response (200)
- **[]models.IPO** - A list of IPO details.
  - **Symbol** (string) - The stock symbol.
  - **CompanyName** (string) - The name of the company.
  - **PriceFrom** (float64) - The lower end of the estimated IPO price range.
  - **PriceTo** (float64) - The upper end of the estimated IPO price range.

#### Response Example
```json
[
  {
    "Symbol": "XYZ",
    "CompanyName": "XYZ Corp.",
    "PriceFrom": 15.00,
    "PriceTo": 17.00
  }
]
```
```

--------------------------------

### GET /calendars/splits

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves stock split events from Yahoo Finance.

```APIDOC
## GET /calendars/splits

### Description
Retrieves stock split events from Yahoo Finance.

### Method
GET

### Endpoint
`/calendars/splits`

### Query Parameters
- **Limit** (int) - Optional - Maximum number of results to return (capped at 100).
- **Offset** (int) - Optional - Pagination offset.
- **Start** (time.Time) - Optional - Start date for the query.
- **End** (time.Time) - Optional - End date for the query.

### Request Example
```go
splits, err := cal.Splits(nil)

// With specific options
opts := &models.CalendarOptions{
    End: time.Now(),
    Limit: 10,
}
splits, err := cal.Splits(opts)
```

### Response
#### Success Response (200)
- **[]models.Split** - A list of stock split details.
  - **Symbol** (string) - The stock symbol.
  - **CompanyName** (string) - The name of the company.
  - **Ratio** (string) - The ratio of the stock split (e.g., "2:1").

#### Response Example
```json
[
  {
    "Symbol": "MSFT",
    "CompanyName": "Microsoft Corporation",
    "Ratio": "3:2"
  }
]
```
```

--------------------------------

### Define SectorData Structure and Usage Example in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Defines the SectorData struct, containing comprehensive data for a financial sector, including overview, top companies, industries, ETFs, mutual funds, and research reports. An example shows how to fetch and access sector data.

```go
type SectorData struct {
    // Key is the sector identifier.
    Key string `json:"key"`

    // Name is the display name of the sector.
    Name string `json:"name"`

    // Symbol is the associated symbol (e.g., index symbol).
    Symbol string `json:"symbol,omitempty"`

    // Overview contains sector overview information.
    Overview SectorOverview `json:"overview"`

    // TopCompanies lists the top companies in the sector.
    TopCompanies []SectorTopCompany `json:"top_companies,omitempty"`

    // Industries lists the industries within the sector.
    Industries []SectorIndustry `json:"industries,omitempty"`

    // TopETFs maps ETF symbols to names.
    TopETFs map[string]string `json:"top_etfs,omitempty"`

    // TopMutualFunds maps mutual fund symbols to names.
    TopMutualFunds map[string]string `json:"top_mutual_funds,omitempty"`

    // ResearchReports contains research reports for the sector.
    ResearchReports []ResearchReport `json:"research_reports,omitempty"`
}
```

```go
s, err := sector.New("technology")
if err != nil {
    log.Fatal(err)
}
data, err := s.Data()
fmt.Printf("Sector: %s has %d companies\n", data.Name, data.Overview.CompaniesCount)
```

--------------------------------

### Basic Market Usage Example in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates the basic usage of the Market package, including creating a market instance, retrieving market status (opening times and timezone), and handling potential errors. It uses `defer m.Close()` for resource cleanup.

```go
m, err := market.New("us_market")
if err != nil {
    log.Fatal(err)
}
defer m.Close()

status, err := m.Status()
if err != nil {
    log.Fatal(err)
}
if status.Open != nil {
    fmt.Printf("Market opens at: %s\n", status.Open.Format("15:04"))
}
fmt.Printf("Timezone: %s\n", status.Timezone.Short)
```

--------------------------------

### Initialize go-yfinance Client

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to create a new go-yfinance client instance with custom options like timeout and user agent. It includes basic error checking and resource cleanup.

```go
c, err := client.New(
    client.WithTimeout(30),
    client.WithUserAgent("Custom UA"),
)
if err != nil {
    log.Fatal(err)
}
defer c.Close()

resp, err := c.Get("https://query2.finance.yahoo.com/v8/finance/chart/AAPL", nil)
```

--------------------------------

### Get Default Search Parameters in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Provides the DefaultSearchParams function, which returns a SearchParams struct initialized with default values. This is useful for starting a search without manually setting every parameter.

```go
func DefaultSearchParams() SearchParams
```

--------------------------------

### Initialize Market with Custom HTTP Client in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to initialize a Market instance with a custom HTTP client. This allows for fine-grained control over network requests, such as setting specific headers or timeouts.

```go
c, _ := client.New()
m, _ := market.New("us_market", market.WithClient(c))
```

--------------------------------

### Get Default Download Parameters

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

DefaultDownloadParams is a function that returns a DownloadParams struct with default values. This provides a convenient starting point for users who want to download data without specifying every parameter.

```go
func DefaultDownloadParams() DownloadParams
```

--------------------------------

### Lookup Example Usage (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to perform a lookup for financial instruments using the go-yfinance library. It shows initializing a lookup with a symbol, fetching all results up to a specified count, and iterating through the results to print details.

```go
l, err := lookup.New("AAPL")
if err != nil {
    log.Fatal(err)
}
results, err := l.All(10)
for _, doc := range results {
    fmt.Printf("%s: %s (%s)\n", doc.Symbol, doc.Name, doc.Exchange)
}
```

--------------------------------

### Get Insider Transactions - Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves a list of insider transactions, including purchases and sales by company insiders. It returns a slice of models.InsiderTransaction and an error if the operation fails. The example demonstrates iterating through transactions and printing details.

```Go
func (t *Ticker) InsiderTransactions() ([]models.InsiderTransaction, error)

transactions, err := ticker.InsiderTransactions()
if err != nil {
    log.Fatal(err)
}
for _, tx := range transactions {
    fmt.Printf("%s: %s %d shares on %s\n",
        tx.Insider, tx.Transaction, tx.Shares, tx.StartDate.Format("2006-01-02"))
}
```

--------------------------------

### Use Predefined Screener with Query Options (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Shows how to use a predefined screener, such as 'day_gainers', and pass additional query options. This example retrieves the top gaining stocks and demonstrates error handling and result iteration.

```go
import (
    "fmt"
    "log"

    "github.com/wnjoon/go-yfinance/pkg/models"
    "github.com/wnjoon/go-yfinance/pkg/screener"
)

func main() {
    s, err := screener.New()
    if err != nil {
        log.Fatal(err)
    }
    defer s.Close()

    // Use predefined screener
    result, err := s.Screen(models.ScreenerDayGainers, nil)
    if err != nil {
        log.Fatal(err)
    }
    for _, quote := range result.Quotes {
        fmt.Printf("%s: %.2f%%\n", quote.Symbol, quote.RegularMarketChangePercent)
    }
}
```

--------------------------------

### Get Mutual Fund Holders - Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Fetches a list of mutual fund holders for a ticker. Each holder record contains the fund name, shares held, value, and percentage. The example iterates through the holders and prints their names and shares.

```Go
func (t *Ticker) MutualFundHolders() ([]models.Holder, error)

holders, err := ticker.MutualFundHolders()
if err != nil {
    log.Fatal(err)
}
for _, h := range holders {
    fmt.Printf("%s: %d shares\n", h.Holder, h.Shares)
}
```

--------------------------------

### Global Cache Basic Usage Example

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Shows how to use the convenience functions for the global cache instance. This includes setting a key-value pair and then retrieving it. This approach simplifies cache management when a single, shared cache is desired.

```go
cache.SetGlobal("key", "value")
value, ok := cache.GetGlobal("key")
```

--------------------------------

### Get Institutional Holders - Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Fetches a list of institutional holders for a given ticker. Each holder's information includes the institution name, shares held, value, and percentage. The example shows how to iterate and print holder details.

```Go
func (t *Ticker) InstitutionalHolders() ([]models.Holder, error)

holders, err := ticker.InstitutionalHolders()
if err != nil {
    log.Fatal(err)
}
for _, h := range holders {
    fmt.Printf("%s: %d shares (%.2f%%)\n", h.Holder, h.Shares, h.PctHeld*100)
}
```

--------------------------------

### Get Major Holders Breakdown - Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves a breakdown of major holders, including percentages held by insiders and institutions, as well as the institutional count. The function returns a pointer to models.MajorHolders or an error. The example prints insider and institution percentages.

```Go
func (t *Ticker) MajorHolders() (*models.MajorHolders, error)

holders, err := ticker.MajorHolders()
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Insiders: %.2f%%\n", holders.InsidersPercentHeld*100)
fmt.Printf("Institutions: %.2f%%\n", holders.InstitutionsPercentHeld*100)
```

--------------------------------

### Initialize and Use Search in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates the basic usage of the search package to initialize a new search instance, perform a search for a stock symbol (e.g., 'AAPL'), and iterate through the quote results. It includes error handling and resource cleanup.

```go
s, err := search.New()
if err != nil {
    log.Fatal(err)
}
defer s.Close()

result, err := s.Search("AAPL")
if err != nil {
    log.Fatal(err)
}
for _, quote := range result.Quotes {
    fmt.Printf("%s: %s (%s)\n", quote.Symbol, quote.ShortName, quote.Exchange)
}
```

--------------------------------

### Build and Execute Custom Stock Screener Query (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Illustrates how to construct a custom stock screening query using predefined operators and criteria. This example filters for US technology stocks with a price greater than $50. It shows the process of building a query object and executing it.

```go
import (
    "log"

    "github.com/wnjoon/go-yfinance/pkg/models"
    "github.com/wnjoon/go-yfinance/pkg/screener"
)

func main() {
    s, err := screener.New()
    if err != nil {
        log.Fatal(err)
    }
    defer s.Close()

    // Find US tech stocks with price > $50
    query := models.NewEquityQuery(models.OpAND, []interface{}{
        models.NewEquityQuery(models.OpEQ, []interface{}{"region", "us"}),
        models.NewEquityQuery(models.OpEQ, []interface{}{"sector", "Technology"}),
        models.NewEquityQuery(models.OpGT, []interface{}{"intradayprice", 50}),
    })
    result, err := s.ScreenWithQuery(query, nil)
    if err != nil {
        log.Fatal(err)
    }
    // Process result...
}
```

--------------------------------

### Configure Sector with Custom HTTP Client (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Shows how to initialize a sector object with a custom HTTP client. This allows for advanced configurations such as setting timeouts, custom headers, or using specific transport settings for network requests.

```Go
import "github.com/wnjoon/go-yfinance/pkg/client"

c, _ := client.New()
s, _ := sector.New("technology", sector.WithClient(c))
```

--------------------------------

### Initialize Screener and Get Day Gainers (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to initialize the screener client and retrieve a list of stocks with the highest percentage gain for the day. It handles potential errors during initialization and data retrieval, then iterates through the results to print the symbol and gain percentage.

```go
import (
    "fmt"
    "log"

    "github.com/wnjoon/go-yfinance/pkg/screener"
)

func main() {
    s, err := screener.New()
    if err != nil {
        log.Fatal(err)
    }
    defer s.Close()

    result, err := s.DayGainers(10)
    if err != nil {
        log.Fatal(err)
    }
    for _, quote := range result.Quotes {
        fmt.Printf("%s: %.2f%%\n", quote.Symbol, quote.RegularMarketChangePercent)
    }
}
```

--------------------------------

### Implement Get Method for MultiTickerResult in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Implements the Get method for the MultiTickerResult struct. This method retrieves the historical data (slice of Bar) for a specific ticker symbol.

```go
func (r *MultiTickerResult) Get(symbol string) []Bar {
    return r.Data[symbol]
}
```

--------------------------------

### Initialize Market with Predefined Constants in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Shows how to initialize a Market instance using predefined constants for different global markets, such as `models.MarketUS`, `models.MarketJP`, and `models.MarketGB`. This simplifies selecting common markets.

```go
m, _ := market.NewWithPredefined(models.MarketUS)  // US market
m, _ := market.NewWithPredefined(models.MarketJP)  // Japan market
m, _ := market.NewWithPredefined(models.MarketGB)  // UK market
```

--------------------------------

### Calendar Struct Definition and Example (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Represents upcoming calendar events for a financial ticker, including dividend and earnings dates. The example demonstrates how to fetch and display this information.

```Go
type Calendar struct {
    // DividendDate is the next dividend payment date.
    DividendDate *time.Time `json:"dividendDate,omitempty"`

    // ExDividendDate is the ex-dividend date (must own before this date).
    ExDividendDate *time.Time `json:"exDividendDate,omitempty"`

    // EarningsDate contains the expected earnings announcement date(s).
    // Often contains a range (start and end date).
    EarningsDate []time.Time `json:"earningsDate,omitempty"`

    // EarningsHigh is the highest earnings estimate.
    EarningsHigh *float64 `json:"earningsHigh,omitempty"`

    // EarningsLow is the lowest earnings estimate.
    EarningsLow *float64 `json:"earningsLow,omitempty"`

    // EarningsAverage is the average earnings estimate.
    EarningsAverage *float64 `json:"earningsAverage,omitempty"`

    // RevenueHigh is the highest revenue estimate.
    RevenueHigh *float64 `json:"revenueHigh,omitempty"`

    // RevenueLow is the lowest revenue estimate.
    RevenueLow *float64 `json:"revenueLow,omitempty"`

    // RevenueAverage is the average revenue estimate.
    RevenueAverage *float64 `json:"revenueAverage,omitempty"`
}
// Calendar represents upcoming calendar events for a ticker.
// This includes dividend dates, earnings dates, and earnings estimates.

// Example:
// ```
// calendar, err := ticker.Calendar()
// if err != nil {
//     log.Fatal(err)
// }
// if calendar.ExDividendDate != nil {
//     fmt.Printf("Ex-Dividend: %s\n", calendar.ExDividendDate.Format("2006-01-02"))
// }
// for _, date := range calendar.EarningsDate {
//     fmt.Printf("Earnings: %s\n", date.Format("2006-01-02"))
// }
// ```
```

--------------------------------

### Initialize and Use Sector Data in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Shows the basic usage of the sector package to retrieve financial sector information. It covers initializing a sector instance, fetching its overview data, and handling potential errors. The Close method should be deferred for resource management.

```Go
import "github.com/wnjoon/go-yfinance/pkg/sector"
import "log"
import "fmt"

s, err := sector.New("technology")
if err != nil {
    log.Fatal(err)
}
defer s.Close()

// Get sector overview
overview, err := s.Overview()
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Companies: %d\n", overview.CompaniesCount)
fmt.Printf("Market Cap: $%.2f\n", overview.MarketCap)
```

--------------------------------

### Cache Instance Creation and Configuration

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to create a new cache instance with optional configurations, such as setting a custom Time-To-Live (TTL) for cache entries. The `New` function accepts variadic `Option` arguments to customize cache behavior.

```go
func New(opts ...Option) *Cache

// Example Usage:
c := cache.New(cache.WithTTL(5 * time.Minute))
```

--------------------------------

### Go Calendars Package Initialization and Basic Usage

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to initialize the calendars package and retrieve earnings data. It shows error handling and closing the calendar client, along with iterating through earnings results.

```go
import "github.com/wnjoon/go-yfinance/pkg/calendars"
import "time"
import "log"
import "fmt"

// Package calendars provides Yahoo Finance economic calendar functionality.

// Basic Usage Example:
// cal, err := calendars.New()
// if err != nil {
//     log.Fatal(err)
// }
// defer cal.Close()

// // Get earnings calendar
// earnings, err := cal.Earnings(nil)
// if err != nil {
//     log.Fatal(err)
// }
// for _, e := range earnings {
//     fmt.Printf("%s: %s, EPS Est: %.2f\n",
//         e.Symbol, e.CompanyName, e.EPSEstimate)
// }
```

--------------------------------

### Find Contiguous True Blocks in Boolean Slice (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Identifies contiguous blocks of 'true' values within a boolean slice. It returns a slice of [start, end) index pairs, where 'start' is inclusive and 'end' is exclusive.

```go
import "github.com/wnjoon/go-yfinance/pkg/stats"

// Example usage:
mask := []bool{false, true, true, false, true, true, true, false}
blocks := stats.FindBlocks(mask)
// blocks will be [][2]int{{1, 3}, {4, 7}}

```

--------------------------------

### Create New Sector Instance with Key

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Creates a new Sector instance using a sector key. Sector keys are lowercase and hyphen-separated (e.g., 'technology'). Predefined constants from the 'models' package can be used for convenience. Handles potential errors during creation and requires closing the instance when done.

```go
func New(key string, opts ...Option) (*Sector, error)
```

--------------------------------

### Quick Start for go-yfinance Ticker Package

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to create a new ticker for a stock symbol, fetch its quote, and retrieve historical data using the go-yfinance ticker package. Includes error handling and deferred closing of the ticker.

```go
import "github.com/wnjoon/go-yfinance/pkg/ticker"
import "log"
import "github.com/wnjoon/go-yfinance/pkg/models"

func main() {
    // Create a ticker
    t, err := ticker.New("AAPL")
    if err != nil {
        log.Fatal(err)
    }
    defer t.Close()

    // Get current quote
    quote, err := t.Quote()
    if err != nil {
        log.Fatal(err)
    }
    _ = quote // Use quote variable

    // Get historical data
    history, err := t.History(models.HistoryParams{
        Period:   "1mo",
        Interval: "1d",
    })
    if err != nil {
        log.Fatal(err)
    }
    _ = history // Use history variable
}
```

--------------------------------

### New Market Instance

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Creates a new Market instance for a specified market identifier. Allows for custom configuration via options.

```APIDOC
## POST /market/new

### Description
Initializes a new Market instance for a given market identifier. Custom HTTP clients can be provided using options.

### Method
POST

### Endpoint
/market/new

### Parameters
#### Request Body
- **market** (string) - Required - The identifier for the market (e.g., "us_market").
- **client** (*client.Client) - Optional - A custom HTTP client to use for requests.

### Request Example
```json
{
  "market": "us_market",
  "client": null // or a custom client object if available
}
```

### Response
#### Success Response (200)
- ***Market** - A pointer to the initialized Market instance.

#### Response Example
```json
// Returns a Market instance, represented abstractly here.
{}
```
```

--------------------------------

### Define SearchResult Structure and Usage Example in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Defines the SearchResult struct, representing the complete search response from Yahoo Finance, including quotes, news, lists, and research reports. An example demonstrates how to use the search function and iterate through results.

```go
type SearchResult struct {
    // Quotes contains matching stock/asset quotes.
    Quotes []SearchQuote `json:"quotes"`

    // News contains related news articles.
    News []SearchNews `json:"news,omitempty"`

    // Lists contains Yahoo Finance lists.
    Lists []SearchList `json:"lists,omitempty"`

    // Research contains research reports (if requested).
    Research []SearchResearch `json:"research,omitempty"`

    // Nav contains navigation links (if requested).
    Nav []SearchNav `json:"nav,omitempty"`

    // TotalCount is the total number of matching results.
    TotalCount int `json:"totalCount,omitempty"`
}
```

```go
result, err := search.Search("AAPL")
if err != nil {
    log.Fatal(err)
}
for _, quote := range result.Quotes {
    fmt.Printf("%s: %s\n", quote.Symbol, quote.ShortName)
}
```

--------------------------------

### Fetch Top ETFs and Mutual Funds (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

This example shows how to retrieve lists of top Exchange Traded Funds (ETFs) and mutual funds associated with a financial sector. It calls the respective methods and stores the results, though further processing of these results is not shown.

```Go
etfs, err := s.TopETFs()
funds, err := s.TopMutualFunds()
```

--------------------------------

### Example Usage of ScreenerResult in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to use the ScreenerResult type to process stock screener query results. It shows fetching data, handling errors, and iterating through quotes to display stock symbols and their percentage changes.

```go
result, err := screener.Screen(screener.DayGainers, nil)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Found %d stocks\n", result.Total)
for _, quote := range result.Quotes {
    fmt.Printf("%s: %.2f%%\n", quote.Symbol, quote.PercentChange)
}
```

--------------------------------

### Perform HTTP GET and Unmarshal JSON (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

The GetJSON method performs an HTTP GET request and automatically unmarshals the JSON response into a provided interface value. It returns an error if the request fails or if JSON unmarshaling encounters an issue. Dependencies include the 'encoding/json' package.

```Go
func (c *Client) GetJSON(rawURL string, params url.Values, v interface{}) error {
  // Implementation details...
}
```

--------------------------------

### New Market Instance with Predefined

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Creates a new Market instance using a predefined market identifier. Allows for custom configuration via options.

```APIDOC
## POST /market/new_predefined

### Description
Initializes a new Market instance using one of the predefined market identifiers (e.g., models.MarketUS). Custom HTTP clients can be provided using options.

### Method
POST

### Endpoint
/market/new_predefined

### Parameters
#### Request Body
- **market** (models.PredefinedMarket) - Required - The predefined market identifier (e.g., models.MarketUS).
- **client** (*client.Client) - Optional - A custom HTTP client to use for requests.

### Request Example
```json
{
  "market": "us_market", // Corresponds to models.MarketUS
  "client": null // or a custom client object if available
}
```

### Response
#### Success Response (200)
- ***Market** - A pointer to the initialized Market instance.

#### Response Example
```json
// Returns a Market instance, represented abstractly here.
{}
```
```

--------------------------------

### Configure Tickers with Options in Go (multi package)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Explains the use of `Option` functions to configure `Tickers` instances, such as setting a custom HTTP client using `WithClient`. This allows for advanced customization of how the `Tickers` collection interacts with external services.

```go
import "github.com/wnjoon/go-yfinance/pkg/multi"
import "github.com/wnjoon/go-yfinance/pkg/client"
import "net/http"

// ...

customClient := &http.Client{}
tickers, err := multi.NewTickers([]string{"AAPL"}, multi.WithClient(customClient))
if err != nil {
    log.Fatal(err)
}
defer tickers.Close()
```

--------------------------------

### GET /calendars/economic-events

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves economic releases and indicators from Yahoo Finance.

```APIDOC
## GET /calendars/economic-events

### Description
Retrieves economic releases and indicators from Yahoo Finance.

### Method
GET

### Endpoint
`/calendars/economic-events`

### Query Parameters
- **Limit** (int) - Optional - Maximum number of results to return (capped at 100).
- **Offset** (int) - Optional - Pagination offset.
- **Start** (time.Time) - Optional - Start date for the query.
- **End** (time.Time) - Optional - End date for the query.

### Request Example
```go
events, err := cal.EconomicEvents(nil)

// With specific options
opts := &models.CalendarOptions{
    Start: time.Now().AddDate(0, -1, 0), // Last month
    Limit: 30,
}
events, err := cal.EconomicEvents(opts)
```

### Response
#### Success Response (200)
- **[]models.EconomicEvent** - A list of economic event details.
  - **Event** (string) - The name of the economic event.
  - **Region** (string) - The region associated with the event.
  - **Expected** (float64) - The expected value for the indicator.
  - **Actual** (float64) - The actual value of the indicator.

#### Response Example
```json
[
  {
    "Event": "Non-Farm Payrolls",
    "Region": "US",
    "Expected": 180000.00,
    "Actual": 200000.00
  }
]
```
```

--------------------------------

### Stock Split Repair Example in go-yfinance

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/advanced/price-repair.md

Shows how to enable stock split repair in go-yfinance to correct historical prices when Yahoo Finance fails to apply split adjustments. The example demonstrates setting 'FixSplits' to true in RepairOptions. This repair uses IQR-based outlier detection and volume analysis to identify and correct split-related inaccuracies.

```go
import (
    "github.com/wnjoon/go-yfinance/pkg/ticker"
    "github.com/wnjoon/go-yfinance/pkg/models"
)

// Assuming 't' is an initialized ticker object
// t, _ := ticker.New("AAPL")

// Check for split repair
bars, _ := t.History(models.HistoryParams{
    Period:   "max",
    Interval: "1wk",
    Repair:   true,
    RepairOptions: &models.RepairOptions{
        FixSplits: true,
    },
})

```

--------------------------------

### Initialize Market Instance in Go

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Creates a new Market instance for a specified market identifier. It can optionally accept functional options to customize its behavior, such as providing a custom HTTP client. Returns a pointer to a Market instance and an error.

```go
func New(market string, opts ...Option) (*Market, error)
```

--------------------------------

### Dividend Repair Example in go-yfinance

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/advanced/price-repair.md

Demonstrates enabling the dividend repair functionality in go-yfinance to fix various dividend-related data errors. This includes missing adjustments, incorrect currency units (100x errors), and phantom dividends. The example shows how to set 'FixDividends' to true in RepairOptions. Note that this repair is only reliably applied to '1d' intervals.

```go
import (
    "github.com/wnjoon/go-yfinance/pkg/ticker"
    "github.com/wnjoon/go-yfinance/pkg/models"
)

// Assuming 't' is an initialized ticker object
// t, _ := ticker.New("AAPL")

// Fix dividend errors
bars, _ := t.History(models.HistoryParams{
    Period:   "1y",
    Interval: "1d",
    Repair:   true,
    RepairOptions: &models.RepairOptions{
        FixDividends: true,
    },
})

```

--------------------------------

### Get Ticker Symbol

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Returns the stock symbol associated with the Ticker object.

```go
func (t *Ticker) Symbol() string {
    // ... implementation details ...
}

```

--------------------------------

### Configure History Data Fetching with HistoryParams (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates how to configure historical data fetching using the HistoryParams struct. This includes setting the period, interval, and whether to include pre/post market data. Valid periods and intervals can be found in the library's documentation.

```go
params := models.HistoryParams{
    Period:   "1mo",      // 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max
    Interval: "1d",       // 1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo, 3mo
    PrePost:  false,      // Include pre/post market data
}

```

--------------------------------

### Configuration Options

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Functions for configuring Market instances, such as setting a custom HTTP client.

```APIDOC
## POST /market/options/client

### Description
Sets a custom HTTP client for the Market instance. This allows for advanced network configurations.

### Method
POST

### Endpoint
/market/options/client

### Parameters
#### Query Parameters
- **client** (*client.Client) - Required - The custom HTTP client to use.

### Request Example
```go
// Assuming 'customClient' is an initialized *http.Client
option := market.WithClient(customClient)
m, err := market.New("us_market", option)
if err != nil {
    log.Fatal(err)
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation that the option is set.

#### Response Example
```json
{
  "message": "HTTP client option applied."
}
```
```

--------------------------------

### Sector Initialization

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Provides methods for creating a new Sector instance, either with a sector key or a predefined sector constant. It also includes an option to set a custom HTTP client.

```APIDOC
## Sector Initialization

### Description
Methods for creating a new Sector instance.

### `New(key string, opts ...Option) (*Sector, error)`
Creates a new Sector instance for the given sector key.

**Parameters**
- `key` (string) - Required - The sector key (e.g., "technology").
- `opts` (Option) - Optional - Options to configure the Sector instance.

### `NewWithPredefined(sector models.PredefinedSector, opts ...Option) (*Sector, error)`
Creates a new Sector instance using a predefined sector constant.

**Parameters**
- `sector` (models.PredefinedSector) - Required - The predefined sector constant.
- `opts` (Option) - Optional - Options to configure the Sector instance.

### `WithClient(c *client.Client) Option`
Sets a custom HTTP client for the Sector instance.

**Parameters**
- `c` (*client.Client) - Required - The custom HTTP client.
```

--------------------------------

### GET /calendars/earnings

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves upcoming and recent earnings announcements from Yahoo Finance.

```APIDOC
## GET /calendars/earnings

### Description
Retrieves upcoming and recent earnings announcements from Yahoo Finance.

### Method
GET

### Endpoint
`/calendars/earnings`

### Query Parameters
- **Limit** (int) - Optional - Maximum number of results to return (capped at 100).
- **Offset** (int) - Optional - Pagination offset.
- **Start** (time.Time) - Optional - Start date for the query.
- **End** (time.Time) - Optional - End date for the query.

### Request Example
```go
// Using default options
earnings, err := cal.Earnings(nil)

// With specific options
opts := &models.CalendarOptions{
    Start:  time.Now(),
    End:    time.Now().AddDate(0, 0, 30),
    Limit:  50,
    Offset: 0,
}
earnings, err := cal.Earnings(opts)
```

### Response
#### Success Response (200)
- **[]models.Earning** - A list of earning announcement details.
  - **Symbol** (string) - The stock symbol.
  - **CompanyName** (string) - The name of the company.
  - **EPSEstimate** (float64) - The estimated Earnings Per Share.
  - **EPSActual** (float64) - The actual Earnings Per Share.
  - **SurprisePercent** (float64) - The surprise percentage.

#### Response Example
```json
[
  {
    "Symbol": "AAPL",
    "CompanyName": "Apple Inc.",
    "EPSEstimate": 1.50,
    "EPSActual": 1.55,
    "SurprisePercent": 3.33
  }
]
```
```

--------------------------------

### Capital Gains Repair Example in go-yfinance

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/advanced/price-repair.md

Illustrates how to specifically enable and apply the capital gains repair for ETFs and Mutual Funds using go-yfinance. This repair addresses the issue where capital gains might be double-counted in the Adjusted Close price. The example shows how to instantiate a ticker, fetch history with 'FixCapitalGains' enabled, and then iterate through the bars to check which ones were repaired.

```go
import (
    "github.com/wnjoon/go-yfinance/pkg/ticker"
    "github.com/wnjoon/go-yfinance/pkg/models"
    "fmt"
)

// For ETF with capital gains
t, _ := ticker.New("VWILX")

bars, _ := t.History(models.HistoryParams{
    Period:   "1y",
    Interval: "1d",
    Repair:   true,
    RepairOptions: &models.RepairOptions{
        FixCapitalGains: true,
    },
})

// Check if any bars were repaired
for _, bar := range bars {
    if bar.Repaired {
        fmt.Printf("%s was repaired\n", bar.Date)
    }
}

```

--------------------------------

### Manage Multiple Tickers with Tickers Class in Go (multi package)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Shows how to create and manage a collection of ticker symbols using the `multi.Tickers` class. It demonstrates initializing `Tickers` with a list of symbols, accessing individual tickers, retrieving their information, and downloading historical data for all managed tickers. The `defer tickers.Close()` ensures resources are released.

```go
import "github.com/wnjoon/go-yfinance/pkg/multi"
import "log"

// ...

tickers, err := multi.NewTickers([]string{"AAPL", "MSFT", "GOOGL"})
if err != nil {
    log.Fatal(err)
}
defer tickers.Close()

// Access individual ticker
aapl := tickers.Get("AAPL")
info, _ := aapl.Info()

// Download history for all
result, _ := tickers.History(nil)
```

--------------------------------

### Get Current Lookup Query

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Returns the current query string associated with the Lookup instance.

```go
func (l *Lookup) Query() string
```

--------------------------------

### Download Multi-Ticker Data with Parameters in Go (multi package)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Illustrates downloading historical data for multiple tickers using the `multi.Download` function with custom parameters. It shows how to specify the period, interval, and number of threads for parallel processing using `models.DownloadParams`. This allows for more control over the data fetching process.

```go
import "github.com/wnjoon/go-yfinance/pkg/multi"
import "github.com/wnjoon/go-yfinance/pkg/models"
import "log"

// ...

params := &models.DownloadParams{
    Period:   "3mo",
    Interval: "1d",
    Threads:  4,
}
result, err := multi.Download([]string{"AAPL", "MSFT"}, params)
if err != nil {
    log.Fatal(err)
}
```

--------------------------------

### Sector Information and Management

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Methods for getting sector identifiers and managing the Sector instance's state.

```APIDOC
## Sector Information and Management

### Description
Methods for getting sector identifiers and managing the Sector instance's state.

### `Key() string`
Returns the sector key.

### `Name() (string, error)`
Returns the sector name.

### `Symbol() (string, error)`
Returns the sector symbol.

### `ClearCache()`
Clears the cached sector data. The next call to any data method will fetch fresh data.

### `Close()`
Releases resources used by the Sector instance.
```

--------------------------------

### Cache API

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Provides methods for managing a cache, including getting, setting, and checking cache entries.

```APIDOC
## Cache API

### Description
Provides methods for managing a cache, including getting, setting, and checking cache entries. Options are available to configure the cache with custom TTL or a custom HTTP client.

### func (*Cache) Get

Retrieves a value from the cache. Returns the value and true if found and not expired, otherwise nil and false.

- **key** (string) - The key of the cache entry.

### func (*Cache) GetString

Retrieves a string value from the cache. Returns the value and true if found, not expired, and is a string.

- **key** (string) - The key of the cache entry.

### func (*Cache) Len

Returns the number of items in the cache (including expired ones).

### func (*Cache) Set

Stores a value in the cache with the default TTL.

- **key** (string) - The key of the cache entry.
- **value** (interface{}) - The value to store.

### func (*Cache) SetWithTTL

Stores a value in the cache with a custom TTL.

- **key** (string) - The key of the cache entry.
- **value** (interface{}) - The value to store.
- **ttl** (time.Duration) - The time-to-live for the cache entry.

### type Option

Option is a function that configures a Cache.

### func WithTTL

WithTTL sets the default TTL for cache entries.

- **ttl** (time.Duration) - The default time-to-live for cache entries.

### func WithClient

WithClient provides a custom HTTP client for the cache.

- **client** (*http.Client) - The custom HTTP client to use.
```

--------------------------------

### Get History Metadata

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Retrieves metadata associated with historical price data for a ticker. Returns a ChartMeta object.

```go
func (t *Ticker) GetHistoryMetadata() *models.ChartMeta {
    // ... implementation details ...
}

```

--------------------------------

### Download Multi-Ticker Data from String in Go (multi package)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates the `multi.DownloadString` function, a convenient alternative to `multi.Download` for fetching data for multiple tickers when the symbols are provided as a single space or comma-separated string. This simplifies input handling for ticker lists.

```go
import "github.com/wnjoon/go-yfinance/pkg/multi"
import "log"

// ...

result, err := multi.DownloadString("AAPL MSFT GOOGL", nil)
if err != nil {
    log.Fatal(err)
}
```

--------------------------------

### Get Sector Key

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Returns the unique key identifier for the sector. This is typically the lowercase, hyphen-separated string used during initialization.

```go
func (s *Sector) Key() string
```

--------------------------------

### Initialize Sector with Predefined Identifiers (Go)

Source: https://github.com/wnjoon/go-yfinance/blob/main/docs/API.md

Demonstrates initializing a sector object using predefined constants like SectorTechnology or SectorHealthcare. This simplifies the process of accessing data for common sectors without needing to know their exact string identifiers.

```Go
s, _ := sector.NewWithPredefined(models.SectorTechnology)
s, _ := sector.NewWithPredefined(models.SectorHealthcare)
s, _ := sector.NewWithPredefined(models.SectorFinancialServices)
```
Tokens:
Raw