firecrawl-sdk 1.8.1 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c5ff8541498b47b08ff9b54d1c14969c734fba849e09c3fcc1d48143be53f1e
-  data.tar.gz: 71fb5c61c9c20ec229d077b7db82eb2ba60c48581a0b96969f7d515fa91778eb
+  metadata.gz: 616551a9caf1736bbc849f0058ce52dca94728cf024cb91319393e5bf192cfe1
+  data.tar.gz: ffe33e36c76d4a69319940e148ccce30bc50b3e44b81915698c76f7e4a1cb99b
 SHA512:
-  metadata.gz: 2a44065aa34a8bd32f691ebd249c4d11b48998582dd6ba9f5da6bca80d95370341be3b0dd0482076918b8ccad268b928034b9bd477daddd831bc042da59391a2
-  data.tar.gz: 347d45a6810b3b66afb4a6bbb6b977f13dbf770c2c57eaedcb8bc9d7c4b071bf3be25f299c606adc74cc74819a7f6c23ae9009dbe183d789a7c36dc76a43ec8e
+  metadata.gz: fbbe64a2fd02c6a8214cbb77f7dfc64791e392d2192f4c9d657ed6cb9bab3c820ed6ff9a430b0fb1abfdd11076b6a64600a4f8df0f9232bda02b8c3bf27d1385
+  data.tar.gz: f2a722b6f10ac0254d3d8f7dda69f653751539056cce8690b703e023f35b021b9ac451a798800bcb2293a9f414014d9eb22bb54fea779971e79cde106dde4b5c

data/README.md

