# Get stream

URL: https://docs.hanzo.ai/docs/openapi/mq/get-mq-stream-by-name

> Returns one stream's configuration and live state.

`GET /v1/mq/stream/{name}`

> [MQ →](https://docs.hanzo.ai/docs/openapi/mq) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                            |
| ------------- | ------------------------------------------ |
| **Address**   | `https://api.hanzo.ai/v1/mq/stream/{name}` |
| **Method**    | `GET`                                      |
| **Operation** | `get_mq_stream_by_name`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`     |

Returns one stream's configuration and live state.

## Request

1 field.

| Field  | In   | Type   | Required | Description                             |
| ------ | ---- | ------ | -------- | --------------------------------------- |
| `name` | path | string | yes      | Name is the stream name, from the path. |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | mq.Stream       | ok      |
| `default` | problem-details | refused |

`200` body — 22 fields.

| Field                  | In   | Type               | Always | Description                                                                          |
| ---------------------- | ---- | ------------------ | ------ | ------------------------------------------------------------------------------------ |
| `config`               | body | mq.Config          | —      |                                                                                      |
| `config.max_age`       | body | string             | —      | MaxAge caps message age, e.g. "24h" or "7d"; "0" (default) is unlimited.             |
| `config.max_bytes`     | body | integer (int64)    | —      | MaxBytes caps the stream's total stored bytes; -1 (default) is unlimited.            |
| `config.max_msg_size`  | body | integer (int32)    | —      | MaxMsgSize caps one message's size in bytes; -1 (default) is the broker's limit.     |
| `config.max_msgs`      | body | integer (int64)    | —      | MaxMsgs caps the number of stored messages; -1 (default) is unlimited.               |
| `config.name`          | body | string             | —      | Name is the stream name, unique within the org (alphanumeric, hyphens, underscores). |
| `config.num_replicas`  | body | integer (int64)    | —      | Replicas is the number of stream replicas (1–5); this plane runs 1.                  |
| `config.retention`     | body | string             | —      | Retention is the retention policy: limits (default), interest, or workqueue.         |
| `config.storage`       | body | string             | —      | Storage is the storage backend: file (default) or memory.                            |
| `config.subjects`      | body | string\[]          | —      | Subjects are the org-relative subjects bound to this stream (wildcards supported).   |
| `created`              | body | string (date-time) | —      | Created is when the stream was created.                                              |
| `name`                 | body | string             | —      | Name is the stream name within the org.                                              |
| `state`                | body | mq.State           | —      |                                                                                      |
| `state.bytes`          | body | integer (uint64)   | —      | Bytes is the total stored size.                                                      |
| `state.consumer_count` | body | integer (int64)    | —      | Consumers is the number of consumers attached to this stream.                        |
| `state.first_seq`      | body | integer (uint64)   | —      | FirstSeq is the sequence of the first stored message.                                |
| `state.first_ts`       | body | string (date-time) | —      | FirstTS is the timestamp of the first stored message.                                |
| `state.last_seq`       | body | integer (uint64)   | —      | LastSeq is the sequence of the last stored message.                                  |
| `state.last_ts`        | body | string (date-time) | —      | LastTS is the timestamp of the last stored message.                                  |
| `state.messages`       | body | integer (uint64)   | —      | Messages is the number of messages currently stored.                                 |
| `state.num_deleted`    | body | integer (int64)    | —      | Deleted is the number of deleted messages (sequence gaps).                           |
| `state.num_subjects`   | body | integer (uint64)   | —      | Subjects is the number of distinct subjects stored.                                  |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo mq stream get <name>
```

**SDK**

**.ts**

```ts
import { Configuration, MqApi } from 'hanzoai';

const api = new MqApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMqStreamByName({ name: 'name' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MqApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MqApi(client).get_mq_stream_by_name(name='name')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MqAPI.GetMqStreamByName(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, mq_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = mq_api::get_mq_stream_by_name(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MqApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MqApi(client).getMqStreamByName();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/mq/stream/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `mq`, op `get_mq_stream_by_name` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "mq",
         "arguments": {
           "op": "get_mq_stream_by_name",
           "input": {
             "name": "<name>"
           }
         }
       }
     }'
```

---

[MQ API](https://docs.hanzo.ai/docs/openapi/mq) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)