algolia / algoliasearch-client-csharp

⚡️ A fully-featured and blazing-fast C# API client to interact with Algolia.

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 1.3 to .NET Standard 2.1.
  • For more details about supported .NET implementations, please see .NET Standard official page.
• Asynchronous and synchronous methods to interact with Algolia's API
• Thread-safe clients
• Typed requests and responses
• Injectable HTTP client

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. Version 5.x will no longer be under active development.

💡 Getting Started

Install the library with the .NET CLI:

dotnet add package Algolia.Search

or with the Nuget Package Manager Console:

Install-Package Algolia.Search

In 30 seconds, this quick start tutorial will show you how to index and search objects.

Initialize the cient

To start, you need to initialize the client. To do this, you need your Application ID and API Key. You can find both on your Algolia account.

SearchClient client = new SearchClient("YourApplicationID", "YourAPIKey");
SearchIndex index = client.InitIndex("your_index_name");

Push data

Without any prior configuration, you can start indexing contacts in the contacts index using the following code:

public class Contact
{
  public string ObjectID { get; set; }
  public string Name { get; set; }
  public int Age { get; set; }
}

SearchIndex index = client.InitIndex("contacts");

index.SaveObject(new Contact
{
    ObjectID = "ID1",
    Name = "Jimmie",
    Age = 30
});

Search

You can now search for contacts by firstname, lastname, company, etc. (even with typos):

// Synchronous
index.Search<Contact>(new Query { "jimmie" });

// Asynchronous
await index.SearchAsync<Contact>(new Query { "jimmie" });

For full documentation, visit the Algolia .NET API Client documentation.

ASP.NET

If you're using ASP.NET, checkout the following tutorial.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client.

Use the Dockerfile

If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our dedicated guide to learn more.

📄 License

Algolia .NET API Client is an open-sourced software licensed under the MIT license.