api.video
  1. Live
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
      POST
    • List all active upload tokens.
      GET
    • Generate an upload token
      POST
    • Delete an upload token
      DELETE
    • Show upload token
      GET
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Live

List all live streams

GET
/live-streams
Live
With no parameters added to the url, this will return all livestreams. Query by name or key to limit the list.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ws.api.video/live-streams'
Response Response Example
{
  "data": [
    {
      "assets": {
        "hls": "https://live.api.video/li400mYKSgQ6xs7taUeSaEKr.m3u8",
        "iframe": "<iframe src=\"https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
        "player": "https://embed.api.video/live/li400mYKSgQ6xs7taUeSaEKr",
        "thumbnail": "https://cdn.api.video/live/li400mYKSgQ6xs7taUeSaEKr/thumbnail.jpg"
      },
      "broadcasting": false,
      "createdAt": "2020-01-31T10:17:47.000Z",
      "liveStreamId": "li400mYKSgQ6xs7taUeSaEKr",
      "name": "Live Stream From the browser",
      "public": true,
      "record": true,
      "streamKey": "30087931-229e-42cf-b5f9-e91bcc1f7332",
      "updatedAt": "2020-03-09T13:19:43.000Z"
    },
    {
      "assets": {
        "hls": "https://live.api.video/li4pqNqGUkhKfWcBGpZVLRY5.m3u8",
        "iframe": "<iframe src=\"https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5\" width=\"100%\" height=\"100%\" frameborder=\"0\" scrolling=\"no\" allowfullscreen=\"\"></iframe>",
        "player": "https://embed.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5",
        "thumbnail": "https://cdn.api.video/live/li4pqNqGUkhKfWcBGpZVLRY5/thumbnail.jpg"
      },
      "broadcasting": false,
      "createdAt": "2020-07-29T10:45:35.000Z",
      "liveStreamId": "li4pqNqGUkhKfWcBGpZVLRY5",
      "name": "Live From New York",
      "public": true,
      "record": true,
      "streamKey": "cc1b4df0-d1c5-4064-a8f9-9f0368385135",
      "updatedAt": "2020-07-29T10:45:35.000Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "currentPageItems": 19,
    "itemsTotal": 19,
    "links": [
      {
        "rel": "self",
        "uri": "/live-streams?currentPage=1&pageSize=25"
      },
      {
        "rel": "first",
        "uri": "/live-streams?currentPage=1&pageSize=25"
      },
      {
        "rel": "last",
        "uri": "/live-streams?currentPage=1&pageSize=25"
      }
    ],
    "pageSize": 25,
    "pagesTotal": 1
  }
}

Request

Query Params
streamKey
string 
optional
The unique stream key that allows you to stream videos.
Example:
30087931-229e-42cf-b5f9-e91bcc1f7332
name
string 
optional
You can filter live streams by their name or a part of their name.
Example:
My Video
sortBy
string 
optional
Allowed: createdAt, publishedAt, name. createdAt - the time a livestream was created using the specified streamKey. publishedAt - the time a livestream was published using the specified streamKey. name - the name of the livestream. If you choose one of the time based options, the time is presented in ISO-8601 format.
Example:
createdAt
sortOrder
string 
optional
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.
Example:
desc
currentPage
integer 
optional
Choose the number of search results to return per page. Minimum value: 1
Example:
2
pageSize
integer 
optional
Results per page. Allowed values 1-100, default is 25.
Example:
30

Responses

🟢200Success
application/json
Body
data
array[object (LiveStream) {8}] 
required
assets
object (live_stream_assets) 
optional
broadcasting
boolean 
optional
Whether or not you are broadcasting the live video you recorded for others to see. True means you are broadcasting to viewers, false means you are not.
Example:
true
liveStreamId
string 
optional
The unique identifier for the live stream. Live stream IDs begin with "li."
Example:
li400mYKSgQ6xs7taUeSaEKr
name
string 
optional
The name of your live stream.
Example:
My Live Stream
playerId
string 
optional
The unique identifier for the player.
Example:
pl45d5vFFGrfdsdsd156dGhh
public
boolean 
optional
BETA FEATURE Please limit all public = false ("private") livestreams to 3,000 users. Whether your video can be viewed by everyone, or requires authentication to see it. A setting of false will require a unique token for each view.
Example:
true
record
boolean 
optional
Whether you are recording or not.
Example:
true
streamKey
string 
optional
The unique, private stream key that you use to begin streaming.
Example:
cc1b4df0-d1c5-4064-a8f9-9f0368385135
pagination
object (Pagination) 
required
Example:
{"currentPage":3,"currentPageItems":20,"itemsTotal":123,"links":{"first":{"rel":"first","uri":"/videos/search?currentPage=1&pageSize=20"},"last":{"rel":"last","uri":"/videos/search?currentPage=6&pageSize=20"},"next":{"rel":"next","uri":"/videos/search?currentPage=4&pageSize=20"},"previous":{"rel":"previous","uri":"/videos/search?currentPage=2&pageSize=20"}},"pageSize":20,"pagesTotal":7}
currentPage
integer 
read-onlyoptional
The current page index.
currentPageItems
integer 
read-onlyoptional
The number of items on the current page.
itemsTotal
integer 
read-onlyoptional
Total number of items that exist.
links
array[object (PaginationLink) {2}] 
required
pageSize
integer 
read-onlyoptional
Maximum number of item per page.
pagesTotal
integer 
read-onlyoptional
Number of items listed in the current page.
Modified at 2023-08-15 05:52:15
Previous
Refresh token
Next
Create live stream
Built with