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.3.tar.gz (243.9 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.3-py3.8.egg (28.0 kB view details)

Uploaded Egg

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: Flask-Limiter-2.1.3.tar.gz
  • Upload date:
  • Size: 243.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for Flask-Limiter-2.1.3.tar.gz
Algorithm Hash digest
SHA256 28c6b3c51fcbfab131e592dec7cf826ccc02dfb7cc4fe3e16c8ac21058672467
MD5 033154c3c70865317d0ffbe6b41258c3
BLAKE2b-256 e6bea91f7e1c3eb43a7bbd5e4508af73880d6271076abd5cad6210efa029d74f

See more details on using hashes here.

File details

Details for the file Flask_Limiter-2.1.3-py3.8.egg.

File metadata

  • Download URL: Flask_Limiter-2.1.3-py3.8.egg
  • Upload date:
  • Size: 28.0 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for Flask_Limiter-2.1.3-py3.8.egg
Algorithm Hash digest
SHA256 66697f9793cb8ed3b388c70297715ac14fc8958e0d206b1fcac998997e3e98ba
MD5 9b1c95fa4b72cf04798e82d01f5875de
BLAKE2b-256 8cc7d57826ac652618d3ba05ac03196dc059e6753c04c9013675a522158d459b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Flask_Limiter-2.1.3-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.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.12

File hashes

Hashes for Flask_Limiter-2.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2ad327f8b625bff29f581d4db28b2dafe12526c6cc782bd8e4a5614f7d664f98
MD5 d06168deb02ce88dcb7b31cadbc62d6c
BLAKE2b-256 7f18e37e69a2ef19cfdf3a5bdea1f596d4bf8cbe35d7bbbdb8f6e775d423792d

See more details on using hashes here.

Release history Release notifications | RSS feed

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