Flask-Limiter

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
PONG

Read the docs

Metadata

Release files for Flask-Limiter 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Flask-Limiter 2.1.1
File	Size	Uploaded
Flask-Limiter-2.1.1.tar.gz	244.0 kB	Jan 30, 2022	Details

Built distributions (wheels)

Table of built distributions (wheels) for Flask-Limiter 2.1.1
File	Interpreter	ABI	Platform	Reset
Flask_Limiter-2.1.1-py3.9.egg 28.0 kB Jan 30, 2022	Legacy Egg format	-	-	Details
Flask_Limiter-2.1.1-py3-none-any.whl 13.8 kB Jan 30, 2022	Python 3	none	any	Details

Total release size: 285.8 kB

Release files / Flask-Limiter-2.1.1.tar.gz

Download URL	Flask-Limiter-2.1.1.tar.gz
Size	244.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`574c0503d63ec5ffbbd077e7c4b5cf61079844ab1c5db7f9201bdabe191b3c04`
BLAKE2b-256 checksum How to use checksums	`7bd7a048baafd737fe689274e9c9158e9fea89c02624d00dd739dfd1a9a7b18d`
Upload date	Jan 30, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7`

Release files / Flask_Limiter-2.1.1-py3.9.egg

Download URL	Flask_Limiter-2.1.1-py3.9.egg
Size	28.0 kB
Tags	Egg
SHA-256 checksum How to use checksums	`385baaeb731e51a6f89f8db8e815f216e94dc61531c1fffe4b00f07a4d707909`
BLAKE2b-256 checksum How to use checksums	`f8cd81c4261a2241f93d3f2c171273c401808f62697330d964d1f870e47f5e52`
Upload date	Jan 30, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7`

Release files / Flask_Limiter-2.1.1-py3-none-any.whl

Download URL	Flask_Limiter-2.1.1-py3-none-any.whl
Size	13.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`281de2746de0a39e62a4d0aa4359e5d84a065a2cc21831455ea11f6e9b2d8948`
BLAKE2b-256 checksum How to use checksums	`3ccdb43b91d43cd50d600d8ee618cf5ef677e277ec1f25bb2362ffa01cd808dd`
Upload date	Jan 30, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7`