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
default20
minimum1
offset

Number of results to skip.

Typeinteger
minimum0
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
application/json
JSON
{
"limit": 20,
"offset": 0,
"results": [
{
"annotator_list": [
{
"display_name": "Coral Fischer",
"id": 1234567890,
"role": "annotator"
}
],
"capturesource": {
"id": 1234567890,
"name": "Stony Point Cuttle Cam"
},
"endTime": "2023-05-25T16:30:00Z",
"id": 1234567890,
"startTime": "2023-05-25T08:00:00Z",
"stream_url": "https://www.youtube.com/watch?v=abcdefghijk",
"timezone": "Australia/Adelaide"
}
],
"total": 1
}

Samples​