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

# XINFO STREAM

> Get stream info.

Use `XINFO STREAM` to get information about a stream.

The default reply summarizes the stream: how many entries it holds, the last generated ID, the number of consumer groups, and the first and last entries. `FULL` returns the detailed form instead, walking the entries along with every group, consumer, and pending entry, with `COUNT` limiting how many items each part of that reply contains (`COUNT 0` means no limit).

Use the summary for monitoring and the full form when debugging a group that appears stuck, since it shows exactly which entries are pending and who owns them.

## Syntax

```redis theme={"system"}
XINFO STREAM <key> [FULL [COUNT <count>]]
```

## Arguments

| Argument               | Required | Repeatable | Description                                                                                                                                    |
| ---------------------- | -------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `<key>`                | Yes      | No         | Redis key targeted by the command.                                                                                                             |
| `FULL [COUNT <count>]` | No       | No         | Return the full report, including entries and consumer-group state. `COUNT` caps how many entries each section lists; `0` returns all of them. |

## 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    | Flat array of alternating keys and values |
| RESP3    | Map                                       |

<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"}
    XINFO STREAM 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">
    <Note>
      This command is not supported yet in `upstash_redis`.
    </Note>
  </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.xinfo("STREAM", "my-key");
    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.xInfoStream("my-key");
    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.xinfo_stream("my-key")
    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.XInfoStream(context.Background(), "my-key").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.xinfoStream("my-key");
      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.xinfo_stream("my-key")?;
        println!("{result:?}");
        Ok(())
    }
    ```
  </Accordion>
</AccordionGroup>


## Related topics

- [XINFO](/docs/redis/sdks/ts/commands/stream/xinfo.md)
- [XINFO GROUPS](/docs/redis/commands/streams/xinfo-groups.md)
- [XINFO CONSUMERS](/docs/redis/commands/streams/xinfo-consumers.md)