Skip to main content

Documentation Index

Fetch the complete documentation index at: https://upstash.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

@upstash/redis is an HTTP/REST based Redis client built on top of Upstash REST API. For more information, refer to the documentation of Upstash redis client (TypeScript & Python). It is the only connectionless (HTTP based) Redis client and designed for:
  • Serverless functions (AWS Lambda)
  • Cloudflare Workers (see the example)
  • Fastly Compute@Edge (see the example)
  • Next.js (see the quickstart), Jamstack
  • Client side web/mobile applications
  • WebAssembly
  • and other environments where HTTP is preferred over TCP.
See the list of APIs supported.

​
Quick Start

​
Install

npm install @upstash/redis

​
Usage

import { Redis } from "@upstash/redis";

const redis = new Redis({
  url: "UPSTASH_REDIS_REST_URL",
  token: "UPSTASH_REDIS_REST_TOKEN",
});

const data = await redis.get("key");
console.log(data);
You can find values to set as UPSTASH_REDIS_REST_URL andUPSTASH_REDIS_REST_TOKEN on the details tab of your database on Upstash Console. See Connect Client page for more information.
If you define UPSTASH_REDIS_REST_URL andUPSTASH_REDIS_REST_TOKEN environment variables, you can load them automatically. 
import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();

const data = await redis.get("key");
console.log(data);