meta.pagination, and follow next_cursor until has_more is false. Cursors are stable for the result set you started, so paging stays consistent even as new observations arrive.
This page covers the query parameters, the meta.pagination block, and a complete loop in cURL and TypeScript.
Query parameters
All list endpoints accept the same paging controls.Page size, from 1 to 500. Defaults to 100. Larger pages mean fewer round trips; smaller pages mean lower latency per request.
An opaque cursor that marks where the next page begins. Omit it on your first request. On every subsequent request, pass the
next_cursor value from the previous response. Do not construct or parse cursor values: treat them as opaque tokens.The field to sort by. The set of sortable fields depends on the endpoint. Consult the OpenAPI spec for what each endpoint supports.
Sort direction:
asc or desc. Defaults to asc.The pagination block
List responses carry the cursor state undermeta.pagination. (Item responses do not paginate and omit this block.)
The page size applied to this request.
The cursor you supplied for this page, or
null on the first page.The cursor to pass on your next request.
null when there are no more pages.true when more pages remain. Loop while this is true.First page response (truncated)
The loop
The rule is one line: whilemeta.pagination.has_more is true, repeat the request with cursor set to the previous next_cursor. Stop when has_more is false (equivalently, when next_cursor is null).
Request the first page
Call the endpoint with your filters and an optional
limit. Do not send cursor.Notes
- Cursors are opaque. Their internal format is not part of the contract and may change. Read them from
next_cursorand pass them back verbatim. - Keep your filters identical across pages. Changing
country,indicator,sort, orordermid-walk invalidates the cursor. - A page may contain fewer than
limititems and still havehas_more: true. Always trusthas_more, never the item count, to decide whether to continue.
Response envelope
Where
meta.pagination lives within the shared envelope.