{"id":19407586,"url":"https://github.com/patchoulish/firecrawl-dotnet","last_synced_at":"2025-04-14T09:51:21.518Z","repository":{"id":261660474,"uuid":"884924707","full_name":"patchoulish/firecrawl-dotnet","owner":"patchoulish","description":"A .NET library for interacting with the Firecrawl API","archived":false,"fork":false,"pushed_at":"2025-01-12T21:15:57.000Z","size":66,"stargazers_count":3,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T00:18:03.090Z","etag":null,"topics":["api","crawl","dotnet","firecrawl","scrape","web"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patchoulish.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-07T16:23:31.000Z","updated_at":"2025-01-22T18:07:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"5b7c33f4-5e93-44ec-81e4-4e135130f172","html_url":"https://github.com/patchoulish/firecrawl-dotnet","commit_stats":null,"previous_names":["patchoulish/firecrawl-dotnet"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patchoulish%2Ffirecrawl-dotnet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patchoulish%2Ffirecrawl-dotnet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patchoulish%2Ffirecrawl-dotnet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patchoulish%2Ffirecrawl-dotnet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patchoulish","download_url":"https://codeload.github.com/patchoulish/firecrawl-dotnet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248859633,"owners_count":21173337,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","crawl","dotnet","firecrawl","scrape","web"],"created_at":"2024-11-10T12:03:06.083Z","updated_at":"2025-04-14T09:51:21.493Z","avatar_url":"https://github.com/patchoulish.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# firecrawl-dotnet [![CI](https://github.com/patchoulish/firecrawl-dotnet/actions/workflows/ci.yml/badge.svg)](https://github.com/patchoulish/firecrawl-dotnet/actions/workflows/ci.yml)\nA .NET library for interacting with the [Firecrawl](https://www.firecrawl.dev/) API.\n\n\n## Installation\nInstall the library via [NuGet](https://www.nuget.org/packages/firecrawl-dotnet):\n```bash\ndotnet add package firecrawl-dotnet\n```\n\n### Extensions\nInstall optional library extensions for more functionality, depending on your use case.\n#### Dependency Injection\nIntegrate firecrawl-dotnet and your DI container of choice. Install the extension library via [NuGet](https://www.nuget.org/packages/firecrawl-dotnet-dependencyinjection):\n```bash\ndotnet add package firecrawl-dotnet-dependencyinjection\n```\n\n\n## Usage\n1. Obtain an API key from the [Firecrawl Dashboard](https://www.firecrawl.dev/app) (requires a Firecrawl account).\n2. Pass the API key into a new instance of the `FirecrawlService` class or use a configured `HttpClient` if advanced configuration (e.g., proxies) is required.\n3. Use the methods available on `FirecrawlService` to interact with the Firecrawl API.\n\n### Initialization\nThe library can be initialized in three ways:\n#### Basic Initialization\nPass in your API key directly:\n```csharp\nvar firecrawl = new FirecrawlService(\"YOUR_FIRECRAWL_API_KEY\");\n```\n#### Advanced Initialization\nUse an existing `HttpClient`, ensuring that `BaseAddress` and an `Authorization` header have been set:\n```csharp\nvar httpClient = new HttpClient\n{\n    BaseAddress = new Uri(\"https://api.firecrawl.dev/v1/\"),\n    Timeout = TimeSpan.FromSeconds(5)\n};\n\nhttpClient.DefaultRequestHeaders.Authorization =\n\tnew AuthenticationHeaderValue(\"Bearer\", \"YOUR_FIRECRAWL_API_KEY\");\n\nvar firecrawl = new FirecrawlService(httpClient);\n```\n#### Dependency Injection\nIf you've installed the appropriate extension library.\n1. Register `FirecrawlService` with your dependency container:\n```csharp\nservices.AddFirecrawlHttpClient(options =\u003e\n{\n\toptions.BaseUrl = new Uri(\"https://api.firecrawl.dev/v1/\");\n\toptions.ApiKey = \"YOUR_FIRECRAWL_API_KEY\";\n});\n```\n2. Inject `IFirecrawlService` where needed:\n```csharp\npublic class MyClass\n{\n    private readonly IFirecrawlService firecrawl;\n\n    public MyClass(IFirecrawlService firecrawl)\n    {\n        this.firecrawl = firecrawl;\n    }\n}\n```\n\n\n## Documentation\nRefer to the [Usage](#usage) section above for a quick start, or consult the inline documentation while working in your IDE. For detailed information about the underlying API endpoints, parameters, and expected responses, refer to the [official Firecrawl API documentation](https://docs.firecrawl.dev/api-reference/introduction).\n\n\n## Contributing\nContributions are welcome! To contribute, fork the repository, create a new branch, and submit a pull request with your changes. Please make sure all tests pass before submitting.\n\n\n## License\nThis project is licensed under the MIT license. See `license.txt` for full details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatchoulish%2Ffirecrawl-dotnet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatchoulish%2Ffirecrawl-dotnet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatchoulish%2Ffirecrawl-dotnet/lists"}