Skip to content

Commit 2654276

Browse files
Document RPC pagination limits (#2572)
* Document RPC pagination limits * clarify pagination upper limits configuration * Revert "clarify pagination upper limits configuration" This reverts commit eb67693. --------- Co-authored-by: Elliot <elliot@stellar.org>
1 parent fe9a599 commit 2654276

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

docs/data/apis/rpc/api-reference/structure/pagination.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ title: Pagination
66
For methods which support it, the pagination arguments are passed as a final object argument with two values:
77

88
- `cursor`: string - (optional) An opaque string which acts as a paging token. Each response will include a `cursor` field which can be included in a subsequent request to obtain the next page of results.
9-
- `limit`: number - (optional) The maximum number of records returned. The limit for [getEvents](../methods/getEvents.mdx) can range from 1 to 10000 - an upper limit that is hardcoded in Stellar-RPC for performance reasons. If this argument isn't designated, it defaults to 100.
9+
- `limit`: number - (optional) The maximum number of records returned. Each paginated method has a method-specific range and default.
10+
11+
| Method | Limit range | Default limit |
12+
| --- | --- | --- |
13+
| [`getEvents`](../methods/getEvents.mdx) | 1 to 10000 | 100 |
14+
| [`getLedgers`](../methods/getLedgers.mdx) | 1 to 200 | 50 |
15+
| [`getTransactions`](../methods/getTransactions.mdx) | 1 to 200 | 50 |
16+
17+
These upper limits are hardcoded in Stellar RPC for performance reasons.
1018

1119
For example, calling a method with pagination parameter set:
1220

0 commit comments

Comments
 (0)