From 12f0470ff4605aadf5952174e160401712e1e30e Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 15 Dec 2014 16:55:09 -0800 Subject: [PATCH] [DOC] REST - warning about limit=all timeouts --- content/ripplerest_api.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/ripplerest_api.md b/content/ripplerest_api.md index b3e589189e..227bcfdb0a 100644 --- a/content/ripplerest_api.md +++ b/content/ripplerest_api.md @@ -569,11 +569,13 @@ Optionally, you can also include any of the following query parameters: | currency | String ([ISO 4217 Currency Code](http://www.xe.com/iso4217.php)) | If provided, only include balances in the given currency. | | counterparty | String (Address) | If provided, only include balances issued by the provided address (usually a gateway). | | marker | String | Server-provided value that marks where to resume pagination. | -| limit | String (Integer or 'all') | (Defaults to 200) Max results per response. Cannot be less than 10. Cannot be greater than 400. Use 'all' to return all results | +| limit | String (Integer or `all`) | (Defaults to 200) Max results per response. Cannot be less than 10. Cannot be greater than 400. Use `all` to return all results | | ledger | String (ledger hash or sequence, or 'validated', 'current', or 'closed') | (Defaults to 'validated') Identifying ledger version to pull results from. | *Note:* Pagination using `limit` and `marker` requires a consistent ledger version, so you must also provide the `ledger` hash or sequence query parameter to use pagination. +*Caution:* When an account holds balances on a very large number of trust lines, specifying `limit=all` may take a long time or even time out. If you experience timeouts, try again later, or specify a smaller limit. + #### Response #### ```js