Skip to main content

Rate limiting for flask applications

Project description

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 & Etcd) 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",
    # Etcd
    # storage_uri="etcd://localhost:2379",
    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 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

Project details


Release history Release notifications | RSS feed

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

Uploaded Source

Built Distribution

Flask_Limiter-3.10.1-py3-none-any.whl (28.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flask_limiter-3.10.1.tar.gz
  • Upload date:
  • Size: 302.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for flask_limiter-3.10.1.tar.gz
Algorithm Hash digest
SHA256 5ff8395f2acbc565ba6af43dc4b9c5b0a3665989681791d01dfaa6388bb332c6
MD5 1f5e08d7ec87019fa9129636034858e4
BLAKE2b-256 3435b5c431680afb9be9aa783537a9b24863335d7a2f088806eb2a82fadb7e1e

See more details on using hashes here.

Provenance

The following attestation bundles were made for flask_limiter-3.10.1.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.10.1-py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Limiter-3.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 afa3bfa9854dd2d3267816fcfcdfa91bcadf055acc4d2461119a2670306fbccb
MD5 dad801cd21883a138d322d671c239052
BLAKE2b-256 d4b3aee889835b5bbbc2977e0ff70fc15684e0e5009e349368cc647dc64ce0ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for Flask_Limiter-3.10.1-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.

Supported by

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