Search an index

Searches a single index and returns matching search results (hits).

This method lets you retrieve up to 1,000 hits. If you need more, use the browse operation or increase the paginatedLimitedTo index setting.

Usage

Required ACL: search
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import algoliasearch.api.SearchClient
import algoliasearch.extension.SearchClientExtensions

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

val response = client.searchSingleIndex(
  indexName = "ALGOLIA_INDEX_NAME",
  searchParams = Some(
    SearchParamsObject(
      query = Some("myQuery"),
      facetFilters = Some(FacetFilters(Seq(FacetFilters("tags:algolia"))))
    )
  )
)
Did you find this page helpful?
Scala API clients v2