Stream List (Batch)

Returns information about specific streams by their IDs.

Request

Property	Value
Method	`POST`
URL	`/api/streams/batch`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/streams/batch" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Request Body

Parameter	Type	Required	Description
`data.streamKeyIds`	string[]	Yes	Array of stream IDs to retrieve

Request Body

json

{
  "data": {
    "streamKeyIds": ["edge-f1"]
  }
}

Response Body

Result Arrays

Parameter	Type	Description
`data.found`	array	Array of stream objects that were found
`data.notFound`	string[]	Array of stream IDs that were not found

Stream Object

Parameter	Type	Description
`data.found[].id`	string	Unique identifier of the stream
`data.found[].state`	string	Stream state (e.g., `"PUBLISHED"`)
`data.found[].type`	string	Stream type (e.g., `"NATIVE_STREAM"`)
`data.found[].application`	string	Application name
`data.found[].streamKey`	string	Stream key
`data.found[].startTime`	integer	Stream start time (Unix timestamp in ms)
`data.found[].duration`	integer	Stream duration in milliseconds
`data.found[].viewerCount`	integer	Current number of viewers
`data.found[].inBandwidth`	integer	Incoming bandwidth in bytes/sec
`data.found[].outBandwidth`	integer	Outgoing bandwidth in bytes/sec
`data.found[].inTotalBytes`	integer	Total incoming bytes
`data.found[].outTotalBytes`	integer	Total outgoing bytes
`data.found[].healthScore`	number	Stream health score (0-100)
`data.found[].healthGrade`	string	Stream health grade
`data.found[].allowedToPublish`	boolean	Indicates if publishing is allowed
`data.found[].isAutoRemovable`	boolean	Indicates if stream can be auto-removed
`data.found[].thumbnailPath`	string\|null	Path to stream thumbnail (null if unavailable)
`data.found[].thumbnailTimestamp`	integer	Thumbnail generation timestamp
`data.found[].subStreams`	array	Array of sub-stream variants
`data.found[].subStreams[].streamKey`	string	Sub-stream key
`data.found[].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": {
    "found": [
      {
        "id": "edge-f1",
        "state": "PUBLISHED",
        "type": "NATIVE_STREAM",
        "application": "edge",
        "streamKey": "f1",
        "startTime": 1764683374353,
        "duration": 71770675,
        "viewerCount": 0,
        "inBandwidth": 166464,
        "outBandwidth": 0,
        "inTotalBytes": 33071526148,
        "outTotalBytes": 754730859,
        "healthScore": 15.41353430459101,
        "healthGrade": "Bad",
        "allowedToPublish": true,
        "isAutoRemovable": true,
        "thumbnailPath": null,
        "thumbnailTimestamp": 0,
        "subStreams": [
          {
            "streamKey": "f1",
            "name": "native"
          }
        ]
      }
    ],
    "notFound": [
      "nonexistentstream"
    ]
  },
  "meta": {
    "executionTime": 0,
    "generatedAt": 1764755145028
  }
}

Error Response (4xx/5xx)

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

json

{
  "message": "Error message"
}

Support Needed?

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