yahoo_finance_client 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec1a70f9b1a9927d6b36ea559dbaf4204f8c82ad37d70b2c2feab47864cd01ac
-  data.tar.gz: 3a91d7848dffe1d5ca1532e31c513f4465ad9147f93c8a6984dfabf320c65337
+  metadata.gz: 7e0827edebfc4f170f5a750a27e04cac4fb5dd158fcc85ab47d684a777d6dac8
+  data.tar.gz: 3922682a35baff70fb5492f6f21a8feca3ceb24cf549c7678caca26f922814bb
 SHA512:
-  metadata.gz: b489b0a5689876b9f13e8876263ce54c2878a7aea9e4ad421114d9ee4434c50764c89d9cb6a19a0605bc0e4bc777f14ff641edbef314e57bdf4ddc365c9428ac
-  data.tar.gz: daffd51bf44af895b9741b94278ef5d81729f7bdc0b3250b91b0897009cfe30b069beedcd14c3d02a7f22bc40e01907eb8fab80655a5ea02c14e90e002d1a87c
+  metadata.gz: 6b699a914a9e2b929b14180e0251ff4ab77ab41e53ec5cf7becff1abf0210fbd477d0f7a4b92f4a77015cf1b659f622d26eb3828e74fc8957edcf6d1f03449f8
+  data.tar.gz: 177c5c3577a4a7b31e480b9c85c097def09cdb1aa546da8dc82626239afd6b97b138bc5707f2a7df07c342015be3ad5cd3160f28df27e25ef55633afc1f11957

data/.rubocop.yml

@@ -11,7 +11,7 @@ Metrics/AbcSize:
   Max: 25
 
 Metrics/ClassLength:
-  Max: 200
+  Max: 280
 
 Metrics/MethodLength:
   Max: 11

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [0.5.0] - 2026-05-15
+
+- Add `Stock.search(query, count:)` returning matching tickers from Yahoo's `v1/finance/search` autocomplete endpoint
+
 ## [0.4.1] - 2026-02-13
 
 - Add `fifty_two_week_high` and `fifty_two_week_low` fields to quote data

data/README.md

