> ## Documentation Index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GETRANGE

> Get substring of string.

Use `GETRANGE` to read part of the string stored at a key.

`<start>` and `<end>` are zero-based byte offsets, both inclusive, and may be negative to count from the end, so `GETRANGE key 0 -1` returns the whole value. Offsets outside the string are clamped rather than treated as errors, and a missing key returns an empty string.

Since the range is applied on the server, this is how you read the head of a large value, or a fixed-width field inside one, without transferring the rest. `SUBSTR` is accepted as a deprecated alias with the same arguments and reply.

## Syntax

```redis theme={"system"}
GETRANGE <key> <start> <end>
```

## Arguments

| Argument  | Required | Repeatable | Description                                                     |
| --------- | -------- | ---------- | --------------------------------------------------------------- |
| `<key>`   | Yes      | No         | Redis key targeted by the command.                              |
| `<start>` | Yes      | No         | Start byte offset; negative values count from the end.          |
| `<end>`   | Yes      | No         | End byte offset, inclusive; negative values count from the end. |

## Important points

* `SUBSTR` is accepted as a deprecated alias with the same arguments and reply. New code should use `GETRANGE`.

## 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    | Bulk string |
| RESP3    | Bulk string |

<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 theme={"system"}
    GETRANGE my-key 0 1
    ```
  </Accordion>

  <Accordion title="@upstash/redis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import { Redis } from "@upstash/redis";

    const redis = Redis.fromEnv();

    const substring = await redis.getrange("key", 2, 4);
    ```
  </Accordion>

  <Accordion title="upstash_redis" icon="python" iconType="brands">
    ```python theme={"system"}
    from upstash_redis import Redis

    redis = Redis.from_env()
    result = redis.getrange("my-key", "0", "1")
    print(result)
    ```
  </Accordion>

  <Accordion title="ioredis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import Redis from "ioredis";

    const redis = new Redis(process.env.REDIS_URL!);
    const result = await redis.getrange("my-key", "0", "1");
    console.log(result);
    ```
  </Accordion>

  <Accordion title="node-redis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import { createClient } from "redis";

    const client = await createClient({ url: process.env.REDIS_URL })
      .on("error", console.error)
      .connect();
    const result = await client.getRange("my-key", 0, 1);
    console.log(result);
    ```
  </Accordion>

  <Accordion title="redis-py" icon="python" iconType="brands">
    ```python theme={"system"}
    import os
    import redis

    client = redis.from_url(os.environ["REDIS_URL"])
    result = client.getrange("my-key", "0", "1")
    print(result)
    ```
  </Accordion>

  <Accordion title="go-redis" icon="golang" iconType="brands">
    ```go theme={"system"}
    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.GetRange(context.Background(), "my-key", 0, 1).Result()
        if err != nil {
            panic(err)
        }
        fmt.Println(result)
    }
    ```
  </Accordion>

  <Accordion title="jedis" icon="java" iconType="brands">
    ```java theme={"system"}
    import java.net.URI;

    import redis.clients.jedis.Jedis;

    try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
      Object result = jedis.getrange("my-key", 0, 1);
      System.out.println(result);
    }
    ```
  </Accordion>

  <Accordion title="redis-rs" icon="rust" iconType="brands">
    ```rust theme={"system"}
    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.getrange("my-key", 0, 1)?;
        println!("{result:?}");
        Ok(())
    }
    ```
  </Accordion>
</AccordionGroup>


## Related topics

- [GETRANGE](/docs/redis/sdks/ts/commands/string/getrange.md)
- [STRLEN](/docs/redis/commands/string/strlen.md)
- [SETRANGE](/docs/redis/commands/string/setrange.md)
- [APPEND](/docs/redis/commands/string/append.md)