Skip to main content

​
Installation

The official Ruby SDK is maintained in the Firecrawl monorepo at apps/ruby-sdk. To install the Firecrawl Ruby SDK, add it to your project:
Add to your Gemfile:
gem "firecrawl-sdk", "~> 1.0"
Then run:
bundle install
Requires Ruby 3.0 or later.

​
Usage

  1. Get an API key from firecrawl.dev
  2. Set the API key as an environment variable named FIRECRAWL_API_KEY, or pass it directly with Firecrawl::Client.new(api_key: ...)
Here is a quick example using the current SDK API surface: 
require "firecrawl"

client = Firecrawl::Client.from_env

doc = client.scrape(
  "https://firecrawl.dev",
  Firecrawl::Models::ScrapeOptions.new(formats: ["markdown"])
)

job = client.crawl(
  "https://firecrawl.dev",
  Firecrawl::Models::CrawlOptions.new(limit: 5)
)

puts doc.markdown
puts "Crawled pages: #{job.data&.size || 0}"

​
Scraping a URL

To scrape a single URL, use the scrape method. 
doc = client.scrape(
  "https://firecrawl.dev",
  Firecrawl::Models::ScrapeOptions.new(
    formats: ["markdown", "html"],
    only_main_content: true,
    wait_for: 5000
  )
)

puts doc.markdown
puts doc.metadata["title"]

​
JSON Extraction

Extract structured JSON via the scrape endpoint by including a json format with a prompt and schema: 
doc = client.scrape(
  "https://example.com/product",
  Firecrawl::Models::ScrapeOptions.new(
    formats: [
      {
        "type" => "json",
        "prompt" => "Extract the product name and price",
        "schema" => {
          "type" => "object",
          "properties" => {
            "name" => { "type" => "string" },
            "price" => { "type" => "number" }
          }
        }
      }
    ]
  )
)

puts doc.json

​
Crawling a Website

To crawl a website and wait for completion, use crawl. It auto-polls until the job finishes. 
job = client.crawl(
  "https://firecrawl.dev",
  Firecrawl::Models::CrawlOptions.new(
    limit: 50,
    max_discovery_depth: 3,
    scrape_options: Firecrawl::Models::ScrapeOptions.new(
      formats: ["markdown"]
    )
  )
)

puts "Status: #{job.status}"
puts "Progress: #{job.completed}/#{job.total}"

job.data&.each do |page|
  puts page.metadata["sourceURL"]
end

​
Start a Crawl

Start a job without waiting using start_crawl. 
response = client.start_crawl(
  "https://firecrawl.dev",
  Firecrawl::Models::CrawlOptions.new(limit: 100)
)

puts "Job ID: #{response.id}"

​
Checking Crawl Status

Check crawl progress with get_crawl_status. 
status = client.get_crawl_status(response.id)
puts "Status: #{status.status}"
puts "Progress: #{status.completed}/#{status.total}"

​
Cancelling a Crawl

Cancel a running crawl with cancel_crawl. 
result = client.cancel_crawl(response.id)
puts result

​
Mapping a Website

Discover links on a site using map. 
data = client.map(
  "https://firecrawl.dev",
  Firecrawl::Models::MapOptions.new(
    limit: 100,
    search: "blog"
  )
)

data.links&.each do |link|
  puts "#{link["url"]} - #{link["title"]}"
end

​
Searching the Web

Search with optional settings using search. 
results = client.search(
  "firecrawl web scraping",
  Firecrawl::Models::SearchOptions.new(limit: 10)
)

results.web&.each do |result|
  puts "#{result["title"]} - #{result["url"]}"
end

​
Batch Scraping

Scrape multiple URLs in parallel using batch_scrape. 
job = client.batch_scrape(
  ["https://firecrawl.dev", "https://firecrawl.dev/blog"],
  Firecrawl::Models::BatchScrapeOptions.new(
    options: Firecrawl::Models::ScrapeOptions.new(
      formats: ["markdown"]
    )
  )
)

job.data&.each do |doc|
  puts doc.markdown
end

​
Agent

Run an AI-powered agent with agent. 
result = client.agent(
  Firecrawl::Models::AgentOptions.new(
    prompt: "Find the pricing plans for Firecrawl and compare them"
  )
)

puts result.data
With a JSON schema for structured output: 
result = client.agent(
  Firecrawl::Models::AgentOptions.new(
    prompt: "Extract pricing plan details",
    urls: ["https://firecrawl.dev"],
    schema: {
      "type" => "object",
      "properties" => {
        "plans" => {
          "type" => "array",
          "items" => {
            "type" => "object",
            "properties" => {
              "name" => { "type" => "string" },
              "price" => { "type" => "string" }
            }
          }
        }
      }
    }
  )
)

puts result.data

​
Usage & Metrics

Check concurrency and remaining credits: 
concurrency = client.get_concurrency
puts "Concurrency: #{concurrency.concurrency}/#{concurrency.max_concurrency}"

credits = client.get_credit_usage
puts "Remaining credits: #{credits.remaining_credits}"

​
Browser

The Ruby SDK includes Browser Sandbox helpers.

​
Scrape-Bound Interactive Session

Use a scrape job ID to run follow-up browser code in the same replayed context:
  • interact(...) runs code in the scrape-bound browser session (and initializes it on first use).
  • stop_interactive_browser(...) explicitly stops the interactive session when you are done.
scrape_job_id = "550e8400-e29b-41d4-a716-446655440000"

run = client.interact(
  scrape_job_id,
  "console.log(page.url());",
  language: "node",
  timeout: 60
)

puts run["stdout"]

deleted = client.stop_interactive_browser(scrape_job_id)
puts "Deleted: #{deleted["success"]}"

​
Configuration

Firecrawl::Client.new supports the following options:
OptionTypeDefaultDescription
api_keyStringFIRECRAWL_API_KEY env varYour Firecrawl API key
api_urlStringhttps://api.firecrawl.dev (or FIRECRAWL_API_URL)API base URL
timeoutInteger300HTTP request timeout in seconds
max_retriesInteger3Automatic retries for transient failures
backoff_factorFloat0.5Exponential backoff factor in seconds
client = Firecrawl::Client.new(
  api_key: "fc-your-api-key",
  api_url: "https://api.firecrawl.dev",
  timeout: 300,
  max_retries: 3,
  backoff_factor: 0.5
)

​
Error Handling

The SDK raises exceptions under the Firecrawl module. 
begin
  doc = client.scrape("https://example.com")
rescue Firecrawl::AuthenticationError => e
  puts "Auth failed: #{e.message}"
rescue Firecrawl::RateLimitError => e
  puts "Rate limited: #{e.message}"
rescue Firecrawl::JobTimeoutError => e
  puts "Job #{e.job_id} timed out after #{e.timeout_seconds}s"
rescue Firecrawl::FirecrawlError => e
  puts "Error (#{e.status_code}): #{e.message}"
end
Are you an AI agent that needs a Firecrawl API key? See firecrawl.dev/agent-onboarding/SKILL.md for automated onboarding instructions.