Flask-Limiter

Pre-release

This release is a pre-release and may not be stable for production use.

Flask-Limiter provides rate limiting features to Flask applications.

Sponsored by Zuplo a fully-managed API Gateway for developers. Add dynamic rate-limiting authentication and more to any API in minutes. Learn more at zuplo.com

You can configure rate limits at different levels such as:

Application wide global limits per user
Default limits per route
By Blueprints
By Class-based views
By individual routes

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"
)

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

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

Metadata

Release files for Flask-Limiter 3.0.0b1

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 3.0.0b1
File	Size	Uploaded
Flask-Limiter-3.0.0b1.tar.gz	286.3 kB	Dec 27, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for Flask-Limiter 3.0.0b1
File	Interpreter	ABI	Platform	Reset
Flask_Limiter-3.0.0b1-py3-none-any.whl 27.5 kB Dec 27, 2022	Python 3	none	any	Details

Total release size: 313.7 kB

Release files / Flask-Limiter-3.0.0b1.tar.gz

Download URL	Flask-Limiter-3.0.0b1.tar.gz
Size	286.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`648578fe1a91687bd364dfd6332063506e06b233d29aae6cab17f6837e98072d`
BLAKE2b-256 checksum How to use checksums	`c5ba9c277188e39c9e54b51d8eca5f22f67e43d30334b6edf00f214f1d5c3169`
Upload date	Dec 27, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.16`

Release files / Flask_Limiter-3.0.0b1-py3-none-any.whl

Download URL	Flask_Limiter-3.0.0b1-py3-none-any.whl
Size	27.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ec70dff912a118dd124a67950309386b5dea9d7f99411aaffb10770706312c92`
BLAKE2b-256 checksum How to use checksums	`c7c379604ed7510774c40e05bf59c80922f760441d342760fee6f55e1d4ef15b`
Upload date	Dec 27, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.9.16`