Browse for records

Required ACL: browse Searching returns hits (records augmented with highlighting and ranking details). Browsing returns matching records only. Use browse to export your indices.

The Analytics API doesn’t collect data when using browse.
Records are ranked by attributes and custom ranking.
There’s no ranking for typo tolerance, number of matched words, proximity, or geo distance.

Browse requests automatically apply these settings:

advancedSyntax: false
attributesToHighlight: []
attributesToSnippet: []
distinct: false
enablePersonalization: false
enableRules: false
facets: []
getRankingInfo: false
ignorePlurals: false
optionalFilters: []
typoTolerance: true or false (min and strict evaluate to true)

If you send these parameters with your browse requests, they’re ignored.

Usage

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

// Call the API
var response = await client.BrowseAsync<Hit>("<YOUR_INDEX_NAME>");

// print the response
Console.WriteLine(response);

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

// Call the API
final response = await client.browse(
  indexName: "<YOUR_INDEX_NAME>",
);

// print the response
print(response);

// Initialize the client
client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
  // The client can fail to initialize if you pass an invalid parameter.
  panic(err)
}

// Call the API
response, err := client.Browse(client.NewApiBrowseRequest(
  "<YOUR_INDEX_NAME>"))
if err != nil {
  // handle the eventual error
  panic(err)
}


// print the response
print(response)

// Initialize the client
SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

// Call the API
BrowseResponse response = client.browse("<YOUR_INDEX_NAME>", Hit.class);

// print the response
System.out.println(response);

// Initialize the client
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

// Call the API
const response = await client.browse({ indexName: 'cts_e2e_browse' });


// print the response
console.log(response);

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

// Call the API
var response = client.browse(indexName = "<YOUR_INDEX_NAME>")


// print the response
println(response)

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

// Call the API
$response = $client->browse(
    '<YOUR_INDEX_NAME>',
);


// print the response
var_dump($response);

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

# Call the API
response = client.browse(
    index_name="<YOUR_INDEX_NAME>",
)


# print the response
print(response)

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

# Call the API
response = client.browse("<YOUR_INDEX_NAME>")


# print the response
puts(response)

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

// Call the API
val response = Await.result(
  client.browse(
    indexName = "<YOUR_INDEX_NAME>"
  ),
  Duration(100, "sec")
)

// print the response
println(response)

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

// Call the API
let response: BrowseResponse<Hit> = try await client.browse(indexName: "<YOUR_INDEX_NAME>")

// print the response
print(response)

See the full API reference

For more details about input parameters and response fields.

​Usage

See the full API reference

Usage