Skip to main content

Getting Started

This is the technical documention which includes API docs for the recreational and commercial app (used in the Fish Rules App).

info

Make sure to check out the Fish Rules App to see some concepts in action.

API Access​

Hitting the the API requires you to get an API key, client ID(s), etc. from Fish Rules. Find out more here: https://fish.management/

Required headers include:

x-api-key: Your API key

x-client-id: Your client ID

API Sample Request​

curl "{endpoint_here}/api/species" \
     -H 'x-api-key: ...' \
     -H 'x-client-id: ...'

API Rate limit​

Rate limiting is applied to your API key & client ID, based on the API plan you received from Fish Rules.

API Starting Endpoint​

note

All API documentation assumes you are using the API endpoint Fish Rules supplies to you. e.g. {endpoint}/api/species