Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥
TypeScript aiai-agentsai-crawlerai-scrapingai-searchcrawlerdata-extractionhtml-to-markdownllmmarkdownscraperscrapingweb-crawlerweb-dataweb-data-extractionweb-scraperweb-scrapingweb-searchwebscraping
docs(readme): list all official SDKs and fix Go miscategorization (#4006)
firecrawl-spring[bot]55cabf80a5eb
diff --git a/README.md b/README.mdindex 4cc75c562..b529073d6 100644--- a/README.md+++ b/README.md@@ -572,6 +572,71 @@ results.data.web.forEach(result => {});```+### Go++Install the SDK:+```bash+go get github.com/firecrawl/firecrawl/apps/go-sdk+```+```go+package main++import (+ "context"+ "fmt"+ "log"++ firecrawl "github.com/firecrawl/firecrawl/apps/go-sdk"+ "github.com/firecrawl/firecrawl/apps/go-sdk/option"+)++func main() {+ // Create a client (reads FIRECRAWL_API_KEY from environment)+ client, err := firecrawl.NewClient(option.WithAPIKey("fc-YOUR_API_KEY"))+ if err != nil {+ log.Fatal(err)+ }++ ctx := context.Background()++ // Scrape a single URL+ doc, err := client.Scrape(ctx, "https://firecrawl.dev", &firecrawl.ScrapeOptions{+ Formats: []string{"markdown"},+ })+ if err != nil {+ log.Fatal(err)+ }+ fmt.Println(doc.Markdown)++ // Use the Agent for autonomous data gathering+ agent, err := client.Agent(ctx, &firecrawl.AgentOptions{+ Prompt: "Find the founders of Stripe",+ })+ if err != nil {+ log.Fatal(err)+ }+ fmt.Println(agent.Data)++ // Crawl a website (automatically waits for completion)+ job, err := client.Crawl(ctx, "https://docs.firecrawl.dev", &firecrawl.CrawlOptions{+ Limit: firecrawl.Int(50),+ })+ if err != nil {+ log.Fatal(err)+ }+ fmt.Printf("Crawled %d pages\n", len(job.Data))++ // Search the web+ results, err := client.Search(ctx, "best AI data tools 2024", &firecrawl.SearchOptions{+ Limit: firecrawl.Int(10),+ })+ if err != nil {+ log.Fatal(err)+ }+ fmt.Println(results)+}+```+### JavaAdd the dependency ([Gradle/Maven](https://docs.firecrawl.dev/sdks/java#installation)):@@ -690,9 +755,98 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {}```-### Community SDKs+### Ruby++Install the SDK:+```bash+gem install firecrawl-sdk+```+```ruby+require "firecrawl"++client = Firecrawl::Client.new(api_key: "fc-YOUR_API_KEY")++# Scrape a single URL+doc = client.scrape("https://firecrawl.dev",+ Firecrawl::Models::ScrapeOptions.new(formats: ["markdown"]))+puts doc.markdown++# Use the Agent for autonomous data gathering+result = client.agent(+ Firecrawl::Models::AgentOptions.new(prompt: "Find the founders of Stripe"))+puts result.data++# Crawl a website (automatically waits for completion)+job = client.crawl("https://docs.firecrawl.dev",+ Firecrawl::Models::CrawlOptions.new(limit: 50))+job.data.each { |d| puts d.metadata.source_url }++# Search the web+results = client.search("best AI data tools 2024",+ Firecrawl::Models::SearchOptions.new(limit: 10))+puts results+```++### .NET-- [Go SDK](https://github.com/firecrawl/firecrawl/tree/main/apps/go-sdk)+Install the SDK:+```bash+dotnet add package firecrawl-sdk+```+```csharp+using Firecrawl;+using Firecrawl.Models;++var client = new FirecrawlClient("fc-YOUR_API_KEY");++// Scrape a single URL+var doc = await client.ScrapeAsync("https://firecrawl.dev",+ new ScrapeOptions { Formats = new List<object> { "markdown" } });+Console.WriteLine(doc.Markdown);++// Crawl a website (automatically waits for completion)+var job = await client.CrawlAsync("https://docs.firecrawl.dev",+ new CrawlOptions { Limit = 50 });+Console.WriteLine($"Crawled {job.Data.Count} pages");++// Search the web+var results = await client.SearchAsync("best AI data tools 2024",+ new SearchOptions { Limit = 10 });+Console.WriteLine(results);+```++### PHP++Install the SDK:+```bash+composer require firecrawl/firecrawl-sdk+```+```php+<?php++use Firecrawl\Client\FirecrawlClient;+use Firecrawl\Models\ScrapeOptions;+use Firecrawl\Models\CrawlOptions;+use Firecrawl\Models\SearchOptions;++$client = FirecrawlClient::create(apiKey: 'fc-YOUR_API_KEY');++// Scrape a single URL+$doc = $client->scrape('https://firecrawl.dev', ScrapeOptions::with(+ formats: ['markdown'],+));+echo $doc->getMarkdown();++// Crawl a website (automatically waits for completion)+$job = $client->crawl('https://docs.firecrawl.dev', CrawlOptions::with(limit: 50));+foreach ($job->getData() as $page) {+ echo $page->getMetadata()['sourceURL'] . "\n";+}++// Search the web+$results = $client->search('best AI data tools 2024', SearchOptions::with(limit: 10));+print_r($results);+```---