PHPackages yiisoft/rate-limiter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. yiisoft/rate-limiter ActiveLibrary[Framework](/categories/framework) yiisoft/rate-limiter ==================== Yii Rate Limiter Middleware 3.0.0(2y ago)2965.5k—5.7%10[1 issues](https://github.com/yiisoft/rate-limiter/issues)BSD-3-ClausePHPPHP ^8.0CI passing Since Jun 7Pushed 5mo ago16 watchersCompare [ Source](https://github.com/yiisoft/rate-limiter)[ Packagist](https://packagist.org/packages/yiisoft/rate-limiter)[ Docs](https://www.yiiframework.com/)[ GitHub Sponsors](https://github.com/yiisoft)[ Fund](https://opencollective.com/yiisoft)[ RSS](/packages/yiisoft-rate-limiter/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (1)Dependencies (15)Versions (5)Used By (0) [ ![Yii](https://camo.githubusercontent.com/8317c17418b39410a660f5149071d26c5023c0d5fb2b7ebb771324812f666d73/68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667) ](https://github.com/yiisoft) Yii Rate Limiter Middleware =========================== [](#yii-rate-limiter-middleware) [![Latest Stable Version](https://camo.githubusercontent.com/21f052ebe8dfc6664af83b7fbf29fb689051b835bbef29eea92b06aac3d83ca6/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726174652d6c696d697465722f762f737461626c652e706e67)](https://packagist.org/packages/yiisoft/rate-limiter)[![Total Downloads](https://camo.githubusercontent.com/9cf5ec1249299735ac6983d7b7a071301c5a5732445574fd4d856dc34bbc9bd8/68747470733a2f2f706f7365722e707567782e6f72672f796969736f66742f726174652d6c696d697465722f646f776e6c6f6164732e706e67)](https://packagist.org/packages/yiisoft/rate-limiter)[![Build status](https://github.com/yiisoft/rate-limiter/workflows/build/badge.svg)](https://github.com/yiisoft/rate-limiter/actions?query=workflow%3Abuild)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/e9bf5de76fd8b3aad22a1f72aec7a2059e4f0b100b09e3d7397a6c1981f710e5/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f726174652d6c696d697465722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/rate-limiter/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/e5c9c6366da721d15168348fd9a4b280cd9caaa33c630139370dbf9059e3362a/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f796969736f66742f726174652d6c696d697465722f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/yiisoft/rate-limiter/?branch=master)[![Mutation testing badge](https://camo.githubusercontent.com/252eb6b3e77338f283fe41fa5c74744d252597633fcb601cb2f324f03b963d61/68747470733a2f2f696d672e736869656c64732e696f2f656e64706f696e743f7374796c653d666c61742675726c3d687474707325334125324625324662616467652d6170692e737472796b65722d6d757461746f722e696f2532466769746875622e636f6d253246796969736f6674253246726174652d6c696d697465722532466d6173746572)](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/rate-limiter/master)[![static analysis](https://github.com/yiisoft/rate-limiter/workflows/static%20analysis/badge.svg)](https://github.com/yiisoft/rate-limiter/actions?query=workflow%3A%22static+analysis%22)[![type-coverage](https://camo.githubusercontent.com/68895f44701d2e7bc534d92c87bf8c36ee5f7e68317c538ea5dd1f822ddae9e8/68747470733a2f2f73686570686572642e6465762f6769746875622f796969736f66742f726174652d6c696d697465722f636f7665726167652e737667)](https://shepherd.dev/github/yiisoft/rate-limiter) Rate limiter middleware helps to prevent abuse by limiting the number of requests that could be me made consequentially. For example, you may want to limit the API usage of each user to be at most 100 API calls within a period of 10 minutes. If too many requests are received from a user within the stated period of the time, a response with status code 429 (meaning "Too Many Requests") should be returned. Requirements ------------ [](#requirements) - PHP 8.0 or higher. Installation ------------ [](#installation) The package could be installed with [Composer](https://getcomposer.org): ``` composer require yiisoft/rate-limiter ``` General usage ------------- [](#general-usage) ``` use Psr\Http\Message\ServerRequestInterface; use Yiisoft\Yii\RateLimiter\LimitRequestsMiddleware; use Yiisoft\Yii\RateLimiter\Counter; use Nyholm\Psr7\Factory\Psr17Factory; use Yiisoft\Yii\RateLimiter\Policy\LimitAlways; use Yiisoft\Yii\RateLimiter\Policy\LimitPerIp; use Yiisoft\Yii\RateLimiter\Policy\LimitCallback; use Yiisoft\Yii\RateLimiter\Storage\StorageInterface; use Yiisoft\Yii\RateLimiter\Storage\SimpleCacheStorage; /** @var StorageInterface $storage */ $storage = new SimpleCacheStorage($cache); $counter = new Counter($storage, 2, 5); $responseFactory = new Psr17Factory(); $middleware = new LimitRequestsMiddleware($counter, $responseFactory); // LimitPerIp by default ``` In the above 2 is the maximum number of counter increments (requests) that could be performed before increments are limited and 5 is a period to apply limit to, in seconds. The `Counter` implements [generic cell rate limit algorithm (GCRA)](https://en.wikipedia.org/wiki/Generic_cell_rate_algorithm)that ensures that after reaching the limit further increments are distributed equally. > Note: While it is sufficiently effective, it is preferred to use [Nginx](https://www.nginx.com/blog/rate-limiting-nginx/)or another webserver capabilities for rate limiting. This package allows rate-limiting in the project with deployment environment you cannot control such as installable CMS. ### Implementing your own limiting policy [](#implementing-your-own-limiting-policy) There are two ready to use limiting policies available in the package: - `LimitAlways` - to count all incoming requests. - `LimitPerIp` - to count requests from different IPs separately. These could be applied as follows: ``` $middleware = new LimitRequestsMiddleware($counter, $responseFactory, new LimitPerIp()); // or $middleware = new LimitRequestsMiddleware($counter, $responseFactory, new LimitAlways()); ``` Easiest way to customize a policy is to use `LimitCallback`: ``` $middleware = new LimitRequestsMiddleware($counter, $responseFactory, new LimitCallback(function (ServerRequestInterface $request): string { // return user id from database if authentication id used i.e. limit guests and each authenticated user separately. })); ``` Another way it to implement `Yiisoft\Yii\RateLimiter\Policy\LimitPolicyInterface` and use it in a similar way as above. ### Implementing your own counter storage [](#implementing-your-own-counter-storage) There are two ready to use counter storages available in the package: - `\Yiisoft\Yii\RateLimiter\Storage\SimpleCacheStorage` - stores counters in any [PSR-16](https://www.php-fig.org/psr/psr-16/) cache. - `\Yiisoft\Yii\RateLimiter\Storage\ApcuStorage` - stores counters by using the [APCu PHP extension](https://www.php.net/apcu) while taking concurrency into account. To use your own storage implement `Yiisoft\Yii\RateLimiter\Storage\StorageInterface`. Documentation ------------- [](#documentation) - [Internals](docs/internals.md) If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community). License ------- [](#license) The Yii Rate Limiter Middleware is free software. It is released under the terms of the BSD License. Please see [`LICENSE`](./LICENSE.md) for more information. Maintained by [Yii Software](https://www.yiiframework.com/). Support the project ------------------- [](#support-the-project) [![Open Collective](https://camo.githubusercontent.com/a2b15f8e2268d4e3842e00d41ff7a57cce2ad8bd8d8769c5dc4fa05a546a4f62/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4f70656e253230436f6c6c6563746976652d73706f6e736f722d3765616466313f6c6f676f3d6f70656e253230636f6c6c656374697665266c6f676f436f6c6f723d376561646631266c6162656c436f6c6f723d353535353535)](https://opencollective.com/yiisoft) Follow updates -------------- [](#follow-updates) [![Official website](https://camo.githubusercontent.com/d6b0929173e28cc627430d2519ca1853466a70f37395877eaf4820cb3e1e1909/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f506f77657265645f62792d5969695f4672616d65776f726b2d677265656e2e7376673f7374796c653d666c6174)](https://www.yiiframework.com/)[![Twitter](https://camo.githubusercontent.com/d077c362ac639792171af8bc002ee827816733dfc0925f70b557e6d151022226/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d666f6c6c6f772d3144413146323f6c6f676f3d74776974746572266c6f676f436f6c6f723d314441314632266c6162656c436f6c6f723d3535353535353f7374796c653d666c6174)](https://twitter.com/yiiframework)[![Telegram](https://camo.githubusercontent.com/4e38dd12535575c39c65bea7119b95e663abb2d1f4e3d669a27bbda07ef603f0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f74656c656772616d2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d74656c656772616d)](https://t.me/yii3en)[![Facebook](https://camo.githubusercontent.com/48204e301b34b29b0815854544f04c337fc0692096cab35e9a1f8c53a42c2307/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f66616365626f6f6b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d66616365626f6f6b266c6f676f436f6c6f723d666666666666)](https://www.facebook.com/groups/yiitalk)[![Slack](https://camo.githubusercontent.com/1a3645ba1c97e6684d0349bc478201e1621ba0d3efad516d81035364d442bad7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f736c61636b2d6a6f696e2d3144413146323f7374796c653d666c6174266c6f676f3d736c61636b)](https://yiiframework.com/go/slack) ### Health Score 47 — FairBetter than 94% of packages Maintenance48 Moderate activity, may be stable Popularity42 Moderate usage in the ecosystem Community28 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor3 3 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~259 days Total 4 Last Release 1028d ago Major Versions 1.0.1 → 2.0.02021-08-15 2.0.0 → 3.0.02023-07-26 PHP version history (2 changes)1.0.0PHP ^7.4|^8.0 3.0.0PHP ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/261a6249c6f605f3956a2fae40fbb813f6b2e1e6f2bf806180c851a965426e54?d=identicon)[cebe](/maintainers/cebe) ![](https://www.gravatar.com/avatar/fc29e4e7068a00fe9b9db37b8aadda1db6020adcacef810461e47b99c2b150e6?d=identicon)[samdark](/maintainers/samdark) ![](https://www.gravatar.com/avatar/ccb75e3312d6bd454ea445ea308139fd185a4ca906ca5df21cc66e6a35de25a3?d=identicon)[SilverFire](/maintainers/SilverFire) ![](https://www.gravatar.com/avatar/99106256c24a8cb23871b99fa90e48f37f1aa71608c185759b7d2a88683a5918?d=identicon)[hiqsol](/maintainers/hiqsol) --- Top Contributors [![samdark](https://avatars.githubusercontent.com/u/47294?v=4)](https://github.com/samdark "samdark (29 commits)")[![vjik](https://avatars.githubusercontent.com/u/525501?v=4)](https://github.com/vjik "vjik (10 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (9 commits)")[![devanych](https://avatars.githubusercontent.com/u/20116244?v=4)](https://github.com/devanych "devanych (8 commits)")[![xepozz](https://avatars.githubusercontent.com/u/6815714?v=4)](https://github.com/xepozz "xepozz (4 commits)")[![Arhell](https://avatars.githubusercontent.com/u/26163841?v=4)](https://github.com/Arhell "Arhell (3 commits)")[![Fantom409](https://avatars.githubusercontent.com/u/14968877?v=4)](https://github.com/Fantom409 "Fantom409 (3 commits)")[![luizcmarin](https://avatars.githubusercontent.com/u/67489841?v=4)](https://github.com/luizcmarin "luizcmarin (3 commits)")[![terabytesoftw](https://avatars.githubusercontent.com/u/42547589?v=4)](https://github.com/terabytesoftw "terabytesoftw (3 commits)")[![jiaweipan](https://avatars.githubusercontent.com/u/8296215?v=4)](https://github.com/jiaweipan "jiaweipan (2 commits)")[![kafkiansky](https://avatars.githubusercontent.com/u/37590388?v=4)](https://github.com/kafkiansky "kafkiansky (1 commits)")[![sankaest](https://avatars.githubusercontent.com/u/21160342?v=4)](https://github.com/sankaest "sankaest (1 commits)")[![StyleCIBot](https://avatars.githubusercontent.com/u/11048387?v=4)](https://github.com/StyleCIBot "StyleCIBot (1 commits)")[![githubjeka](https://avatars.githubusercontent.com/u/874234?v=4)](https://github.com/githubjeka "githubjeka (1 commits)")[![viktorprogger](https://avatars.githubusercontent.com/u/7670669?v=4)](https://github.com/viktorprogger "viktorprogger (1 commits)")[![roxblnfk](https://avatars.githubusercontent.com/u/4152481?v=4)](https://github.com/roxblnfk "roxblnfk (1 commits)")[![romkatsu](https://avatars.githubusercontent.com/u/1677515?v=4)](https://github.com/romkatsu "romkatsu (1 commits)") --- Tags gcrahacktoberfestmiddlewarepsr-15rate-limiteryii3middlewareframeworkpsr-15rate-limiteryiiGCRA ### Code Quality TestsPHPUnit Static AnalysisPsalm, Rector Type Coverage Yes ### Embed Badge ![Health badge](/badges/yiisoft-rate-limiter/health.svg) ``` [![Health](https://phpackages.com/badges/yiisoft-rate-limiter/health.svg)](https://phpackages.com/packages/yiisoft-rate-limiter) ``` ### Alternatives [cakephp/cakephp The CakePHP framework 8.8k18.5M1.6k](/packages/cakephp-cakephp)[yiisoft/yii-middleware Yii Middleware 21151.3k1](/packages/yiisoft-yii-middleware)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[neos/flow Flow Application Framework 862.0M451](/packages/neos-flow)[chubbyphp/chubbyphp-framework A minimal, highly performant middleware PSR-15 microframework built with as little complexity as possible, aimed primarily at those developers who want to understand all the vendors they use. 13544.4k4](/packages/chubbyphp-chubbyphp-framework)[yiisoft/csrf Yii CSRF Protection Library 27253.1k10](/packages/yiisoft-csrf) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)