Search API client

The Search API client is part of the Algolia.Search package. To install this package, run:

dotnet add package Algolia.Search

To use the Search API client, import these namespaces:

using Algolia.Search.Clients;
using Algolia.Search.Http;
using Algolia.Search.Models.Search;

To create an instance of the client:

var client = new SearchClient(
  new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
);

The Search API client is part of the algoliasearch package. To install this package, run:

dart pub add algoliasearch

To use the Search API client, add this import to your files:

Dart

import 'package:algolia_client_search/algolia_client_search.dart';

To create an instance of the client:

Dart

final client =
  SearchClient(
    appId: 'ALGOLIA_APPLICATION_ID',
    apiKey: 'ALGOLIA_API_KEY'
);

The Search API client is part of the algoliasearch-client-go package. To install it, run:

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

To use the Search API client, add this import to your files:

import "github.com/algolia/algoliasearch-client-go/v4/algolia/search"

To create an instance of the client:

client, err := search.NewClient(
	"ALGOLIA_APPLICATION_ID",
	"ALGOLIA_API_KEY",
)
if err != nil {
	panic(err)
}

The Search API client is part of the algoliasearch package. You can add this package to your pom.xml file for Maven:

pom.xml

<dependency>
  <groupId>com.algolia</groupId>
  <artifactId>algoliasearch</artifactId>
  <version>4.25.0</version>
</dependency>

or to your build.gradle file for Gradle:

build.gradle

implementation 'com.algolia:algoliasearch:4.25.0'

To use the Search API client, add these imports to your files:

Java

import com.algolia.config.*;

To create an instance of the client:

Java

SearchClient client = new SearchClient(
    "ALGOLIA_APPLICATION_ID",
    "ALGOLIA_API_KEY"
);

The search API client is part of the algoliasearch package. To install this package, run:

npm install algoliasearch

To use the Search API client:

JavaScript

import { algoliasearch } from "algoliasearch";

const client = algoliasearch("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
const searchClient = client.initSearch();

The algoliasearch package includes API clients for the Search, Recommend, Analytics, A/B testing, and Personalization API. If you just want to use the search API client, you can install its package on its own:

npm install @algolia/client-search

To use it, run:

JavaScript

import { searchClient } from "@algolia/client-search";

const client = searchClient(
  "ALGOLIA_APPLICATION_ID",
  "ALGOLIA_API_KEY"
);

If you just want to use the Search method of the Search API to search multiple indices for matching records or facet values, you can use the liteClient:

JavaScript

import { liteClient } from "algoliasearch/lite";

const client = liteClient(
  "ALGOLIA_APPLICATION_ID",
  "ALGOLIA_API_KEY",
);

The Search API client is part of the algoliasearch-kotlin package. You can add this package to your build.gradle.kts file:

build.gradle.kts

implementation("com.algolia:algoliasearch-client-kotlin:3.28.0")
// You also need to add a KTOR engine as dependency, for example:
implementation("io.ktor:ktor-client-java:$ktor_version")

To use the Search API client, add this import to your files:

Kotlin

import com.algolia.client.api.SearchClient
import com.algolia.client.configuration.*
import com.algolia.client.transport.*
import com.algolia.client.extensions.*

To create an instance of the client:

Kotlin

val client = SearchClient(
  appId = "ALGOLIA_APPLICATION_ID",
  apiKey = "ALGOLIA_API_KEY"
)

The Search API client is part of the algoliasearch-client-php package. To install this package, run:

composer require algolia/algoliasearch-client-php

To use the Search API client, add this import to your files:

PHP

use Algolia\AlgoliaSearch\Api\SearchClient;

To create an instance of the client:

PHP

$client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

The Search API client is part of the algoliasearch package. You can install this package with pip:

pip install 'algoliasearch>=4,<5'

To use the Search API client, add this import to your files:

Python

from algoliasearch.search.client import SearchClientSync
from json import loads

To create an instance of the client:

Python

# In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods.
client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

Async code

To use the Search client in async environments, add these imports instead:

Python

import asyncio
from algoliasearch.search.client import SearchClient

The client supports the async with statement to automatically close open connections.

Python

async def run():
    async with SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") as client:
        # client.search(...)

The method names are the same for synchronous and asynchronous methods.

The Search API client is part of the algolia gem. To install this gem, run:

gem install algolia

To use the Search API client, add this import to your files:

Ruby

require "algolia"

To create an instance of the client:

Ruby

client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

The Search API client is part of the algoliasearch-scala package. You can add this package to your build.sbt file:

build.sbt

// For Scala 3:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.27.0"
// For Scala 2:
libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.27.0"

To use the Search client, add these imports to your files:

Scala

import algoliasearch.api.SearchClient
import algoliasearch.config.*
import algoliasearch.extension.SearchClientExtensions

To create an instance of the client:

Scala

val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

The Search API client is part of the algoliasearch-client-swift package. You can add this package to your Package.swift file:

Package.swift

// swift-tools-version: 5.10
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
  name: "Algolia API clients",
  platforms: [
    .macOS(.v11)
  ],
  dependencies: [
    .package(
      url: "https://github.com/algolia/algoliasearch-client-swift.git", from: "9.28.0")
  ],
  targets: [
    .executableTarget(
      name: "Algolia API clients",
      dependencies: [
        .product(name: "Search", package: "algoliasearch-client-swift")
      ]
    )
  ]
)

To use the Search client, add this import to your files:

Swift

import Search

To create an instance of the client:

Swift

let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

Indices

Algolia automatically creates a new index when you add records, rules, or synonyms, or when you change settings for an index that doesn’t yet exist. You don’t need to create indices explicitly. Don’t include sensitive or personally identifiable information (PII) in your index names. They appear in network requests and are publicly visible.

API clients (current)

Clients and methods

Search API client

Async code

Indices

API clients (current)

Clients and methods

​Async code

​Indices

Async code

Indices