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

> List group consumers.

Use `XINFO CONSUMERS` to list the consumers of a consumer group.

For each consumer the reply gives its name, how many entries it currently has pending, and how long it has been idle or inactive. This is the view that tells you whether workers are alive and balanced: a consumer with a growing pending count and a large idle time is one that stopped without acknowledging its work, and its entries are the ones to recover with [`XAUTOCLAIM`](/docs/redis/commands/streams/xautoclaim).

## Syntax

```redis theme={"system"}
XINFO CONSUMERS <key> <group>
```

## Arguments

| Argument  | Required | Repeatable | Description                        |
| --------- | -------- | ---------- | ---------------------------------- |
| `<key>`   | Yes      | No         | Redis key targeted by the command. |
| `<group>` | Yes      | No         | Consumer group name.               |

## 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 flat consumer-metadata arrays |
| RESP3    | Array of flat consumer-metadata arrays |

<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 CONSUMERS my-key workers
    ```
  </Accordion>

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

    const redis = Redis.fromEnv();
    const result = await redis.xinfo("my-key", {
      type: "CONSUMERS",
      group: "workers",
    });
    console.log(result);
    ```
  </Accordion>

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

    redis = Redis.from_env()
    result = redis.xinfo_consumers("my-key", "workers")
    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.xinfo("CONSUMERS", "my-key", "workers");
    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.xInfoConsumers("my-key", "workers");
    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_consumers("my-key", "workers")
    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.XInfoConsumers(context.Background(), "my-key", "workers").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.xinfoConsumers("my-key", "workers");
      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_consumers("my-key", "workers")?;
        println!("{result:?}");
        Ok(())
    }
    ```
  </Accordion>
</AccordionGroup>


## Related topics

- [XINFO CONSUMERS](/docs/redis/sdks/py/commands/stream/xinfo_consumers.md)
- [Overview](/docs/redis/sdks/py/commands/overview.md)
- [XINFO](/docs/redis/sdks/ts/commands/stream/xinfo.md)
- [XINFO GROUPS](/docs/redis/commands/streams/xinfo-groups.md)
- [XINFO STREAM](/docs/redis/commands/streams/xinfo-stream.md)