OpenFish Documentation

Appearance

Get video streams​

GET
/api/v1/videostreams

Get paginated video streams, with options to filter by timespan and capturesource.

Parameters​

Query Parameters

limit

Number of results to return.

Typeinteger
offset

Number of results to skip.

Typeinteger
capturesource

Capture source ID to filter by.

Typeinteger
timespan[start]

Start time to filter by.

Typestring
timespan[end]

End time to filter by.

Typestring

Responses​

OK
JSON
{
"limit": 20,
"offset": 0,
"results": [
{
"annotator_list": [
"user@example.com"
],
"capturesource": 1234567890,
"endTime": "2023-05-25T16:30:00Z",
"id": 1234567890,
"startTime": "2023-05-25T08:00:00Z",
"stream_url": "https://www.youtube.com/watch?v=abcdefghijk"
}
],
"total": 1
}

Samples​

cURL
curl -X GET https://openfish.appspot.com/api/v1/videostreams
JavaScript
fetch("https://openfish.appspot.com/api/v1/videostreams")
  .then(response => response.json())
  .then(data => console.log(data));
PHP
file_get_contents("https://openfish.appspot.com/api/v1/videostreams");
Python
import requests
response = requests.get("https://openfish.appspot.com/api/v1/videostreams")
print(response.json())