aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst
index a7d2945..952db50 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -120,10 +120,13 @@ Many of Mastodons API endpoints are paginated. What this means is that if you re
120data from them, you might not get all the data at once - instead, you might only get the 120data from them, you might not get all the data at once - instead, you might only get the
121first few results. 121first few results.
122 122
123All endpoints that are paginated have three parameters: since_id, max_id and limit. 123All endpoints that are paginated have four parameters: since_id, max_id, min_id and
124since_id allows you to specify the smallest id you want in the returned data. max_id, 124limit. since_id allows you to specify the smallest id you want in the returned data, but
125similarly, allows you to specify the largest. By specifying either one (generally, 125you will still always get the newest data, so if there are too many statuses between
126only one, not both) of them you can go through pages forwards and backwards. 126the newest one and since_id, some will not be returned. min_id, on the other hand, gives
127you statuses with that minimum id and newer, starting at the given id. max_id, similarly,
128allows you to specify the largest id you want. By specifying either min_id or max_id
129(generally, only one, not both) of them you can go through pages forwards and backwards.
127 130
128limit allows you to specify how many results you would like returned. Note that an 131limit allows you to specify how many results you would like returned. Note that an
129instance may choose to return less results than you requested - by default, Mastodon 132instance may choose to return less results than you requested - by default, Mastodon
Powered by cgit v1.2.3 (git 2.41.0)