ZRANGEBYSCORE - Upstash Documentation

Warning

Prefer ZRANGE with BYSCORE in new code: ZRANGE <key> <min> <max> BYSCORE [LIMIT <offset> <count>] [WITHSCORES].

Use ZRANGEBYSCORE to list the members of a sorted set whose score falls in a range, from the lowest score up.

Bounds are inclusive by default, become exclusive when prefixed with (, and accept -inf and +inf for open ends. WITHSCORES returns each member with its score, and LIMIT <offset> <count> pages through the result, which is how you take the first N above a threshold without transferring the rest.

With timestamps as scores this is the natural range query over time.

Syntax#

ZRANGEBYSCORE <key> <min> <max> [WITHSCORES] [LIMIT <offset> <count>]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<min>`	Yes	No	Minimum score: a number, `-inf`, or `(score` for an exclusive bound.
`<max>`	Yes	No	Maximum score: a number, `+inf`, or `(score` for an exclusive bound.
`WITHSCORES`	No	No	Include sorted-set scores.
`LIMIT <offset> <count>`	No	No	Skip `<offset>` matches and return at most `<count>`; a `<count>` of `-1` returns all remaining.

Important points#

RESP2 represents floating-point reply values as bulk strings; RESP3 may use native double replies. Client libraries commonly decode either form to a language number.

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 members, or flat member/score array with `WITHSCORES`
RESP3	Array of members, or array of member/score pairs with `WITHSCORES`

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

ZRANGEBYSCORE my-key 1.5 1.5

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.zrangebyscore("my-key", "1.5", "1.5")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.ZRangeByScore(context.Background(), "my-key", &redis.ZRangeBy{Min: "1.5", Max: "1.5"}).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.zrangeByScore("my-key", 1.5, 1.5);  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.zrangebyscore("my-key", 1.5, 1.5)?;    println!("{result:?}");    Ok(())}