diff options
author | Lorenz Diener <[email protected]> | 2017-12-15 21:16:06 +0100 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2017-12-15 21:16:06 +0100 |
commit | 4629807ca530d8223e90a707b302b4583c0f2728 (patch) | |
tree | 63c56b1b29bee7201615a68b65b9848cb7321eab /docs | |
parent | f55ff45393182659fa61196771d77b871d886b2c (diff) | |
download | mastodon.py-4629807ca530d8223e90a707b302b4583c0f2728.tar.gz |
FURTHER release preparations
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 13 |
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 | ||
51 | A note about rate limits | 51 | A note about rate limits |
52 | ------------------------ | 52 | ------------------------ |
53 | Mastodons API rate limits per IP. By default, the limit is 300 requests per 5 minute | 53 | Mastodons API rate limits per user account. By default, the limit is 300 requests |
54 | time slot. This can differ from instance to instance and is subject to change. | 54 | per 5 minute time slot. This can differ from instance to instance and is subject to change. |
55 | Mastodon.py has three modes for dealing with rate limiting that you can pass to | 55 | Mastodon.py has three modes for dealing with rate limiting that you can pass to |
56 | the constructor, "throw", "wait" and "pace", "wait" being the default. | 56 | the 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 | |||
76 | just pretend there is no such thing as a rate limit and are fine with sometimes not | 76 | just pretend there is no such thing as a rate limit and are fine with sometimes not |
77 | being very interactive. | 77 | being very interactive. |
78 | 78 | ||
79 | In addition to the per-user limit, there is a per-IP limit of 7500 requests per 5 | ||
80 | minute time slot, and tighter limits on logins. Mastodon.py does not make any effort | ||
81 | to respect these. | ||
82 | |||
83 | If your application requires many hits to endpoints that are available without logging | ||
84 | in, do consider using Mastodon.py without authenticating to get the full per-IP limit. In | ||
85 | this case, you can set the Mastodon objects `ratelimit_limit` and `ratelimit_remaining` | ||
86 | properties appropriately if you want to use advanced rate limit handling. | ||
87 | |||
79 | A note about pagination | 88 | A note about pagination |
80 | ----------------------- | 89 | ----------------------- |
81 | Many of Mastodons API endpoints are paginated. What this means is that if you request | 90 | Many of Mastodons API endpoints are paginated. What this means is that if you request |