All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]
[0.10.0] - 2026-08-02
Added
YahooFinanceEx.get_option_chain/2— the option chain for one symbol and one expiry via/v7/finance/options. Calls and puts come back in a singlecontractslist, each taggedside: :call | :put, carrying strike, bid/ask, last price, volume, open interest, implied volatility, moneyness, currency and contract size.The response also includes every expiry Yahoo lists and the underlying's spot price, so one request answers "which expiries exist", "what is it trading at" and "what are the strikes" together — a consumer screening a shortlist needs one call per symbol, not three.
contract_sizeis normalized from Yahoo's"REGULAR"/"MINI"class names to the share count they mean (100 / 10), and reported per contract rather than assumed — mini options and non-US listings are exactly the cases where assuming 100 is wrong rather than merely unsupported. An unrecognised class isnil, not a guess.A symbol with no chain returns
{:ok, chain}with an emptycontractslist rather than an error, so callers can tell "no options on this name" apart from "the request failed". Contracts without a strike are dropped rather than carried as rows of nils.Pass
:expiry(aDate) to select an expiry other than the nearest.
[0.9.0] - 2026-07-17
Added
YahooFinanceEx.Quote.quote_type— the instrument kind ("EQUITY","ETF","MUTUALFUND","INDEX", …) passed through from the quote response'squoteType;nilwhen Yahoo omits it. Lets consumers distinguish funds from single stocks without a separate lookup.YahooFinanceEx.get_fund_profile/1— fund/ETF profile viaquoteSummary'sfundProfile,defaultKeyStatistics, andtopHoldingsmodules: expense ratio, total assets (AUM), category, family, inception date, top holdings (%{symbol, name, weight}), and sector weights (%{sector => percent}). Returns{:error, :not_found}for single stocks (nofundProfilemodule), so it doubles as an ETF discriminator. Expense-ratio and weight values are percentages.
[0.8.0] - 2026-06-29
Added
YahooFinanceEx.Quote.market_cap— the stock's market capitalization (marketCapfrom the Yahoo quote response), parsed onto the quote struct.
[0.7.0] - 2026-06-28
Added
YahooFinanceEx.get_price_history/2— monthly closing-price history via the chart endpoint (the price series alongside the dividend stream). Returns%{date:, close:}entries sorted ascending, skipping null months;:rangedefaults to"6y". Pairs withget_dividend_history/2to build a historical yield band.
[0.6.0] - 2026-06-28
Added
YahooFinanceEx.get_news/2— recent news headlines for a ticker via the/v1/finance/searchendpoint'snewsstream. Returns%{title:, url:, publisher:, published_at:}entries (UTCDateTime), most-recent first;{:ok, []}when there's no news. Accepts:count(default 8).
Changed
YahooFinanceEx.get_asset_profile/1now also returnswebsiteanddescription(Yahoo'slongBusinessSummary), each nil when absent — alongside the existingsector/industry. Funds/ETFs still return{:error, :not_found}.
[0.5.0] - 2026-06-27
Added
YahooFinanceEx.get_financial_data/1— key leverage / balance-sheet figures (total debt, debt-to-equity, current ratio, quick ratio, total cash, EBITDA) via thequoteSummaryendpoint'sfinancialDatamodule. Returns floats (or nil per missing field),{:error, :not_found}when a ticker exposes nofinancialData.
[0.4.0] - 2026-06-12
Added
YahooFinanceEx.search/2— free-text ticker/company autocomplete via Yahoo's/v1/finance/searchendpoint. Returns{:ok, results}with%{symbol:, name:, exchange:, type:}entries in Yahoo's relevance order;typeis Yahoo'squoteTypeso callers can filter instrument kinds. Blank queries short-circuit to{:ok, []}.
[0.3.0] - 2026-06-11
(Entry backfilled — 0.3.0 shipped without a changelog entry.)
Added
YahooFinanceEx.get_asset_profile/1— sector + industry via thequoteSummaryendpoint'sassetProfilemodule.YahooFinanceEx.get_dividend_history/2— per-payment dividend history via the chart endpoint'sevents=divstream; the raw material for payment-schedule inference. Accepts:range(default"2y").
[0.2.0] - 2026-06-08
Added
YahooFinanceEx.get_quotes/1— batched quote fetch for many symbols in one HTTP call. Transparently chunks lists into batches of 50 (Yahoo's per-request ceiling). Returns{:ok, %{symbol => result}}where each result is{:ok, Quote.t()}or{:error, :not_found}.YahooFinanceEx.get_fx_rate/2— current FX rate between two ISO 4217 currency codes via Yahoo's<FROM><TO>=Xquote symbol. Short-circuits identity pairs (get_fx_rate("USD", "USD")returns{:ok, 1.0}) without hitting the API.
Changed
- Package description tightened to reflect the v0.2 surface.
[0.1.0] - 2026-06-01
Added
- Initial release: Elixir port of the Ruby
yahoo_finance_clientgem. YahooFinanceEx.get_quote/1— fetch a single stock quote via Yahoo's/v7/finance/quoteendpoint.YahooFinanceEx.SessionGenServer — handles Yahoo's cookie + CSRF crumb auth dance with two fallback strategies (query1, query2). 60-second session TTL with on-demand refresh.YahooFinanceEx.Quotestruct — typed result with derived fields (dividend_yield,payout_ratio) computed locally.- Test stubbing via
Req.Testso consumers can mock Yahoo responses without hitting the network.