# ZRANGEBYLEX

> Get members by lex range.

<Warning>
  Prefer [`ZRANGE`](/redis/commands/sorted-set/zrange) with `BYLEX` in new code: `ZRANGE <key> <min> <max> BYLEX [LIMIT <offset> <count>]`. 
</Warning>

Use `ZRANGEBYLEX` to list the members of a sorted set that fall in a lexicographic range.

Bounds are written `[member` for inclusive and `(member` for exclusive, with `-` and `+` standing for the lowest and highest possible members. `LIMIT <offset> <count>` pages through the result.

The ordering used here is the byte order of member names, which is only meaningful when every member has the same score. Giving all members score `0` turns a sorted set into a sorted string index, which is how prefix lookups and autocomplete are built on top of it.

## Syntax

```redis
ZRANGEBYLEX <key> <min> <max> [LIMIT <offset> <count>]
```

## Arguments

| Argument | Required | Repeatable | Description |
| --- | --- | --- | --- |
| `<key>` | Yes | No | Redis key targeted by the command. |
| `<min>` | Yes | No | Lexicographic minimum: `-`, `+`, `[member` (inclusive), or `(member` (exclusive). |
| `<max>` | Yes | No | Lexicographic maximum: `-`, `+`, `[member` (inclusive), or `(member` (exclusive). |
| `LIMIT <offset> <count>` | No | No | Skip `<offset>` matches and return at most `<count>`; a `<count>` of `-1` returns all remaining. |

## 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 members |
| RESP3 | Array of bulk-string members |

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

## Examples

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

<AccordionGroup>

<Accordion title="Redis CLI" icon="terminal">

```bash
ZRANGEBYLEX my-key - +
```

</Accordion>

<Accordion title="@upstash/redis" icon="node-js" iconType="brands">

<Note>
  This command is not supported yet in `@upstash/redis`.
</Note>

</Accordion>

<Accordion title="upstash_redis" icon="python" iconType="brands">

```python
from upstash_redis import Redis

redis = Redis.from_env()
result = redis.zrangebylex("my-key", "-", "+")
print(result)
```

</Accordion>

<Accordion title="ioredis" icon="node-js" iconType="brands">

```ts
import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.zrangebylex("my-key", "-", "+");
console.log(result);
```

</Accordion>

<Accordion title="node-redis" icon="node-js" iconType="brands">

```ts
import { createClient } from "redis";

const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.zRangeByLex("my-key", "-", "+");
console.log(result);
```

</Accordion>

<Accordion title="redis-py" icon="python" iconType="brands">

```python
import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.zrangebylex("my-key", "-", "+")
print(result)
```

</Accordion>

<Accordion title="go-redis" icon="golang" iconType="brands">

```go
package main

import (
    "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.ZRangeByLex(context.Background(), "my-key", &redis.ZRangeBy{Min: "-", Max: "+"}).Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}
```

</Accordion>

<Accordion title="jedis" icon="java" iconType="brands">

```java
import java.net.URI;

import redis.clients.jedis.Jedis;

try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.zrangeByLex("my-key", "-", "+");
  System.out.println(result);
}
```

</Accordion>

<Accordion title="redis-rs" icon="rust" iconType="brands">

```rust
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.zrangebylex("my-key", "-", "+")?;
    println!("{result:?}");
    Ok(())
}
```

</Accordion>

</AccordionGroup>
