Skip to main content
GET
/
rtstream
/
List RTStreams
curl --request GET \
  --url https://api.videodb.io/rtstream/ \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "data": {
    "results": [
      {
        "id": "rts-12345",
        "name": "My Stream",
        "status": "connected",
        "sample_rate": 30,
        "media_types": [
          "video",
          "audio"
        ],
        "collection_id": "default",
        "store": false,
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 25,
    "next": "/rtstream/?limit=10&offset=10",
    "previous": null
  }
}
List all real-time streams with optional filtering by status, name, and sorting.
  • Filter by status: connected or stopped
  • Filter by name (substring match)
  • Use ordering for sorting (prefix with - for descending, e.g., -created_at)
  • Results are paginated with limit and offset

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Query Parameters

​
limit
integer
default:10
Example:

10

​
offset
integer
default:0
Example:

0

​
status
enum<string>
Available options:
connected,
stopped
Example:

"connected"

​
name
string

Filter by name substring

Example:

"my stream"

​
ordering
string

Sort field (prefix with - for descending)

Example:

"-created_at"

Response

200 - application/json

List of RTStreams

​
success
boolean
Example:

true

​
data
object