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.2.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.2-py3.9.egg (28.0 kB view details)

Uploaded Egg

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: Flask-Limiter-2.1.2.tar.gz
  • Upload date:
  • Size: 243.9 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.2.tar.gz
Algorithm Hash digest
SHA256 bc240c75f9829851e4e745b4fb357d6ea4fc62935a70a1d060f7616dff1f43cd
MD5 285c263dbf24b7bbb44872f61c1eb332
BLAKE2b-256 d450eaaca3438483886d83776ce9bd7a447ba14f40bfd92ed2986b76e92f523a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Flask_Limiter-2.1.2-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.2-py3.9.egg
Algorithm Hash digest
SHA256 4728441b5cfa156b167419fc4a7479d7634f4dd88680d666e0e4e558038d43ce
MD5 2cd826e1a983c69d7a25823c9d4d3058
BLAKE2b-256 eae9048b5f69baebcbf14b4ec076a387c1cd5fc7e9ddb4020a7da8effd6cdb40

See more details on using hashes here.

File details

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

File metadata

  • Download URL: Flask_Limiter-2.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b99708fa61ce66c4c2849c744eeaf4b7ac48e704f350e6caa1ce084fb65e32fb
MD5 190e1d12b5c7dca3effc2cda7c5a0125
BLAKE2b-256 649da7b1c74be3ac8c1261067711ada0820051dc8c4f5d89b6e03869d9156282

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