Get Stream

Request to fetch stream details.

This request is cached for 60 seconds.

Request

Property	Value
Method	`GET`
URL	`https://api.stormstreaming.com/api/request/stream/{stream_key}`
Authentication	`x-api-key`

URL Parameters:

Parameter	Description
`{stream_key}`	The stream key of the stream you wish to read

Request

bash

curl -X GET "https://api.stormstreaming.com/api/request/stream/{stream_key}" \
  -H "x-api-key: YOUR_API_KEY"

Response

Parameter	Type	Description
`stream.streamKey`	string (40 chars)	Stream unique key
`stream.name`	string (1-255 chars)	Stream name
`stream.description`	string (nullable)	Stream description
`stream.regionId`	integer	Regional source ID
`stream.isPublished`	boolean	Whether the stream is live
`stream.countdown`	object (nullable)	Countdown configuration
`stream.countdown.isCountdown`	boolean	Whether countdown is active
`stream.countdown.startDate`	string	Start date (ISO 8601)
`stream.countdown.timezone`	string	Countdown timezone
`stream.sourceType`	string	PUSH or PULL
`stream.encoderMode`	string	ABR or PASSTHROUGH
`stream.credentials`	object	RTMP authentication
`stream.credentials.username`	string	Username
`stream.credentials.password`	string	Password
`stream.thumbnail`	array (nullable)	Thumbnail images
`stream.splashscreen`	array (nullable)	Splashscreen images
`stream.source`	object (nullable)	Source info (if PULL)
`stream.targets`	array	Restream targets
`stream.themeId`	integer (nullable)	Theme ID
`stream.theme`	object	Theme configuration
`stream.isCreated`	boolean	Whether stream is finalized
`stream.createdAt`	string	Creation date (ISO 8601)

Successful Response (200)

json

{
  "stream": {
    "streamKey": "9ed8b119f8ed9425a428a47846e55c6b761afc6c",
    "name": "My stream",
    "description": "Sample description",
    "regionId": 1,
    "isPublished": true,
    "countdown": {
      "isCountdown": true,
      "startDate": "2024-01-26T15:25:53.000000Z",
      "timezone": "Europe/Warsaw"
    },
    "sourceType": "PULL",
    "encoderMode": "ABR",
    "credentials": {
      "username": "902aee51",
      "password": "f9aef6eac1d977d"
    },
    "thumbnail": [
      {
        "sizeName": "1280x720",
        "width": 1000,
        "height": 563,
        "path": "https://cdn.stormstreaming.com/..."
      }
    ],
    "splashscreen": [
      {
        "sizeName": "1280x720",
        "width": 1280,
        "height": 720,
        "path": "https://cdn.stormstreaming.com/..."
      }
    ],
    "source": {
      "id": 53,
      "name": "Sample RTMP pull",
      "protocol": "RTMP",
      "url": "rtmp://XXXXXX/live/xxx",
      "isAuth": true,
      "authUsername": "sampleusername",
      "authPassword": "samplepassword",
      "isCreated": true,
      "createdAt": "2024-01-24T11:48:09.000000Z"
    },
    "targets": [
      {
        "id": 17,
        "name": "Facebook",
        "restreamType": "FACEBOOK",
        "url": "rtmp://facebookrtmpurl/",
        "isAuth": false,
        "isCreated": true,
        "createdAt": "2023-06-20T19:12:12.000000Z"
      }
    ],
    "themeId": 54,
    "theme": {
      "id": 54,
      "name": "test",
      "isDefault": 1,
      "theme": { "..." },
      "logo": {
        "id": 1341,
        "path": "https://cdn.stormstreaming.com/..."
      },
      "created_at": "2024-01-24T12:15:24.000000Z",
      "updated_at": "2024-01-24T16:32:56.000000Z"
    },
    "isCreated": true,
    "createdAt": "2024-01-25T11:10:53.000000Z"
  }
}

Support Needed?

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