> ## 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.

# JSON.GET

> Get JSON values.

Use `JSON.GET` to read one or more values from a JSON document.

Without a path the whole document is returned. The reply shape depends on the path syntax: a path starting with `$` is a JSONPath and always returns an array with one entry per match, so an empty array means nothing matched, while the legacy dot syntax returns the value itself and reports an error when the path does not exist. Passing several paths returns an object keyed by the path expressions, which is a cheap way to pull a few unrelated branches of a large document in one call.

`INDENT`, `NEWLINE`, and `SPACE` control the formatting of the returned JSON text, which is otherwise compact. They are meant for human-readable output; leave them out when a program parses the reply.

## Syntax

```redis theme={"system"}
JSON.GET <key>
  [INDENT indent]
  [NEWLINE newline]
  [SPACE space]
  [path [path ...]]
```

## Arguments

| Argument          | Required | Repeatable | Description                                   |
| ----------------- | -------- | ---------- | --------------------------------------------- |
| `key`             | Yes      | No         | JSON document key.                            |
| `INDENT indent`   | No       | No         | Indentation characters for formatted JSON.    |
| `NEWLINE newline` | No       | No         | Line-separator characters for formatted JSON. |
| `SPACE space`     | No       | No         | Characters placed after JSON separators.      |
| `path`            | No       | Yes        | One or more paths; defaults to the root.      |

## Important points

* Raw TCP examples pass JSON values as valid JSON text. Typed Upstash SDK helpers serialize native objects and values for you.
* Paths beginning with `$` use JSONPath and can match multiple values, so many JSON commands return an array of per-match results.

## 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 or Null bulk string or null array |
| RESP3    | Bulk string or Null                           |

<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"}
    JSON.GET profile $.name
    ```
  </Accordion>

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

    const redis = Redis.fromEnv();

    const value = await redis.json.get("key", "$.path.to.somewhere");
    ```
  </Accordion>

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

    redis = Redis.from_env()
    result = redis.json().get("profile", "$.name")
    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.call("JSON.GET", "profile", "$.name");
    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.json.get("profile", { path: "$.name" });
    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.json().get("profile", "$.name")
    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.JSONGet(context.Background(), "profile", "$.name").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.JedisPooled;

    try (JedisPooled jedis = new JedisPooled(new URI(System.getenv("REDIS_URL")))) {
      Object result = jedis.jsonGet("profile", new redis.clients.jedis.json.Path("$.name"));
      System.out.println(result);
    }
    ```
  </Accordion>

  <Accordion title="redis-rs" icon="rust" iconType="brands">
    ```rust theme={"system"}
    use redis::JsonCommands;

    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: redis::Value = connection.json_get("profile", &["$.name"])?;
        println!("{result:?}");
        Ok(())
    }
    ```
  </Accordion>
</AccordionGroup>


## Related topics

- [JSON.GET](/docs/redis/sdks/py/commands/json/get.md)
- [JSON.RESP](/docs/redis/commands/json/json-resp.md)
- [JSON.MGET](/docs/redis/commands/json/json-mget.md)
- [JSON commands](/docs/redis/commands/json/overview.md)