Skip to main content

Usage

The query parameter represents the query string Algolia matches against your index. For an overview of how Algolia interprets and ranks queries, see Relevance overview.

Formatting rules

  • An empty string ("") returns all records, sorted by customRanking.
  • Query strings can be up to 512 bytes long.
  • Boolean operators (AND, OR, NOT) aren’t supported in the query string.
  • Multi-word queries require all words to match. For example, hot dog only returns records containing both hot and dog.

Example

Current API clients

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "phone" })
);
final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "phone",
  ),
);
response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("phone"))))
if err != nil {
  // handle the eventual error
  panic(err)
}
SearchResponse response = client.searchSingleIndex("INDEX_NAME", new SearchParamsObject().setQuery("phone"), Hit.class);
const response = await client.searchSingleIndex({ indexName: 'indexName', searchParams: { query: 'phone' } });
var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "phone"),
  )
$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'phone',
    ],
);
response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "phone",
    },
)
response = client.search_single_index("INDEX_NAME", Algolia::Search::SearchParamsObject.new(query: "phone"))
val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("phone")
      )
    )
  ),
  Duration(100, "sec")
)
let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(query: "phone"))
)
index.search(
  new Query("shirt")
);
res, err := index.Search("shirt")
index.search(
  new Query("shirt")
);
index.search("shirt").then(({ hits }) => {
  console.log(hits);
});
index.search(Query("shirt"))
$results = $index->search('shirt');
results = index.search("shirt")
results = index.search("shirt")
client.execute {
  search into "YourIndex" query Query(
    query = Some("shirt")
  )
}
index.search(query: "shirt") { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}
Last modified on April 27, 2026