Skip to main content

docs ci codecov pypi license

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Limiter-2.1.tar.gz (244.7 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

Flask_Limiter-2.1-py3.9.egg (28.0 kB view details)

Uploaded Egg

Flask_Limiter-2.1-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file Flask-Limiter-2.1.tar.gz.

File metadata

  • Download URL: Flask-Limiter-2.1.tar.gz
  • Upload date:
  • Size: 244.7 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for Flask-Limiter-2.1.tar.gz
Algorithm Hash digest
SHA256 cf4252e31bdb4695e59378263d0019164abc895a0b13e30406ffc3f168a952e7
MD5 6c5b790a370814d5e30d2edb423f96cf
BLAKE2b-256 dd93059a0457308b50119798f297086e57f0e79a8fb6aedd5c48de41631da18a

See more details on using hashes here.

File details

Details for the file Flask_Limiter-2.1-py3.9.egg.

File metadata

  • Download URL: Flask_Limiter-2.1-py3.9.egg
  • Upload date:
  • Size: 28.0 kB
  • Tags: Egg
  • Uploaded using 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

File hashes

Hashes for Flask_Limiter-2.1-py3.9.egg
Algorithm Hash digest
SHA256 737879086a132f59942bb5084609ea5d6d16da59d571953312d5d5d575e42764
MD5 f3bc38a992933af8a6c31d9f42eb7cbf
BLAKE2b-256 df153f6634e9b358dec86f84e3bf18451ca3d9e6649dc0501671d2f65e225678

See more details on using hashes here.

File details

Details for the file Flask_Limiter-2.1-py3-none-any.whl.

File metadata

  • Download URL: Flask_Limiter-2.1-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for Flask_Limiter-2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf5a8114bed84eafaa986c798f7ec3f25889897db925330cc092bc3cbf02f620
MD5 d969458dfe3813f734992954e3d54dc3
BLAKE2b-256 13001e7c303059cfda35bdc433c0aa012f3b1e909b2c18e5c7430d05ca003372

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.1

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page