@upstash/ratelimit

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

npm install @upstash/ratelimit

Deno

import { 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

import { Ratelimit } from "@upstash/ratelimit"; // for deno: see above
import { Redis } from "@upstash/redis"; // see below for cloudflare and fastly adapters

// Create a new ratelimiter, that allows 10 requests per 10 seconds
const ratelimit = new Ratelimit({
  redis: Redis.fromEnv(),
  limiter: Ratelimit.slidingWindow(10, "10 s"),
  analytics: true,
  /**
   * Optional prefix for the keys used in redis. This is useful if you want to share a redis
   * instance with other applications and want to avoid key collisions. The default prefix is
   * "@upstash/ratelimit"
   */
  prefix: "@upstash/ratelimit",
});

// Use a constant string to limit all requests with a single ratelimit
// Or use a userID, apiKey or ip address for individual limits.
const identifier = "api";
const { success } = await ratelimit.limit(identifier);

if (!success) {
  return "Unable to process at this time";
}
doExpensiveCalculation();
return "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.

Telemetry

The SDK reports its name and version to Upstash as a header on the requests made by the redis client you provide, so we know which SDK versions are in use. No personal data, keys or identifiers are collected.

You can opt out with enableTelemetry: false:

const ratelimit = new Ratelimit({
  redis: Redis.fromEnv(),
  limiter: Ratelimit.slidingWindow(10, "10 s"),
  enableTelemetry: false,
});

or by setting the UPSTASH_DISABLE_TELEMETRY environment variable. Disabling telemetry on the redis client itself also disables it here.

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:

pnpm test

Similar packages

Other packages similar to @upstash/ratelimit

express-rate-limit

express-rate-limit is a popular middleware for Express.js applications that provides rate limiting capabilities. It is easy to integrate with Express and offers a variety of configuration options. Compared to @upstash/ratelimit, express-rate-limit is more tightly coupled with Express.js and may not be as flexible for use in non-Express environments.

rate-limiter-flexible

rate-limiter-flexible is a highly flexible rate limiting library that supports various backends like Redis, MongoDB, and more. It offers advanced features such as cluster support and different rate limiting strategies. Compared to @upstash/ratelimit, rate-limiter-flexible provides more backend options and advanced features, but may require more setup and configuration.