hitsPerPage

Number of search results per page

• Type: integer
• Default: 20
• Min: 1
• Max: 20
• Scope: settings,search

Algolia uses the page and hitsPerPage parameters to control how search results are paginated. hitsPerPage sets the number of search results (hits) displayed per page.

With page and hitsPerPage, the response includes these fields:

{
  // ...
  "page": 1,
  "nbPages": 20,
  "hitsPerPage": 10,
  // ...
}

Examples

Current API clients

Set default number of hits per page

C#

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings { HitsPerPage = 20 }
);

Override default number of hits per page for the current search

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "ALGOLIA_INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", HitsPerPage = 10 })
);

Legacy API clients

Set default number of hits per page

C#

IndexSettings settings = new IndexSettings();
settings.HitsPerPage = 20;

index.SetSettings(settings);

Override default number of hits per page for the current search

C#

index.Search(new Query("query")
{
    HitsPerPage = 10
});