Get stream ID

Get the unique ID of a given stream.


Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Get the ID of a given stream
stream_name = 'new stream'
result = client.get_stream_id(stream_name)

More examples and documentation can be found here.

const zulip = require('zulip-js');

// Download zuliprc-dev from your dev server
const config = {
    zuliprc: 'zuliprc-dev',

zulip(config).then((client) => {
    // Get the ID of a given stream

curl \


Note: The following arguments are all URL query parameters.

Argument Example Required Description
stream "Denmark" Yes

The name of the stream to retrieve the ID for.


Return values

  • stream_id: The ID of the given stream.

Example response

A typical successful JSON response may look like:

    "msg": "",
    "result": "success",
    "stream_id": 15

An example JSON response for when the supplied stream does not exist:

    "code": "BAD_REQUEST",
    "msg": "Invalid stream name 'nonexistent'",
    "result": "error"