beta/
docs
/
overview
OverviewGuidesAPI Reference
Log inSign up
beta/
docs
/
overview
OverviewGuidesAPI Reference
Sign upLogin
API Reference
Introduction
Stream
The stream object
GET list stream objects

List streams

You can retrieve all stream objects with the same userID. The response will include both parent stream objects that represent a livestream configuration and child-session stream objects.

curl -H 'authorization: Bearer {api-key}' \
"https://livepeer.com/api/stream/"

Quick filters

JSON parameterExampleDescription
streamsonly=1/api/stream?streamsonly=1Excludes child-session stream objects
sessionsonly=1/api/stream?sessionsonly=1Excludes parent objects and only returns child-session stream objects
record=1/api/stream/{parentId}/sessions?record=1Returns all sessions stream objects with the same parentId and record: true

Additional query parameters

JSON parameterTypeDescription
isActivebooleantrue returns active stream objects. false returns idle stream objects. The default value for new stream objects is false. Exclude child-session objects example /api/stream?streamsonly=1&filters=[{"id": "isActive", "value": true}]. This example showed a decoded JSON object. But, remember that anything passed as a parameter in a GET request URL must be URL encoded.
Livepeer.com
beta
  • Company
  • Home
  • Contact
  • Team
  • Jobs
  • Livepeer, Inc.
  • 223 Bedford Ave PMB 530
    Brooklyn, NY 11211
  • [email protected]