ZRANK - Upstash Documentation

Use ZRANK to get the position of a member in a sorted set, counting from the lowest score.

The rank is zero-based, so the lowest scoring member has rank 0, and members with equal scores are ordered lexicographically. WITHSCORE returns the score alongside the rank. The reply is null when the member or the key does not exist.

This is how a leaderboard reports "you are number N": increment scores with ZINCRBY and read the position back here, using ZREVRANK when rank 0 should be the highest score instead.

Syntax#

ZRANK <key> <member> [WITHSCORE]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<member>`	Yes	No	Member name.
`WITHSCORE`	No	No	Also return the member's score alongside its rank.

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	Null bulk string or null array, Integer, or two-element rank/score array
RESP3	Null, Integer, or two-element rank/score 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

ZRANK my-key member

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const rank = await redis.zrank("key", "member");

upstash_redis

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

ioredis

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

redis-py

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