Endpoints
fish_api 3
What is the Fish species API?
A Restful API which is scraping the Wikipedia pages for fish species in order to collect data. The data are cached and refreshed every 24 hours.
Fish species API is available on the JoJ API marketplace. Subscribe with a single JoJ API key, call it through one gateway, and pay from one wallet — no separate account or contract with the provider.
Fish species API endpoints
- GET
/fish_api/fish/{name}GET FISH BY NAME
Retrieves detailed information for a specific fish.
- GET
/fish_api/fishesGET ALL FISH
This endpoint returns all available fish.
- GET
/fish_api/groupGET A GROUP OF FISH
This endpoint groups data by the specified property_value. It accepts three URL query parameters: meta_property, meta_property_attribute, and property_value. The API returns all fish matching the property_value specified within the meta-object.
Frequently asked questions about Fish species API
Question: What kind of information can I get from this API?
The API returns detailed species information including scientific names, taxonomy, natural habitats, physical characteristics, and biological details.
Group Endpoint FAQ
t returns all fish whose metadata contains the requested value. What is the endpoint? GET /fish_api/group Local example: http://localhost:5555/fish_api/group Which query parameters does it accept? - meta_property: The main field inside the meta object. - meta_property_attribute: An optional nested field. - property_value: The value to search for. How do I search a nested property? GET /fish_api/group?meta_property=scientific_classification&meta_property_attribute=class&property_value=actinopterygii This returns fish containing: { "meta": { "scientific_classification": { "class": "actinopterygii" } } } How do I search a top-level metadata property? GET /fish_api/group?meta_property=conservation_status&property_value=least%20concern Does the search require an exact match? No. The endpoint performs a partial, case-insensitive search. For example, actino can match actinopterygii. What does a successful response contain? A JSON array containing the matching fish: [ { "id": 2, "name": "Albacore", "url": "https://en.wikipedia.org/wiki/Albacore", "img_src_set": {}, "meta": { "scientific_classification": { "class": "actinopterygii" } } } ] What HTTP status codes can it return? - 200 OK: Matching fish were found. - 400 Bad Request: Required parameters are missing or invalid. - 404 Not Found: No matching fish were found. - 500 Internal Server Error: An unexpected server error occurred.