Upstash Rate Limit

[!NOTE] This project is in GA Stage. The Upstash Professional Support fully covers this project. It receives regular updates, and bug fixes. The Upstash team is committed to maintaining and improving its functionality.

It is the only connectionless (HTTP based) rate limiting library and designed for:

• Serverless functions (AWS Lambda, Vercel ....)
• Cloudflare Workers & Pages
• Vercel Edge
• Fastly Compute@Edge
• Next.js, Jamstack ...
• Client side web/mobile applications
• WebAssembly
• and other environments where HTTP is preferred over TCP.

Quick Start

Install

npm

1npm install @upstash/ratelimit

Deno

1import { Ratelimit } from "https://cdn.skypack.dev/@upstash/ratelimit@latest";

Create database

Create a new redis database on upstash. See here for documentation on how to create a redis instance.

Basic Usage

1import { Ratelimit } from "@upstash/ratelimit"; // for deno: see above
2import { Redis } from "@upstash/redis"; // see below for cloudflare and fastly adapters
3
4// Create a new ratelimiter, that allows 10 requests per 10 seconds
5const ratelimit = new Ratelimit({
6  redis: Redis.fromEnv(),
7  limiter: Ratelimit.slidingWindow(10, "10 s"),
8  analytics: true,
9  /**
10   * Optional prefix for the keys used in redis. This is useful if you want to share a redis
11   * instance with other applications and want to avoid key collisions. The default prefix is
12   * "@upstash/ratelimit"
13   */
14  prefix: "@upstash/ratelimit",
15});
16
17// Use a constant string to limit all requests with a single ratelimit
18// Or use a userID, apiKey or ip address for individual limits.
19const identifier = "api";
20const { success } = await ratelimit.limit(identifier);
21
22if (!success) {
23  return "Unable to process at this time";
24}
25doExpensiveCalculation();
26return "Here you go!";

For more information on getting started, you can refer to our documentation.

Here's a complete nextjs example

Documentation

See the documentation for more information details about this package.

Contributing

Database

Create a new redis database on upstash and copy the url and token.

Running tests

To run the tests, you will need to set some environment variables. Here is a list of variables to set:

• UPSTASH_REDIS_REST_URL
• UPSTASH_REDIS_REST_TOKEN
• US1_UPSTASH_REDIS_REST_URL
• US1_UPSTASH_REDIS_REST_TOKEN
• APN_UPSTASH_REDIS_REST_URL
• APN_UPSTASH_REDIS_REST_TOKEN
• EU2_UPSTASH_REDIS_REST_URL
• EU2_UPSTASH_REDIS_REST_TOKEN

You can create a single Upstash Redis and use its URL and token for all four above.

Once you set the environment variables, simply run:

1pnpm test