Skip to main content

PaginatedResult

Methods that return large datasets use server-side pagination (100 items per page). These return a PaginatedResult<T> with built-in navigation helpers.

Exporting to CSV

Any paginated result can be exported to CSV. This triggers a server-side export and returns a download URL:

Response Types

Search and query methods support a responseType option that controls how results are returned. Import the ResponseType enum:

Fast Mode (default)

Returns results immediately without polling. Use limit to constrain the number of results (max 300):
Fast mode skips async operation polling, making it significantly faster for small result sets. Use it when you need a quick preview or only need a limited number of results.

Paging Mode

Returns paginated results with full totalRows, totalPages, and navigation helpers:

CSV Mode

Initiates an async export. Call exportCsv() on the result to poll the export operation and get a download URL:

Methods Supporting Response Types

The following methods accept both responseType and limit:
  • twitter.getPostsByAuthor(), twitter.searchPosts(), twitter.getUsersByKeywords()
  • instagram.getPostsByUser(), instagram.searchPosts(), instagram.getUsersByKeywords()
  • reddit.searchPosts()
  • tiktok.getPostsByUser(), tiktok.searchPosts(), tiktok.getUsersByKeywords(), tiktok.getPostsByHashtags(), tiktok.getUsersByHashtags()
These methods accept limit only (no responseType):
  • twitter.searchUsers(), instagram.searchUsers(), reddit.searchUsers(), reddit.searchSubreddits(), tiktok.searchUsers()
For the equivalent pagination patterns in Python, see Python SDK Pagination. The Python SDK uses ResponseType.FAST, ResponseType.PAGING, and ResponseType.CSV (uppercase enum values) and snake_case field names.