Pagination

APIs with larger collection payloads must support pagination to mitigate the increasing lookup time and size of the responses.

Swift supports two pagination types: offset/limit and cursor/limit

Offset - Defines the moving 'window' of results to return relative to the start of the collection.
Cursor - opaque keys (cursors) passed to get the next results.
Limit - The maximum number of items to return in a page. If unspecified, the default limit will be returned. If the limit specified is greater than the maximum permitted by the API, then the API will return the maximum permitted limit.

Pagination is requested by a client through query parameters and represented as a JSON object.

When returning paginated results, a service should support JSON formatted responses based on the standard template with the following fields:

	Offset/Limit	Cursor/Limit
Advantages	More widely known and supported by frameworks Can jump to a specific page Can return the total number of pages	Suitable for large datasets (more efficient to calculate than offset) More stable (less error-prone in how the pagination window is calculated More future-proof in database structure support (works on sharded / NoSQL databases)
Drawbacks	More error-prone - duplicates and missing entries can occur if items are deleted or added between paging requests Does not scale on large datasets Less future-proof in database structure support - does not work on multiple database tables, sharding, NoSQL

Previous page Rate Limit