page

Type: integer

Engine default: 0

Parameter syntax

'page' => page_number

page: page_number

page: page_number

'page': page_number

page = page_number

page: Int = page_number

.Page(page_number)

.setPage(page_number)

opt.Page(page_number)

page = Some(page_number)

Can be used in these methods:
search, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, generate_secured_api_key, add_api_key, update_api_key search, browse, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Specify the page to retrieve.

You will need to use this setting if you wish to retrieve specific pages.

Usage notes

Page-numbering is based on the value of hitsPerPage. If hitsPerPage=20, then page=0 will display the hits from 1 to 20, page=2 will display the hits from 41 to 60.
Page numbers are zero-based. Therefore, to retrieve the tenth page, you need to set page=9.
You can see the number of available pages in the value of nbPages in the JSON response to the search query.
If you send a request for a page that doesn’t exist, or is out-of-range, that is, when page is greater than or equal to nbPages, Algolia doesn’t respond with an error. Instead, the response has 0 results.

Examples

Access the nth page of results

Copy

1
2
3
$results = $index->search('query', [
  'page' => 0
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.page, to: 0)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

Did you find this page helpful?

page

About this parameter

Usage notes

Examples

Access the nth page of results

On this page