Install the C# API client

Install

  • In your project, open the Package Manager Console (ToolsLibrary Package ManagerPackage Manager Console)
  • Enter Install-Package Algolia.Search in the Package Manager Console

Supported platforms

The API client is compatible with:

  • .NET Framework 4.6
  • .NET Framework 4.6.2
  • .NET Framework 4.7
  • .NET Framework 4.7.1
  • .NET Core 1.0
  • .NET Core 1.1
  • .NET Core 2.0
  • .NETStandard 1.6
  • .NETStandard 1.3
  • .NETStandard 2.0

Language-specific notes

Init Index

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

AlgoliaClient client = new AlgoliaClient("YourApplicationID", "YourAPIKey");
Index index = client.InitIndex("your_index_name");

You need to replace your_index_name by the name of the index you want to use. If you want to target an existing index you can find the name from the dashboard. If the index does not exist you can choose any name and it will be created when you perform an add objects or a set settings operation.

If an api key is displayed in the previous snippet it is your ADMIN API Key. To maintain security, never use your ADMIN API Key on your frontend or share it with anyone. In your frontend, use the SEARCH ONLY API Key or any other key that has search only rights.

Make sure you don’t use any sensitive or personally identifiable information (PII) as your index name, including customer names, user IDs, or email addresses. Index names appear in network requests and should be considered publicly available.