> ## Documentation index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Ask it with GET https://upstash.com/docs/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.
> Feature requests: https://upstash.com/docs/common/help/feature-requests.md lists what users asked for and how to vote for a request or add one.
> Page rating: `GET https://upstash.com/docs/feedback?path=/docs/redis/sdks/ts/commands/stream/xinfo&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.

# XINFO

> Returns information about streams, consumer groups, and consumers.

## Arguments

<ParamField body="key" type="string" required>
  The key of the stream.
</ParamField>

<ParamField body="options" type="object" required>
  The XINFO subcommand options. Can be one of:
  <Expandable title="GROUPS">
    <ParamField body="type" type="'GROUPS'" required>
      List all consumer groups for the stream.
    </ParamField>
  </Expandable>

  <Expandable title="CONSUMERS">
    <ParamField body="type" type="'CONSUMERS'" required>
      List all consumers in a consumer group.
    </ParamField>
    <ParamField body="group" type="string" required>
      The consumer group name.
    </ParamField>
  </Expandable>
</ParamField>

## Response

<ResponseField>
  The return type depends on the subcommand:
  - GROUPS: Returns an array of consumer group information
  - CONSUMERS: Returns an array of consumer information
</ResponseField>

<RequestExample>
```ts List groups
const result = await redis.xinfo("mystream", {
  type: "GROUPS"
});
```

```ts List consumers
const result = await redis.xinfo("mystream", {
  type: "CONSUMERS",
  group: "mygroup"
});
```
</RequestExample>

<ResponseExample>
```ts
// GROUPS response
[
  {
    name: "mygroup",
    consumers: 2,
    pending: 1,
    "last-delivered-id": "1638360173533-2",
    "entries-read": 3,
    lag: 2
  }
]

// CONSUMERS response
[
  {
    name: "consumer1",
    pending: 1,
    idle: 15000,
    "inactive": 15000
  }
]
```
</ResponseExample>