https://github.com/symfony/rate-limiter
Provides a Token Bucket implementation to rate limit input and output in your application
https://github.com/symfony/rate-limiter
component limiter php rate-limiter symfony symfony-component
Last synced: 18 days ago
JSON representation
Provides a Token Bucket implementation to rate limit input and output in your application
- Host: GitHub
- URL: https://github.com/symfony/rate-limiter
- Owner: symfony
- License: mit
- Created: 2020-09-16T16:15:59.000Z (over 5 years ago)
- Default Branch: 8.1
- Last Pushed: 2026-03-04T15:01:30.000Z (20 days ago)
- Last Synced: 2026-03-04T22:57:41.037Z (20 days ago)
- Topics: component, limiter, php, rate-limiter, symfony, symfony-component
- Language: PHP
- Homepage: https://symfony.com/rate-limiter
- Size: 349 KB
- Stars: 265
- Watchers: 6
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Rate Limiter Component
======================
The Rate Limiter component provides a Token Bucket implementation to
rate limit input and output in your application.
Getting Started
---------------
```bash
composer require symfony/rate-limiter
```
```php
use Symfony\Component\RateLimiter\Storage\InMemoryStorage;
use Symfony\Component\RateLimiter\RateLimiterFactory;
$factory = new RateLimiterFactory([
'id' => 'login',
'policy' => 'token_bucket',
'limit' => 10,
'rate' => ['interval' => '15 minutes'],
], new InMemoryStorage());
$limiter = $factory->create();
// blocks until 1 token is free to use for this process
$limiter->reserve(1)->wait();
// ... execute the code
// only claims 1 token if it's free at this moment (useful if you plan to skip this process)
if ($limiter->consume(1)->isAccepted()) {
// ... execute the code
}
```
Resources
---------
* [Contributing](https://symfony.com/doc/current/contributing/index.html)
* [Report issues](https://github.com/symfony/symfony/issues) and
[send Pull Requests](https://github.com/symfony/symfony/pulls)
in the [main Symfony repository](https://github.com/symfony/symfony)