OpenFish Documentation

Appearance

Get capture sources​

GET
/api/v1/capturesources

Get paginated capture sources, with options to filter by name and location.

Parameters​

Query Parameters

limit

Number of results to return.

Typeinteger
offset

Number of results to skip.

Typeinteger
name

Name to filter by.

Typestring

Responses​

OK
JSON
{
"limit": 20,
"offset": 0,
"results": [
{
"camera_hardware": "pi cam v2 (wide angle lens)",
"id": 1234567890,
"location": "-32.12345,139.12345",
"name": "Stony Point Cuttle Cam",
"site_id": 246813579
}
],
"total": 1
}

Samples​

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