{"id":48680715,"url":"https://github.com/lpicanco/krate","last_synced_at":"2026-04-26T20:00:41.894Z","repository":{"id":58264288,"uuid":"524964024","full_name":"lpicanco/krate","owner":"lpicanco","description":"Rate Limit Library for Kotlin","archived":false,"fork":false,"pushed_at":"2025-07-10T19:37:52.000Z","size":2164,"stargazers_count":32,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-11T05:08:13.981Z","etag":null,"topics":["hacktoberfest","kotlin","library","rate-limiter"],"latest_commit_sha":null,"homepage":"https://lpicanco.github.io/krate/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lpicanco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-08-15T11:40:10.000Z","updated_at":"2025-07-10T19:36:05.000Z","dependencies_parsed_at":"2023-12-15T09:29:02.935Z","dependency_job_id":"52c6a383-f120-4327-9659-721eab91afa9","html_url":"https://github.com/lpicanco/krate","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/lpicanco/krate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpicanco%2Fkrate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpicanco%2Fkrate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpicanco%2Fkrate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpicanco%2Fkrate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lpicanco","download_url":"https://codeload.github.com/lpicanco/krate/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lpicanco%2Fkrate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32310804,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T19:15:34.056Z","status":"ssl_error","status_checked_at":"2026-04-26T19:15:15.467Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","kotlin","library","rate-limiter"],"created_at":"2026-04-11T01:00:36.056Z","updated_at":"2026-04-26T20:00:41.888Z","avatar_url":"https://github.com/lpicanco.png","language":"Kotlin","funding_links":[],"categories":["容错组件"],"sub_categories":["Spring Cloud框架"],"readme":"# Krate\nKrate is a rate limiter library for Kotlin.\n\n[![Kotlin](https://img.shields.io/badge/kotlin-1.9.21-blue.svg?logo=kotlin)](http://kotlinlang.org)\n![GitHub](https://img.shields.io/github/license/lpicanco/krate)\n![Build Status](https://img.shields.io/github/actions/workflow/status/lpicanco/krate/build.yml?branch=master)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=lpicanco_krate\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=lpicanco_krate)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=lpicanco_krate\u0026metric=coverage)](https://sonarcloud.io/summary/new_code?id=lpicanco_krate)\n[![Maven Central](https://img.shields.io/maven-central/v/io.github.lpicanco/krate-core)](https://search.maven.org/artifact/io.github.lpicanco/krate-core)\n\n\n## Features\n1. Token Bucket Algorithm: Krate uses the token bucket algorithm, a widely-used technique for rate limiting, to ensure efficient and fair resource allocation.\n2. Burst Support: Krate allows for bursty request patterns, letting clients make a certain number of requests in a short time before being rate-limited.\n3. Redis Support: Krate offers support for Redis as a backend for storing rate limit information, enabling distributed rate limiting across multiple instances of your application.\n4. Keys eviction support: Krate automatically evicts unused keys, optimizing memory usage and ensuring optimal performance.\n\n## Installation\n### Gradle\n```groovy\nimplementation 'io.github.lpicanco:krate-core:${krateVersion}'\n```\n\n### Gradle Kotlin DSL\n```kotlin\nimplementation(\"io.github.lpicanco:krate-core:${krateVersion}\")\n```\n\n### Maven\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eio.github.lpicanco\u003c/groupId\u003e\n  \u003cartifactId\u003ekrate-core\u003c/artifactId\u003e\n  \u003cversion\u003e${krateVersion}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## How to use\n\n### Rate of 5 per second\n```kotlin\nimport com.neutrine.krate.rateLimiter\n\n// Create a rate limiter with a rate of 5 per second.\nval rateLimiter = rateLimiter(maxRate = 5)\n\n// Use the rate limiter.\nval taken: Boolean = rateLimiter.tryTake()\n```\n\n### Rate of 10 per minute with a max burst of 10.\n```kotlin\n// Create a rate limiter with a rate of 5 per minute and a max burst of 10.\nval rateLimiter = rateLimiter(maxRate = 5) {\n    maxBurst = 10\n    maxRateTimeUnit = ChronoUnit.MINUTES\n}\n\n// Use the rate limiter.\nval taken: Boolean = rateLimiter.tryTake()\n```\n\n### Rate of 5 per second, blocking\n```kotlin\n// Create a rate limiter with a rate of 5 per second.\nval rateLimiter = rateLimiter(maxRate = 5)\n\n// Wait until a token is available.\nrateLimiter.awaitUntilTake()\n```\n\n### Rate of 5 per second, expiring keys unused in the last 2 hours\n```kotlin\nimport com.neutrine.krate.rateLimiter\n\n// Create a rate limiter with a rate of 5 per second. Unused keys will be evicted after 2 hours.\nval rateLimiter = rateLimiter(maxRate = 5) {\n    stateStorage = memoryStateStorageWithEviction {\n        ttlAfterLastAccess = 2.hours\n    }    \n}\n\n// Use the rate limiter.\nval taken: Boolean = rateLimiter.tryTake(\"myKey\")\n```\n\n### Rate of 10 per second, using caffeine to evict keys unused in the last 2 hours\n```kotlin\nimport com.neutrine.krate.rateLimiter\n\n// Create a rate limiter with a rate of 5 per second. Unused keys will be evicted after 2 hours.\nval rateLimiter = rateLimiter(maxRate = 10) {\n    stateStorage = memoryCaffeineStateStorage {\n        expireAfterAccess = 2.hours\n    }\n}\n\n// Use the rate limiter.\nval taken: Boolean = rateLimiter.tryTake(\"myKey\")\n```\n\n### Rate of 5 per second using Redis as state storage\n```kotlin\n// Create a rate limiter with a rate of 5 per second and redis.\nval rateLimiter = rateLimiter(maxRate = 5) {\n    stateStorage = redisStateStorage {\n        host = \"my-custom-uri.endpoint\"\n    }\n}\n\n// Use the rate limiter.\nval taken: Boolean = rateLimiter.tryTake()\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flpicanco%2Fkrate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flpicanco%2Fkrate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flpicanco%2Fkrate/lists"}