OpenFish Documentation

Appearance

Get annotations​

GET
/api/v1/annotations

Get paginated annotations, with options to filter by video stream, capture source, observer and observation.

Parameters​

Query Parameters

limit

Number of results to return.

Typeinteger
offset

Number of results to skip.

Typeinteger
name

Name to filter by.

Typestring
videostream

Video stream to filter by.

Typeinteger
capturesource

Capture source to filter by.

Typeinteger
observer

Observer to filter by.

Typestring
observation[<key>]

Observation key/value to filter by. Use * to filter on presence of the key only.

Typestring

Responses​

OK
JSON
{
"limit": 20,
"offset": 0,
"results": [
{
"id": 1234567890,
"keypoints": [
{
"box": {
"x1": 10,
"x2": 50,
"y1": 25,
"y2": 75
},
"time": "01:56:05.500"
}
],
"observation": {
"common_name": "Zebrafish",
"species": "Girella Zebra"
},
"observer": "user@example.com",
"videostreamId": 1234567890
}
],
"total": 1
}

Samples​

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