XRANGE - Upstash Documentation

Use XRANGE to read the entries of a stream within a range of IDs, from the oldest to the newest.

- and + stand for the smallest and largest possible IDs, so XRANGE key - + reads the whole stream. An incomplete ID such as 1526985054069 is completed with the smallest possible sequence number for <start> and the largest for <end>, which makes it easy to select everything within one millisecond. Prefixing a bound with ( makes it exclusive, and COUNT limits how many entries come back.

Since IDs start with a timestamp, ranges are time queries: pass the milliseconds you care about and you get the entries recorded in that window. Paging works by repeating the call with the last ID you received, made exclusive with (. Use XREVRANGE to walk the stream backwards.

Syntax#

XRANGE <key> <start> <end> [COUNT <count>]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<start>`	Yes	No	First ID to return; `-` means the smallest possible ID.
`<end>`	Yes	No	Last ID to return; `+` means the largest possible ID.
`COUNT <count>`	No	No	Maximum number of entries to return.

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 two-element entry arrays: ID and flat field/value array
RESP3	Array of two-element entry arrays: ID and flat field/value array

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

XRANGE my-key - +

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const result = await redis.xrange("mystream", "-", "+");

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.xrange("my-key", "-", "+");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.xRange("my-key", "-", "+");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.xrange("my-key", "-", "+")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.XRange(context.Background(), "my-key", "-", "+").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.xrange("my-key", "-", "+");  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.xrange("my-key", "-", "+")?;    println!("{result:?}");    Ok(())}