Skip to main content
Yanked

This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 4.1.1 instead.
Reason given by maintainers: Yanked due to compatibility issues with Flask-AppBuilder. See https://github.com/alisaifee/flask-limiter/issues/479

docs ci codecov pypi license

Flask-Limiter adds rate limiting to Flask applications.

You can configure rate limits at different levels such as:

Flask-Limiter can be configured to fit your application in many ways, including:

  • Persistance to various commonly used storage backends (such as Redis, Memcached & MongoDB) via limits

  • Any rate limiting strategy supported by limits

Follow the quickstart below to get started or read the documentation for more details.

Quickstart

Install

pip install Flask-Limiter

Add the rate limiter to your flask app

# app.py

from flask import Flask
from flask_limiter import Limiter
from flask_limiter.util import get_remote_address

app = Flask(__name__)
limiter = Limiter(
    get_remote_address,
    app=app,
    default_limits=["2 per minute", "1 per second"],
    storage_uri="memory://",
    # Redis
    # storage_uri="redis://localhost:6379",
    # Redis cluster
    # storage_uri="redis+cluster://localhost:7000,localhost:7001,localhost:70002",
    # Memcached
    # storage_uri="memcached://localhost:11211",
    # Memcached Cluster
    # storage_uri="memcached://localhost:11211,localhost:11212,localhost:11213",
    # MongoDB
    # storage_uri="mongodb://localhost:27017",
    strategy="fixed-window", # or "moving-window", or "sliding-window-counter"
)

@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'

Inspect the limits using the command line interface

$ FLASK_APP=app:app flask limiter limits

app
├── fast: /fast
   ├── 2 per 1 minute
   └── 1 per 1 second
├── ping: /ping
   └── Exempt
└── slow: /slow
    └── 1 per 1 day

Run the app

$ FLASK_APP=app:app flask 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

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-3.13.tar.gz (305.6 kB view details)

Uploaded Source

Built Distribution

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

flask_limiter-3.13-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file flask_limiter-3.13.tar.gz.

File metadata

  • Download URL: flask_limiter-3.13.tar.gz
  • Upload date:
  • Size: 305.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flask_limiter-3.13.tar.gz
Algorithm Hash digest
SHA256 f665ddc6531612c435cc8fabd58d48cf3b86b7985571e1e3644bcd389b802329
MD5 637b33077393b86a76f8c2beb889de0a
BLAKE2b-256 fa813aa2cab05ecb7034489dd2415ce8a9b9667f5ca1432c2230523059d4c7ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_limiter-3.13.tar.gz:

Publisher: main.yml on alisaifee/flask-limiter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flask_limiter-3.13-py3-none-any.whl.

File metadata

  • Download URL: flask_limiter-3.13-py3-none-any.whl
  • Upload date:
  • Size: 30.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flask_limiter-3.13-py3-none-any.whl
Algorithm Hash digest
SHA256 2664933f71e3759a518c59cd07e05c2f7bb7614eb88d420ac348b05e32c6cb94
MD5 cd2e2eea93daadeeaf9eea1f5650c0fd
BLAKE2b-256 10f0920f577be4bf3cd578dab32ec9573725cf32f94dc0b8fa65be269a8c0cf4

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_limiter-3.13-py3-none-any.whl:

Publisher: main.yml on alisaifee/flask-limiter

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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