@@ -55,6 +55,25 @@ YahooFinanceClient::Stock.get_quotes(["AAPL", "MSFT", "GOOG"])
 # => { "AAPL" => { symbol: "AAPL", ... }, "MSFT" => { ... }, "GOOG" => { ... } }
 ```
 
+### Search
+
+Search the Yahoo Finance autocomplete index by ticker or company name:
+```ruby
+YahooFinanceClient::Stock.search("apple")
+# => [
+#   { symbol: "AAPL", name: "Apple Inc.", exchange: "NasdaqGS", type: "EQUITY", type_display: "Equity" },
+#   { symbol: "AAPL.MX", name: "Apple Inc.", exchange: "Mexico", type: "EQUITY", type_display: "Equity" },
+#   ...
+# ]
+```
+
+The default result count is 10. Pass `count:` to override:
+```ruby
+YahooFinanceClient::Stock.search("apple", count: 5)
+```
+
+Search returns `[]` if the query is empty or the upstream request fails.
+
 ### Dividend History
 
 Fetch historical dividend payments via the chart API:

data/lib/yahoo_finance_client/stock.rb

@@ -2,12 +2,15 @@
 
 require "httparty"
 require "json"
+require "uri"
 
 module YahooFinanceClient
   # This class provides methods to interact with Yahoo Finance API for stock data.
   class Stock
     QUOTE_PATH = "/v7/finance/quote"
     CHART_PATH = "/v8/finance/chart"
+    SEARCH_PATH = "/v1/finance/search"
+    SEARCH_BASE_URL = "https://query1.finance.yahoo.com"
     CACHE_TTL = 300
     MAX_RETRIES = 2
     BATCH_SIZE = 50
@@ -34,6 +37,19 @@ module YahooFinanceClient
         fetch_from_cache(cache_key) || fetch_and_cache_dividend_history(cache_key, symbol, range)
       end
 
+      # Search the Yahoo Finance autocomplete index for matching symbols.
+      #
+      # @param query [String] free-text query (ticker or company name)
+      # @param count [Integer] max number of results to return
+      # @return [Array<Hash>] each entry has symbol, name, exchange, type, type_display
+      def search(query, count: 10)
+        normalized = query.to_s.strip
+        return [] if normalized.empty?
+
+        cache_key = "search_#{normalized.downcase}_#{count}"
+        fetch_from_cache(cache_key) || fetch_and_cache_search(cache_key, normalized, count)
+      end
+
       private
 
       def partition_cached(symbols)
@@ -231,6 +247,85 @@ module YahooFinanceClient
         { date: date, amount: amount.round(4) }
       end
 
+      def fetch_and_cache_search(cache_key, query, count)
+        data = fetch_search_data(query, count)
+        store_in_cache(cache_key, data) unless data.empty?
+        data
+      end
+
+      # Try an unauthenticated request first — the v1/finance/search endpoint is historically
+      # public and does not validate the crumb. Only fall through to the cookie+crumb flow if
+      # Yahoo actually returns an auth error.
+      def fetch_search_data(query, count)
+        url = build_search_url(query, count)
+        response = HTTParty.get(url, headers: { "User-Agent" => Session::USER_AGENT })
+
+        return fetch_authenticated_search(query, count) if auth_error?(response)
+        return [] unless response.success?
+
+        parse_search_response(response.body)
+      rescue StandardError
+        []
+      end
+
+      def fetch_authenticated_search(query, count)
+        retries = 0
+        begin
+          handle_authenticated_search_response(make_authenticated_search_request(query, count))
+        rescue AuthenticationError
+          retries += 1
+          retry if retries <= MAX_RETRIES
+          []
+        end
+      end
+
+      def handle_authenticated_search_response(response)
+        if auth_error?(response)
+          Session.instance.invalidate!
+          raise AuthenticationError, "Authentication failed"
+        end
+        response.success? ? parse_search_response(response.body) : []
+      end
+
+      def make_authenticated_search_request(query, count)
+        session = Session.instance
+        session.ensure_authenticated
+        url = "#{build_search_url(query, count)}&crumb=#{session.crumb}"
+        HTTParty.get(url, headers: { "User-Agent" => Session::USER_AGENT, "Cookie" => session.cookie })
+      end
+
+      def build_search_url(query, count)
+        "#{SEARCH_BASE_URL}#{SEARCH_PATH}?q=#{URI.encode_www_form_component(query)}" \
+          "&quotesCount=#{count}&newsCount=0"
+      end
+
+      def parse_search_response(body)
+        quotes = JSON.parse(body)["quotes"] || []
+        quotes.filter_map { |q| format_search_quote(q) }
+      rescue JSON::ParserError
+        []
+      end
+
+      def format_search_quote(quote)
+        symbol = quote["symbol"].to_s
+        return nil if symbol.empty?
+
+        {
+          symbol: symbol,
+          name: pick_search_name(symbol, quote["shortname"], quote["longname"]),
+          exchange: quote["exchDisp"] || quote["exchange"],
+          type: quote["quoteType"],
+          type_display: quote["typeDisp"]
+        }
+      end
+
+      # Mutual funds and some foreign listings report the symbol code as their `shortname`
+      # (e.g. Baelo Dividendo Creciente comes back with shortname="0P0001QYEF.F"); prefer the
+      # longname when shortname is missing or just echoes the symbol.
+      def pick_search_name(symbol, shortname, longname)
+        [shortname, longname, symbol].find { |n| !n.to_s.empty? && n != symbol } || symbol
+      end
+
       def fetch_from_cache(key)
         cached_entry = @cache[key]
         return unless cached_entry && Time.now - cached_entry[:timestamp] < CACHE_TTL

data/lib/yahoo_finance_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module YahooFinanceClient
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+ruby = "3.4.1"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yahoo_finance_client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Francesc Leveque
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -57,6 +57,7 @@ files:
 - lib/yahoo_finance_client/session.rb
 - lib/yahoo_finance_client/stock.rb
 - lib/yahoo_finance_client/version.rb
+- mise.toml
 - sig/yahoo_finance_client.rbs
 homepage: https://github.com/fleveque/dividend-portfolio
 licenses:
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Basic Yahoo! Finance API client
 test_files: []