Stream

Returns detailed information about a specific stream.

Request

Property	Value
Method	`GET`
URL	`/api/streams/{appName}/{streamKey}`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X GET "{BASE_URL}/api/streams/{appName}/{streamKey}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name
`streamKey`	string	Yes	Stream key

Request

bash

curl -X GET "{BASE_URL}/api/streams/{appName}/{streamKey}" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Stream Info

Parameter	Type	Description
`data.id`	string	Unique identifier of the stream
`data.state`	string	Stream state
`data.type`	string	Stream type
`data.application`	string	Application name
`data.streamKey`	string	Stream key
`data.startTime`	integer	Stream start time (Unix timestamp in ms)
`data.duration`	integer	Stream duration in milliseconds
`data.viewerCount`	integer	Current number of viewers
`data.systemClientCount`	integer	Number of system clients
`data.inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.inTotalBytes`	integer	Total incoming bytes
`data.outTotalBytes`	integer	Total outgoing bytes
`data.healthScore`	number	Stream health score (0-100)
`data.healthGrade`	string	Stream health grade
`data.allowedToPublish`	boolean	Indicates if publishing is allowed
`data.isAutoRemovable`	boolean	Indicates if stream can be auto-removed
`data.canRecord`	boolean	Indicates if stream can be recorded
`data.isRecording`	boolean	Indicates if stream is currently recording
`data.thumbnailPath`	string\|null	Path to stream thumbnail (null if unavailable)
`data.thumbnailTimestamp`	integer	Thumbnail generation timestamp

Sub-Streams

Parameter	Type	Description
`data.subStreams`	array	Array of sub-stream variants
`data.subStreams[].streamKey`	string	Sub-stream key
`data.subStreams[].name`	string	Sub-stream name

Metadata

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)

Successful Response (200)

json

{
  "data": {
    "id": "f1",
    "state": "PUBLISHED",
    "type": "NATIVE_STREAM",
    "application": "edge",
    "streamKey": "f1",
    "startTime": 1764683374353,
    "duration": 73054270,
    "viewerCount": 0,
    "systemClientCount": 0,
    "inBandwidth": 463973,
    "outBandwidth": 0,
    "inTotalBytes": 33490425639,
    "outTotalBytes": 754730859,
    "healthScore": 15.379520309919055,
    "healthGrade": "Bad",
    "allowedToPublish": true,
    "isAutoRemovable": true,
    "canRecord": false,
    "isRecording": false,
    "thumbnailPath": null,
    "thumbnailTimestamp": 0,
    "subStreams": [
      {
        "streamKey": "f1",
        "name": "native"
      }
    ]
  },
  "meta": {
    "executionTime": 1,
    "generatedAt": 1764756428623
  }
}

Error Responses

Stream Not Found (404)

Parameter	Type	Description
`message`	string	Human-readable error message

json

{
  "message": "Stream not found"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.