@@ -74,11 +74,25 @@ doc = client.scrape("https://www.youtube.com/watch?v=dQw4w9WgXcQ",
 puts doc.video
 ```
 
+### Product Extraction
+
+Use the `product` format on product pages to get structured product data
+(title, brand, category, and per-variant price, availability, and images).
+It is the deterministic counterpart to the LLM-based `json` format. The
+returned `product` field contains the extracted fields.
+
+```ruby
+doc = client.scrape("https://example.com/products/widget",
+  Firecrawl::Models::ScrapeOptions.new(formats: ["product"]))
+
+puts doc.product
+```
+
 ### Parse
 
 Upload a local file (`html`, `pdf`, `docx`, etc.) via multipart form data and
 parse it synchronously. Parse options intentionally exclude browser-only
-features such as change tracking, screenshot, branding, audio, video, actions,
+features such as change tracking, screenshot, branding, audio, video, product, actions,
 wait_for, location, and mobile. The `proxy` option only accepts `"auto"` or `"basic"`.
 
 ```ruby

data/lib/firecrawl/client.rb

@@ -85,6 +85,57 @@ module Firecrawl
       Models::Document.new(data)
     end
 
+    # Search research papers.
+    #
+    # @param query [String] research query
+    # @param options [Hash] optional query parameters
+    # @return [Hash]
+    def search_papers(query, options = {})
+      @http.get("/v2/search/research/papers#{query(options.merge("query" => query, "origin" => "ruby-sdk@#{Firecrawl::VERSION}"))}")
+    end
+
+    # Inspect paper metadata.
+    #
+    # @param paper_id [String] paper identifier
+    # @return [Hash]
+    def inspect_paper(paper_id)
+      raise ArgumentError, "Paper ID is required" if paper_id.nil?
+      @http.get("/v2/search/research/papers/#{URI.encode_www_form_component(paper_id)}")
+    end
+
+    # Read a paper with query-guided passages.
+    #
+    # @param paper_id [String] paper identifier
+    # @param query_text [String] passage query
+    # @param options [Hash] optional query parameters
+    # @return [Hash]
+    def read_paper(paper_id, query_text, options = {})
+      raise ArgumentError, "Paper ID is required" if paper_id.nil?
+      path = "/v2/search/research/papers/#{URI.encode_www_form_component(paper_id)}"
+      @http.get("#{path}#{query(options.merge("query" => query_text, "origin" => "ruby-sdk@#{Firecrawl::VERSION}"))}")
+    end
+
+    # Find papers related to a paper.
+    #
+    # @param paper_id [String] paper identifier
+    # @param intent [String] relatedness intent
+    # @param options [Hash] optional query parameters
+    # @return [Hash]
+    def related_papers(paper_id, intent, options = {})
+      raise ArgumentError, "Paper ID is required" if paper_id.nil?
+      path = "/v2/search/research/papers/#{URI.encode_www_form_component(paper_id)}/similar"
+      @http.get("#{path}#{query(options.merge("intent" => intent, "origin" => "ruby-sdk@#{Firecrawl::VERSION}"))}")
+    end
+
+    # Search GitHub research content.
+    #
+    # @param query_text [String] GitHub query
+    # @param options [Hash] optional query parameters
+    # @return [Hash]
+    def search_github(query_text, options = {})
+      @http.get("/v2/search/research/github#{query(options.merge("query" => query_text, "origin" => "ruby-sdk@#{Firecrawl::VERSION}"))}")
+    end
+
     # Interacts with the scrape-bound browser session for a scrape job.
     #
     # @param job_id [String] the scrape job ID
@@ -465,9 +516,21 @@ module Firecrawl
 
     private
 
-    def query(**params)
-      compact = params.compact
-      compact.empty? ? "" : "?#{URI.encode_www_form(compact)}"
+    def query(params = nil, **kwargs)
+      params = (params || {}).merge(kwargs)
+      pairs = []
+      params.each do |key, value|
+        next if value.nil? || value == ""
+
+        values = value.is_a?(Array) ? value : [value]
+        values.each do |item|
+          next if item.nil? || item == ""
+
+          string_value = item == true ? "true" : item == false ? "false" : item.to_s
+          pairs << [key.to_s, string_value]
+        end
+      end
+      pairs.empty? ? "" : "?#{URI.encode_www_form(pairs)}"
     end
 
     def poll_crawl(job_id, poll_interval, timeout)

data/lib/firecrawl/models/document.rb

@@ -7,7 +7,7 @@ module Firecrawl
       attr_reader :markdown, :html, :raw_html, :json, :summary,
                   :metadata, :links, :images, :screenshot, :audio,
                   :video, :attributes, :actions, :answer, :highlights,
-                  :warning, :change_tracking, :branding
+                  :warning, :change_tracking, :branding, :product
 
       def initialize(data)
         @markdown = data["markdown"]
@@ -28,6 +28,7 @@ module Firecrawl
         @warning = data["warning"]
         @change_tracking = data["changeTracking"]
         @branding = data["branding"]
+        @product = data["product"] && ProductProfile.new(data["product"])
       end
 
       def to_s

data/lib/firecrawl/models/parse_options.rb

@@ -5,10 +5,10 @@ module Firecrawl
     # Options for parsing uploaded files via `/v2/parse`.
     #
     # Parse does not support browser-rendering features (actions, waitFor,
-    # location, mobile) nor screenshot/branding/audio/video/changeTracking formats. The
+    # location, mobile) nor screenshot/branding/product/audio/video/changeTracking formats. The
     # proxy field only accepts "auto" or "basic".
     class ParseOptions
-      UNSUPPORTED_FORMATS = %w[changeTracking screenshot screenshot@fullPage branding audio video].freeze
+      UNSUPPORTED_FORMATS = %w[changeTracking screenshot screenshot@fullPage branding product audio video].freeze
 
       FIELDS = %i[
         formats headers include_tags exclude_tags only_main_content

data/lib/firecrawl/models/product_profile.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Firecrawl
+  module Models
+    # Structured product information extracted from a product page via the
+    # `product` scrape format.
+    class ProductProfile
+      # An image associated with a product or variant.
+      class Image
+        attr_reader :url, :alt
+
+        def initialize(data)
+          @url = data["url"]
+          @alt = data["alt"]
+        end
+      end
+
+      # A monetary value with an optional currency and formatted string.
+      class Price
+        attr_reader :amount, :currency, :formatted
+
+        def initialize(data)
+          @amount = data["amount"]
+          @currency = data["currency"]
+          @formatted = data["formatted"]
+        end
+      end
+
+      # Stock availability information for a variant. Always present.
+      class Availability
+        attr_reader :in_stock, :text
+
+        def initialize(data)
+          data ||= {}
+          @in_stock = data["inStock"] || false
+          @text = data["text"]
+        end
+      end
+
+      # Sale pricing for a variant, carrying the pre-sale original price.
+      class Sale
+        attr_reader :original_price
+
+        def initialize(data)
+          @original_price = data["originalPrice"] && Price.new(data["originalPrice"])
+        end
+      end
+
+      # A purchasable variant of a product. Pricing, availability, and images
+      # live here rather than on the top-level product.
+      class Variant
+        attr_reader :id, :sku, :title, :values, :price, :sale,
+                    :availability, :images
+
+        def initialize(data)
+          @id = data["id"]
+          @sku = data["sku"]
+          @title = data["title"]
+          @values = data["values"]
+          @price = data["price"] && Price.new(data["price"])
+          @sale = data["sale"] && Sale.new(data["sale"])
+          @availability = Availability.new(data["availability"])
+          @images = (data["images"] || []).map { |img| Image.new(img) }
+        end
+      end
+
+      attr_reader :title, :brand, :category, :url, :description, :variants
+
+      def initialize(data)
+        @title = data["title"]
+        @brand = data["brand"]
+        @category = data["category"]
+        @url = data["url"]
+        @description = data["description"]
+        @variants = (data["variants"] || []).map { |variant| Variant.new(variant) }
+      end
+
+      def to_s
+        "ProductProfile{title=#{title || 'untitled'}, url=#{url || 'unknown'}}"
+      end
+    end
+  end
+end

data/lib/firecrawl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Firecrawl
-  VERSION = "1.8.1"
+  VERSION = "1.9.1"
 end

data/lib/firecrawl.rb

@@ -4,6 +4,7 @@ require_relative "firecrawl/version"
 require_relative "firecrawl/errors"
 require_relative "firecrawl/http_client"
 require_relative "firecrawl/models/query_format"
+require_relative "firecrawl/models/product_profile"
 require_relative "firecrawl/models/document"
 require_relative "firecrawl/models/scrape_options"
 require_relative "firecrawl/models/crawl_options"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firecrawl-sdk
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.1
 platform: ruby
 authors:
 - Firecrawl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-15 00:00:00.000000000 Z
+date: 2026-06-17 00:00:00.000000000 Z
 dependencies: []
 description: A type-safe Ruby client for the Firecrawl v2 API. Supports scraping,
   crawling, batch scraping, URL mapping, web search, and AI agent operations.
@@ -41,6 +41,7 @@ files:
 - lib/firecrawl/models/monitor.rb
 - lib/firecrawl/models/parse_file.rb
 - lib/firecrawl/models/parse_options.rb
+- lib/firecrawl/models/product_profile.rb
 - lib/firecrawl/models/query_format.rb
 - lib/firecrawl/models/scrape_options.rb
 - lib/firecrawl/models/search_data.rb