https://github.com/algolia/algoliasearch-client-csharp
⚡️ A fully-featured and blazing-fast C# API client to interact with Algolia.
https://github.com/algolia/algoliasearch-client-csharp
algolia algolia-search api-client c-sharp csharp dotnet dotnet-core dotnet-library dotnet-standard search-engine
Last synced: about 1 month ago
JSON representation
⚡️ A fully-featured and blazing-fast C# API client to interact with Algolia.
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-client-csharp
- Owner: algolia
- License: mit
- Created: 2013-07-10T14:52:10.000Z (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T21:34:58.000Z (about 1 month ago)
- Last Synced: 2025-03-14T05:02:30.251Z (about 1 month ago)
- Topics: algolia, algolia-search, api-client, c-sharp, csharp, dotnet, dotnet-core, dotnet-library, dotnet-standard, search-engine
- Language: C#
- Homepage: https://www.algolia.com/doc/api-client/getting-started/install/csharp/
- Size: 5.66 MB
- Stars: 123
- Watchers: 78
- Forks: 61
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-blazingly-fast - algoliasearch-client-csharp - ⚡️ A fully-featured and blazing-fast C# API client to interact with Algolia. (C#)
README
The perfect starting point to integrate Algolia within your .NET project
Documentation •
Community Forum •
Stack Overflow •
Report a bug •
FAQ •
Support
## ✨ Features
* Targets .NET Standard: `.NET Standard 2.0` or `.NET Standard 2.1`.
* For more details about supported .NET implementations, please see .NET Standard official [page](https://docs.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-1).
* Asynchronous and synchronous methods to interact with Algolia's API.
* Thread-safe clients.
* No external dependencies.
* Typed requests and responses.
* Injectable HTTP client.
* Retry strategy & Helpers.
**Migration note from v5.x to v6.x**
> In January 2019, we released v6 of our .NET client. If you are using version 5.x of the client, read the [migration guide to version 6.x](https://www.algolia.com/doc/api-client/getting-started/upgrade-guides/csharp/).
Version 5.x will **no longer** be under active development.
## 💡 Getting Started
To get started, first install the Algolia.Search client.
You can get the last version of the client from [NuGet](https://www.nuget.org/packages/Algolia.Search/).
If you are using the .NET CLI, you can install the package using the following command:
```bash
dotnet add package Algolia.Search --version
```
Or directly in your .csproj file:
```csharp
```
You can now import the Algolia API client in your project and play with it.
```csharp
using Algolia.Search.Clients;
using Algolia.Search.Http;
var client = new SearchClient(new SearchConfig("YOUR_APP_ID", "YOUR_API_KEY"));
// Add a new record to your Algolia index
var response = await client.SaveObjectAsync(
"",
new Dictionary { { "objectID", "id" }, { "test", "val" } }
);
// Poll the task status to know when it has been indexed
await client.WaitForTaskAsync("", response.TaskID);
// Fetch search results, with typo tolerance
var response = await client.SearchAsync(
new SearchMethodParams
{
Requests = new List
{
new SearchQuery(
new SearchForHits
{
IndexName = "",
Query = "",
HitsPerPage = 50,
}
)
},
}
);
```
For full documentation, visit the **[Algolia CSharp API Client](https://www.algolia.com/doc/libraries/csharp/)**.
## ❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/csharp/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
## Contributing
This repository hosts the code of the generated Algolia API client for CSharp, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
## 📄 License
The Algolia .NET API Client is an open-sourced software licensed under the [MIT license](LICENSE).