Commercial Fisheries Research Foundation API

All endpoints require an Authorization header with a valid API token unless otherwise noted. Tokens are scoped to specific endpoints via permissions.

Endpoints

Method Endpoint Description Parameters Permission
GET /get_medmr
5 / minute
Maine DMR fleet data when_start, when_stop, vessel_id medmr
GET /get_scallapp
60 / minute
ScallApp citizen science observer data. Returns lat/lon and shell health metrics. Land points excluded. start_date, end_date scallapp
GET /get_scallapp_leaderboard Top 3 ScallApp users by a given engagement metric game_metric (total_sessions | months_sampled | longest_consecutive_months) scallapp
GET /fvon_get_metadata FVON instrument metadata for RBR and Zebra Tech sensors - fvon
GET /get_app_updates Lists available update files in S3 for a given application application_id (e.g. odd) odd
POST /insert_telem_tags Deprecated. Insert telemetry tag deployment records JSON body - single object or array telemetry

Default rate limits: 500 / hour  |  2000 / day. Per-endpoint limits shown inline above.