Install the API clients

Learn how to install Algolia’s (legacy) API clients.

This page documents an earlier version of the API client. For the latest version, see Install API clients (current).

C#

Latest version:

The C# API client v6 supports .NET Standard versions 1.3 to 2.1.

To install version 6 of the C#/.NET API clients, add the Algolia.Search package from NuGet as a dependency to your project. For example:

dotnet add package Algolia.Search --version 6.*

The C#/.NET API clients are open source. View the source code on GitHub.

Go

Latest version:

To install version 3 of the Go API clients, add the algoliasearch-client-go/v3 package as a dependency to your module.

go get github.com/algolia/algoliasearch-client-go/v3

The Go API clients are open source. View the source code on GitHub.

Java

Latest version:

The Java API client v3 requires Java 1.8 or later for all modules except algoliasearch-java-net, which requires Java 11 or later. Your JDK must support TLS v1.2 or later.

The Java API clients are open source. View the source code on GitHub.

Maven

Add the following dependencies to your pom.xml file. For Java 11 and later, you can use the native HTTP client.

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch-core</artifactId>
  <version>VERSION</version>
</dependency>
<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch-java-net</artifactId>
  <version>VERSION</version>
</dependency>

For Java 8 and later, use the Apache HTTP client.

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch-core</artifactId>
  <version>VERSION</version>
</dependency>
<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch-apache</artifactId>
  <version>VERSION</version>
</dependency>

Replace VERSION with the version you want to install. You can find the available releases on Maven Central.

You can also add all dependencies as a single uber-JAR (Java 8 and later):

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch-apache-uber</artifactId>
  <version>VERSION</version>
</dependency>

Gradle

Add the following dependencies to your build.gradle file.

For Java 11 and later, you can use the native HTTP client with Algolia:

dependencies {
  // ...
  implementation 'com.algolia:algoliasearch-core:VERSION'
  implementation 'com.algolia:algoliasearch-java-net:VERSION'
}

For Java 8 and later, use the Algolia Java API client with the Apache HTTP client:

dependencies {
  // ...
  implementation 'com.algolia:algoliasearch-core:VERSION'
  implementation 'com.algolia:algoliasearch-apache:VERSION'
}

Manual installation

If you don’t use Maven or Gradle, you can download all JAR files:

• algoliasearch-core
• algoliasearch-apache
• algoliasearch-core-uber
• algoliasearch-apache-uber
• algoliasearch-java-net

Adobe Experience Manager and other OSGi platforms

OSGi platforms like Adobe Experience Manager require a single uber JAR as a dependency. If you want to integrate Algolia into such a platform, add algoliasearch-apache-uber as a dependency.

JavaScript

Latest version:

To install version 4 of the JavaScript API clients, add the algoliasearch package as a dependency to your project.

npm

npm install algoliasearch@4

For quick prototyping or exploration, you can also include the algoliasearch package in a <script> tag from a content delivery network.

jsDelivr is a third-party CDN. Algolia doesn’t provide support for such third-party services.

HTML

<!-- search only version -->
<script
  src="https://cdn.jsdelivr.net/npm/algoliasearch@4.25.2/dist/algoliasearch-lite.umd.js"
  integrity="sha256-yi498VwhoNKaHUihPJ/PZvhJghXYiGgvQG8/P8BgddQ="
  crossorigin="anonymous"
></script>

<!-- default version -->
<script
  src="https://cdn.jsdelivr.net/npm/algoliasearch@4.25.2/dist/algoliasearch.umd.js"
  integrity="sha256-ex4R2M5mIvkgno0J1Z8F3cNBhUCzpRvYX8pxsX8+JUI="
  crossorigin="anonymous"
></script>

For including ES6 modules, use:

HTML

<script type="module">
// search only version
import algoliasearch from 'https://cdn.jsdelivr.net/npm/algoliasearch@4.25.2/dist/algoliasearch-lite.esm.browser.js';

// default version
import algoliasearch from 'https://cdn.jsdelivr.net/npm/algoliasearch@4.25.2/dist/algoliasearch.esm.browser.js';
</script>

The JavaScript API clients are open source. View the source code on GitHub.

Kotlin

Latest version:

The Kotlin API clients version 2 support Kotlin 1.6 or later. The client supports both Android and JVM projects.

To install version 2 of the Kotlin API clients, add the following dependencies to your build.gradle.kts file:

Kotlin

dependencies {
    // for Gradle version 6.0 and later
    implementation("com.algolia:algoliasearch-client-kotlin:ALGOLIA_VERSION")

    // Choose one of the following HTTP clients
    // For JVM:
    implementation("io.ktor:ktor-client-apache:KTOR_VERSION")
    implementation("io.ktor:ktor-client-java:KTOR_VERSION")
    implementation("io.ktor:ktor-client-jetty:KTOR_VERSION")
    // For JVM/Android
    implementation("io.ktor:ktor-client-okhttp:KTOR_VERSION")
    implementation("io.ktor:ktor-client-android:KTOR_VERSION")
    implementation("io.ktor:ktor-client-cio:KTOR_VERSION")
}

• Replace ALGOLIA_VERSION with the version of the Kotlin API client v2 you want to install. You can find the released versions on Maven Central.

• Replace KTOR_VERSION with the version of the Ktor client you want to use.

For serializing and deserializing your records, add the following plugin to your build.gradle.kts file:

Kotlin

