Flask-Limiter provides rate limiting features to flask applications.
It allows configuring various backends to persist the rate limits, which is provided by the limits library.
Compatibility
The 2.x versions of the extension only supports Pythons versions >= 3.7 and Flask >= 2.0.
If you are looking for support for older versions, please refer to the 1.x branch
Quickstart
Add the rate limiter to your flask app. The following example uses the default in memory implementation for storage.
from flask import Flask
from flask_limiter import Limiter
from flask_limiter.util import get_remote_address
app = Flask(__name__)
limiter = Limiter(
app,
key_func=get_remote_address,
default_limits=["2 per minute", "1 per second"],
)
@app.route("/slow")
@limiter.limit("1 per day")
def slow():
return "24"
@app.route("/fast")
def fast():
return "42"
@app.route("/ping")
@limiter.exempt
def ping():
return 'PONG'
app.run()Test it out. The fast endpoint respects the default rate limit while the slow endpoint uses the decorated one. ping has no rate limit associated with it.
$ curl localhost:5000/fast
42
$ curl localhost:5000/fast
42
$ curl localhost:5000/fast
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>429 Too Many Requests</title>
<h1>Too Many Requests</h1>
<p>2 per 1 minute</p>
$ curl localhost:5000/slow
24
$ curl localhost:5000/slow
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<title>429 Too Many Requests</title>
<h1>Too Many Requests</h1>
<p>1 per 1 day</p>
$ curl localhost:5000/ping
PONG
$ curl localhost:5000/ping
PONG
$ curl localhost:5000/ping
PONG
$ curl localhost:5000/ping
PONG1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file Flask-Limiter-2.3.1.tar.gz.
File metadata
- Download URL: Flask-Limiter-2.3.1.tar.gz
- Upload date:
- Size: 247.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8df2731da1ae2769ef51c38c1166d3d761ae9c175641018bc00b9c2e96b8c235
|
|
| MD5 |
747b619ac05189a6543486b8b7416f32
|
|
| BLAKE2b-256 |
30728bd015a5a964b08c8e0b39e13beacfaab7293b1d989d6d4c6c11654187fa
|
File details
Details for the file Flask_Limiter-2.3.1-py3-none-any.whl.
File metadata
- Download URL: Flask_Limiter-2.3.1-py3-none-any.whl
- Upload date:
- Size: 17.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d5af0f4f1036689ccd0b808ce1f3532a7ebfd2b38704accf0f701aae4efb38bd
|
|
| MD5 |
4f39e1cc0b76dce5e564b5aeecbbfeba
|
|
| BLAKE2b-256 |
dc80b965080a0a22af087def46d539c7a298df0ad65412f6d0ddb25e237c925d
|
