API Reference / API Parameters / page
Jan. 14, 2019
Type: integer
Engine default: 0
Parameter syntax
'page' => page_number

Can be used in these methods:

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 numbers

    • 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, in order to retrieve the 10th page, you need to set page=9.

  • If you send a request for a page that does not exist, or is out-of-range (i.e. when page > nbPages), we do not return an error. Instead, we return 0 results.

Examples

Access the nth page of results

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

Did you find this page helpful?