LRANGE - Upstash Documentation

Use LRANGE to read a range of elements from a list.

Both <start> and <stop> are zero-based, inclusive, and may be negative to count from the tail, so LRANGE key 0 -1 returns the whole list and LRANGE key 0 9 returns the first ten elements. Out-of-range indexes are clamped instead of producing an error, and a range that selects nothing, or a missing key, returns an empty list.

The command copies the requested range into the reply, so reading a large list in one call is expensive: page through it with successive ranges when the list is big.

Syntax#

LRANGE <key> <start> <stop>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<start>`	Yes	No	Start index; negative values count from the end.
`<stop>`	Yes	No	Stop index, inclusive; negative values count from the end.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Array of bulk-string values
RESP3	Array of bulk-string values

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

LRANGE my-key 0 0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.lpush("key", "a", "b", "c");const elements = await redis.lrange("key", 1, 2);console.log(elements) // ["b", "c"]

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.lrange("my-key", 0, 0)print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.lrange("my-key", "0", "0");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.lRange("my-key", 0, 0);console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.lrange("my-key", 0, 0)print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.LRange(context.Background(), "my-key", 0, 0).Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.lrange("my-key", 0, 0);  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.lrange("my-key", 0, 0)?;    println!("{result:?}");    Ok(())}