Get all live streams | FastPix Developer Documentation

{
  "success": true,
  "data": [
    {
      "streamId": "fa7f8c0950ea48ebcc5ef9de8c23deaa",
      "streamKey": "3dc5d7641f918baa083a5c52a5bd9cbckfa7f8c0950ea48ebcc5ef9de8c23deaa",
      "srtSecret": "c51739512d0088d98a46925c9b74c73akfa7f8c0950ea48ebcc5ef9de8c23deaa",
      "trial": false,
      "status": "idle",
      "maxResolution": "1080p",
      "maxDuration": 28800,
      "createdAt": "2024-10-15T08:48:31.551351Z",
      "reconnectWindow": 100,
      "enableRecording": true,
      "enableDvrMode": true,
      "mediaPolicy": "public",
      "metadata": {
        "livestream_name": "Gaming_stream"
      },
      "lowLatency": false,
      "closedCaptions": false,
      "playbackIds": [
        {
          "id": "4e43ec52-4775-4f68-a3ff-a57d8a59bba8",
          "accessPolicy": "public",
          "accessRestrictions": {
            "domains": {
              "defaultPolicy": "allow",
              "allow": [],
              "deny": []
            },
            "userAgents": {
              "defaultPolicy": "allow",
              "allow": [],
              "deny": []
            }
          }
        }
      ],
      "mediaIds": [
        "03cdf35d-8626-4b5f-bd14-d2212cd2a991"
      ],
      "srtPlaybackResponse": {
        "srtPlaybackStreamId": "playfa7f8c0950ea48ebcc5ef9de8c23deaa",
        "srtPlaybackSecret": "490e707dd4d165c9e38d261b252f9457kfa7f8c0950ea48ebcc5ef9de8c23deaa"
      }
    }
  ],
  "pagination": {
    "totalRecords": 4,
    "currentOffset": 1,
    "offsetCount": 4
  }
}

Retrieves a list of all live streams associated with the current workspace. It provides an overview of both current and past live streams, including details like streamId, metadata, status, createdAt and more.

How it works

Use the access token and secret key related to the workspace in the request header. When called, the API provides a paginated response containing all the live streams in that specific workspace. This is helpful for retrieving a large volume of streams and managing content in bulk.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

Username: Access Token ID
Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Query parameters

limitintegerOptional1-50Defaults to 10

Limit specifies the maximum number of items to display per page.

offsetintegerOptionalDefaults to 1

Offset determines the starting point for data retrieval within a paginated list.

orderByenumOptionalDefaults to desc

The list of value can be order in two ways DESC (Descending) or ASC (Ascending). In case not specified, by default it will be DESC.

Allowed values:

Response

All streams retrieved sucessfully

successbooleanOptional

Shows the request status. Returns true for success and false for failure.

datalist of objectsOptional

Displays the result of the request.

paginationobjectOptional

Pagination organizes content into pages for better readability and navigation.