plugins {
  // Replace with latest version from:
  // https://kotlinlang.org/docs/serialization.html#add-plugins-and-dependencies
  kotlin("plugin.serialization") version "2.2.0"
}

The Kotlin API clients are open source. View the source code on GitHub.

PHP

Latest version:

The Algolia PHP API clients version 3 support PHP 7.2 or later.

To install version 3 of the PHP API clients, install the algoliasearch-client-php package with composer.

composer require algolia/algoliasearch-client-php:^3.0

Building Laravel apps?

Check the Laravel integration built on top of the PHP API client.

Building Symfony apps?

Check the Symfony integration built on top of the PHP API client.

Manual installation

1. Download the client from GitHub and unpack the archive in your project directory.
2. Inside the root directory of the client, run ./bin/install-dependencies-without-composer.
3. In your code, require the autoload.php module in the client’s root directory.

The PHP API clients are open source. View the source code on GitHub.

Python

Latest version:

The Python API clients version 3 support Python 3.4 or later.

To install version 3 of the Python API clients, add the algoliasearch package as a dependency to your project.

pip install algoliasearch~=3.0

Building Django apps?

Check the Django integration built on top of the Python API client.

The Python API clients are open source. View the source code on GitHub.

Ruby

Latest version:

The Ruby API clients version 2 support Ruby 2.2 or later.

To install version 2 of the Ruby API clients, add the algolia gem as a dependency to your project:

bundle add algolia --version'~>2.0'
# or: gem install algolia -v '~>2.0'

Be sure to install the algolia gem. The algoliasearch gem installs version 1 of the Ruby API clients. For more information, see Update the Ruby API client.

The Ruby API clients are open source. View the source code on GitHub.

Building Ruby on Rails apps?

Check the Ruby on Rails integration built on top of the Ruby API client.

Scala

Latest version:

The Scala API clients version 1 support Scala 2.13, 2.12, or 2.11.

With Maven, add the following dependency to your pom.xml file:

pom.xml

<dependency>
    <groupId>com.algolia</groupId>
    <artifactId>algoliasearch-scala_2.13</artifactId>
    <version>[1,)</version>
</dependency>

Replace algoliasearch-scala_2.13 with algoliasearch-scala_2.12 or algoliasearch-scala_2.11 if you need to support a different Scala version.

For snapshots, add the sonatype repository:

pom.xml

<repositories>
    <repository>
        <id>oss-sonatype</id>
        <name>oss-sonatype</name>
        <url>https://oss.sonatype.org/content/repositories/snapshots/</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

With sbt, add the following dependency to your build.sbt file:

build.sbt

libraryDependencies += "com.algolia" %% "algoliasearch-scala" % "[1.0,2.0["

For snapshots, add the sonatype repository:

build.sbt

resolvers += "Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"

The Scala API clients are open source. View the source code on GitHub.

Swift

Latest version:

The Algolia Swift API clients version 8 support Swift version 5.0 or later and supports iOS, macOS, tvOS, and watchOS platforms.

To install version 8 of the Swift API clients, add the following dependencies to your project.

With the Swift Package Manager, add the following dependencies to your Package.swift file:

Swift

let package = Package(
  dependencies: [
    .package(
      url: "https://github.com/algolia/algoliasearch-client-swift",
      from: "8.0.0"
    )
  ],
  targets: [
    // Add the client as dependency to your targets
    .executableTarget(
      name: "algolia-example",
      dependencies: [
        .product(
          name:"AlgoliaSearchClient",
          package: "algoliasearch-client-swift"
        )
      ]
    )
  ]
)

With CocoaPods add the following to your Podfile:

Podfile

pod("AlgoliaSearchClient", "~> 8.0")

With Carthage, add the following to your Cartfile:

Cartfile

github "algolia/algoliasearch-client-swift" ~> 8.0.0

The Swift API clients are open source. View the source code on GitHub.

Test your installation

To test your installation, try running a short program that adds a record to a test index, searches your index, and prints the results.

1. Create account

   If you haven’t already, create an Algolia account

2. Copy code

   Copy the following code into a new project or file. Replace ALGOLIA_APPLICATION_ID and ALGOLIA_API_KEY with values from your account. Make sure to use an API key with addObject and search permissions.

   C#

   using System;
   using System.Linq;
   using System.Collections.Generic;
   using Algolia.Search.Clients;
   using Algolia.Search.Models.Search;
   
   namespace HelloAlgolia
   {
     // a simple record in your index
     class Record
     {
       public string Name { get; set; }
       public string ObjectID { get; set; }
       public override string ToString()
       {
          return $"Name: {Name}, ObjectID: {ObjectID}";
       }
     }
   
     class Program
     {
       static void Main(string[] args)
       {
          // Connect and authenticate with your Algolia app
          var client = new SearchClient(
             "ALGOLIA_APPLICATION_ID",
             "ALGOLIA_API_KEY"
          );
   
          // Create a new index and add a record
          var index = client.InitIndex("test_index");
          var record = new Record{ ObjectID = "1", Name = "test_record" };
          index.SaveObject(record).Wait();
   
          // Search the index and print the results
          var results = index.Search<Record>(new Query("test_record"));
          Console.WriteLine(results.Hits.ElementAt(0).ToString());
       }
     }
   }
   

   In production, use environment variables for your credentials.

3. Run code

   Run the code, depending on your development environment.

   C#

   # For example:
   dotnet run
   

   If the command is successful, you should see:

   C#

   Name: test_record, ObjectID: 1