Stream List

Returns a paginated list of streams, optionally filtered by application.

Request

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

Request

bash

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

Path Parameters

Parameter	Type	Required	Description
`applicationName`	string	No	Application name to filter streams (omit for all apps)

Request

bash

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

Query Parameters

Parameter	Type	Required	Default	Description
`page`	integer	No	1	Page number
`rowsPerPage`	integer	No	10	Number of items per page
`orderBy`	string	No	-	Field name to sort by (e.g., `"startTime"`)
`order`	string	asc \| desc	-	Sort order
`search`	string	No	-	Filter by stream key
`streamState`	string	No	-	Filter by stream state

With query parameters

bash

curl -X GET "{BASE_URL}/api/streams/{applicationName}?page=value&rowsPerPage=value&orderBy=value" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response Body

Pagination

Parameter	Type	Description
`data.totalItems`	integer	Total number of streams
`data.itemsPerPage`	integer	Number of items per page
`data.totalPages`	integer	Total number of pages
`data.currentPage`	integer	Current page number
`data.hasPrevious`	boolean	Indicates if a previous page exists
`data.hasNext`	boolean	Indicates if a next page exists

Stream Object

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

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.