Source

Returns information about the source connection for a specific substream.

Request

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

Request

bash

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

Path Parameters

Parameter	Type	Required	Description
`appName`	string	Yes	Application name
`streamKey`	string	Yes	Stream key
`substreamName`	string	Yes	Substream name (e.g., `"native"`, `"720p"`)

Request With Parameters

bash

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

Response Body

Source Info

Parameter	Type	Description
`data.id`	string	Unique identifier of the source connection
`data.state`	string	Source state
`data.application`	string	Application name
`data.streamKey`	string	Stream key
`data.sourceType`	string	Source type
`data.startTime`	integer	Source connection start time (Unix timestamp in ms)
`data.duration`	integer	Connection duration in milliseconds
`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.videoPacketCount`	integer	Total video packets received
`data.audioPacketCount`	integer	Total audio packets received
`data.dataPacketCount`	integer	Total data packets received

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": "v_0z1pvyxhmiomx229",
    "state": "PUBLISHED",
    "application": "edge",
    "streamKey": "f1",
    "sourceType": "WS_CLIENT",
    "startTime": 1764683374353,
    "duration": 74184447,
    "inBandwidth": 569986,
    "outBandwidth": 569986,
    "inTotalBytes": 34011182696,
    "outTotalBytes": 34011182696,
    "videoPacketCount": 2225553,
    "audioPacketCount": 3477408,
    "dataPacketCount": 0
  },
  "meta": {
    "executionTime": 3,
    "generatedAt": 1764757558705
  }
}

Error Response (4xx/5xx)

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

Substream Not Found (404)

json

{
  "message": "Substream not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

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