API Reference
The API reference is generated from the Go packages under pkg/ and split by package so each module has its own searchable page.
Primary Packages
| Package |
Description |
| ticker |
Single-symbol quotes, history, financials, options, holders, analysis, news, and valuation data |
| multi |
Batch historical downloads for multiple symbols |
| screener |
Predefined and custom equity, fund, and ETF screeners |
| search |
Symbol, company, news, list, and research search |
| lookup |
Ticker lookup by asset type |
| market |
Market status and summary data |
| sector |
Sector overview, companies, industries, ETFs, and funds |
| industry |
Industry overview, sector mapping, top companies, and reports |
| calendars |
Earnings, IPO, economic events, and split calendars |
| live |
Real-time WebSocket pricing stream |
Support Packages
| Package |
Description |
| models |
Shared request, response, and domain data structures |
| client |
Yahoo Finance HTTP client, authentication, and typed errors |
| config |
Global configuration helpers |
| cache |
Thread-safe in-memory cache |
| repair |
Price data repair primitives |
| stats |
Statistical helpers used by repair logic |
| utils |
Timezone and MIC/Yahoo ticker suffix helpers |