From 4629807ca530d8223e90a707b302b4583c0f2728 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Fri, 15 Dec 2017 21:16:06 +0100 Subject: [PATCH] FURTHER release preparations --- docs/index.rst | 13 +++++++++++-- 1 file 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. A note about rate limits ------------------------ -Mastodons API rate limits per IP. By default, the limit is 300 requests per 5 minute -time slot. This can differ from instance to instance and is subject to change. +Mastodons API rate limits per user account. By default, the limit is 300 requests +per 5 minute time slot. This can differ from instance to instance and is subject to change. Mastodon.py has three modes for dealing with rate limiting that you can pass to the constructor, "throw", "wait" and "pace", "wait" being the default. @@ -76,6 +76,15 @@ a loop without ever sleeping at all yourself. It is for applications that would just pretend there is no such thing as a rate limit and are fine with sometimes not being very interactive. +In addition to the per-user limit, there is a per-IP limit of 7500 requests per 5 +minute time slot, and tighter limits on logins. Mastodon.py does not make any effort +to respect these. + +If your application requires many hits to endpoints that are available without logging +in, do consider using Mastodon.py without authenticating to get the full per-IP limit. In +this case, you can set the Mastodon objects `ratelimit_limit` and `ratelimit_remaining` +properties appropriately if you want to use advanced rate limit handling. + A note about pagination ----------------------- Many of Mastodons API endpoints are paginated. What this means is that if you request