aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/index.rst13
1 files changed, 11 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 0b0f1ca..4e79032 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -50,8 +50,8 @@ of this time, it is feature complete for Mastodon version 2.1.0.
50 50
51A note about rate limits 51A note about rate limits
52------------------------ 52------------------------
53Mastodons API rate limits per IP. By default, the limit is 300 requests per 5 minute 53Mastodons API rate limits per user account. By default, the limit is 300 requests
54time slot. This can differ from instance to instance and is subject to change. 54per 5 minute time slot. This can differ from instance to instance and is subject to change.
55Mastodon.py has three modes for dealing with rate limiting that you can pass to 55Mastodon.py has three modes for dealing with rate limiting that you can pass to
56the constructor, "throw", "wait" and "pace", "wait" being the default. 56the constructor, "throw", "wait" and "pace", "wait" being the default.
57 57
@@ -76,6 +76,15 @@ a loop without ever sleeping at all yourself. It is for applications that would
76just pretend there is no such thing as a rate limit and are fine with sometimes not 76just pretend there is no such thing as a rate limit and are fine with sometimes not
77being very interactive. 77being very interactive.
78 78
79In addition to the per-user limit, there is a per-IP limit of 7500 requests per 5
80minute time slot, and tighter limits on logins. Mastodon.py does not make any effort
81to respect these.
82
83If your application requires many hits to endpoints that are available without logging
84in, do consider using Mastodon.py without authenticating to get the full per-IP limit. In
85this case, you can set the Mastodon objects `ratelimit_limit` and `ratelimit_remaining`
86properties appropriately if you want to use advanced rate limit handling.
87
79A note about pagination 88A note about pagination
80----------------------- 89-----------------------
81Many of Mastodons API endpoints are paginated. What this means is that if you request 90Many of Mastodons API endpoints are paginated. What this means is that if you request
Powered by cgit v1.2.3 (git 2.41.0)