APapivideo
Live Streams

List all live streams

Changed on

Get the list of livestreams on the workspace.

get/live-streams

Request

  • Base URL
    https://ws.api.video
  • URL
    https://ws.api.video/live-streams
  • Auth
    HTTP basic

Query parameters

streamKeystring

The unique stream key that allows you to stream videos.

namestring

You can filter live streams by their name or a part of their name.

sortBy'name' | 'createdAt' | 'updatedAt'

Enables you to sort live stream results. Allowed attributes: name, createdAt, updatedAt. name - the name of the live stream. createdAt - the time a live stream was created. updatedAt - the time a live stream was last updated.

When using createdAt or updatedAt, the API sorts the results based on the ATOM UTC time format.

sortOrder'asc' | 'desc'

Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones. For title, it is 0-9 and A-Z ascending and Z-A, 9-0 descending.

currentPageinteger

Choose the number of search results to return per page. Minimum value: 1

pageSizeinteger

Results per page. Allowed values 1-100, default is 25.

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "streamKey": "dw-dew8-q6w9-k67w-1ws8",
      "createdAt": "2020-01-31T10:17:47Z",
      "assets": {
        "thumbnail": "https://live.api.video/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg",
        "iframe": "<iframe src=\\\"https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5\\\" width=\\\"100%\\\" height=\\\"100%\\\" frameborder=\\\"0\\\" scrolling=\\\"no\\\" allowfullscreen=\\\"\\\"></iframe>",
        "hls": "https://live.api.video/li4pqNqGUkhKfWcBGpZVLRY5.m3u8",
        "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr"
      },
      "public": true,
      "restreams": [
        {
          "streamKey": "dw-dew8-q6w9-k67w-1ws8",
          "serverUrl": "rtmp://my.broadcast.example.com/app",
          "name": "My restream server"
        },
        {
          "streamKey": "dw-dew8-q6w9-k67w-1ws8",
          "serverUrl": "rtmp://my.broadcast.example.com/app",
          "name": "My restream server"
        }
      ],
      "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
      "name": "My Live Stream",
      "playerId": "pl45d5vFFGrfdsdsd156dGhh",
      "broadcasting": true,
      "updatedAt": "2020-01-31T10:18:47Z"
    },
    {
      "streamKey": "dw-dew8-q6w9-k67w-1ws8",
      "createdAt": "2020-01-31T10:17:47Z",
      "assets": {
        "thumbnail": "https://live.api.video/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg",
        "iframe": "<iframe src=\\\"https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5\\\" width=\\\"100%\\\" height=\\\"100%\\\" frameborder=\\\"0\\\" scrolling=\\\"no\\\" allowfullscreen=\\\"\\\"></iframe>",
        "hls": "https://live.api.video/li4pqNqGUkhKfWcBGpZVLRY5.m3u8",
        "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr"
      },
      "public": true,
      "restreams": [
        {
          "streamKey": "dw-dew8-q6w9-k67w-1ws8",
          "serverUrl": "rtmp://my.broadcast.example.com/app",
          "name": "My restream server"
        },
        {
          "streamKey": "dw-dew8-q6w9-k67w-1ws8",
          "serverUrl": "rtmp://my.broadcast.example.com/app",
          "name": "My restream server"
        }
      ],
      "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
      "name": "My Live Stream",
      "playerId": "pl45d5vFFGrfdsdsd156dGhh",
      "broadcasting": true,
      "updatedAt": "2020-01-31T10:18:47Z"
    }
  ]
}

Changes

  • ec2b79bfdc8dRevision changes
    • info

      added the non-success response with the status

  • 6c10f5429263Revision changes
    • breaking

      the query request parameter sortBy was restricted to a list of enum values

    • info

      added the new enum value createdAt to the query request parameter sortBy

    • info

      added the new enum value name to the query request parameter sortBy

    • info

      added the new enum value updatedAt to the query request parameter sortBy