Developer Documentation

Interactive fish encyclopedia. 35,729 fish species, 627 families across 98 orders, 15 fishing methods, 40 water bodies, 197 countries, 48 regions, 1,200 seasonal fishing entries, 80 glossary terms, 20 guides, and interactive ichthyology tools in 15 languages.

Quick Start

curl -s "https://fishfyi.com/api/v1/fish/?limit=5"

API Endpoints

Method Endpoint Description
GET /api/v1/fish/ List all fish (paginated)
GET /api/v1/fish/{id}/ Fish detail
GET /api/v1/orders/ List taxonomic orders
GET /api/v1/orders/{id}/ Order detail
GET /api/v1/families/ List taxonomic families
GET /api/v1/families/{id}/ Family detail
GET /api/v1/countries/ List all countries
GET /api/v1/countries/{id}/ Country detail
GET /api/v1/regions/ Fishing regions
GET /api/v1/methods/ Fishing methods
GET /api/v1/water-bodies/ Water bodies
GET /api/v1/seasons/ Fishing season entries
GET /api/v1/compatibility/ Aquarium compatibility pairs
GET /api/v1/glossary-categories/ Glossary categories
GET /api/v1/glossary/ Glossary terms (paginated)
GET /api/v1/glossary/{id}/ Glossary term detail
GET /api/v1/guide-series/ Guide series
GET /api/v1/guides/ Guide articles (paginated)
GET /api/v1/guides/{id}/ Guide detail
GET /api/v1/tools/ Interactive tools
GET /api/v1/faqs/ FAQs
GET /api/v1/search/?q={query} Search across fish, glossary
GET /api/v1/stats/ Site statistics

URL Patterns

Use these patterns to construct URLs programmatically:

/fish/ Fish species directory (paginated, filterable) (e.g. /fish/)
/fish/{slug}/ Fish species detail with taxonomy, traits, fishing data (e.g. /fish/rainbow-trout/)
/orders/ Taxonomic orders list (e.g. /orders/)
/order/{slug}/ Order detail with families and species (e.g. /order/perciformes/)
/family/{slug}/ Family detail with species list (e.g. /family/salmonidae/)
/countries/ Countries with fish data (e.g. /countries/)
/country/{code}/ Country fish profile (ISO alpha-2) (e.g. /country/us/)
/methods/ Fishing methods list (e.g. /methods/)
/method/{slug}/ Fishing method detail (e.g. /method/fly-fishing/)
/water-bodies/ Notable water bodies (e.g. /water-bodies/)
/water-body/{slug}/ Water body detail (e.g. /water-body/pacific-ocean/)
/seasons/ Fishing seasons index (Region x Month) (e.g. /seasons/)
/seasons/{slug}/{month}/ Seasonal fishing detail (e.g. /seasons/florida/6/)
/compatibility/ Aquarium compatibility index (N²) (e.g. /compatibility/)
/compatibility/{slug1}/vs/{slug2}/ Aquarium compatibility check (e.g. /compatibility/neon-tetra/vs/betta/)
/compare/ Fish comparison tool (N²) (e.g. /compare/)
/compare/{slug1}/vs/{slug2}/ Compare two fish species (e.g. /compare/rainbow-trout/vs/brown-trout/)
/glossary/ Ichthyology glossary (80 terms) (e.g. /glossary/)
/glossary/{slug}/ Glossary term definition (e.g. /glossary/anadromous/)
/guides/ Educational fish guides (20) (e.g. /guides/)
/guides/series/{slug}/ Guide series (e.g. /guides/series/fishing-basics/)
/guide/{slug}/ Guide article (e.g. /guide/freshwater-fishing-101/)
/tools/ Interactive ichthyology tools (e.g. /tools/)
/tools/{slug}/ Tool page (e.g. /tools/tank-size-calculator/)
/search/ Search fish, glossary (e.g. /search/?q=trout)

Response Format

All endpoints return JSON with pagination:

Example JSON response
{
  "count": 636,
  "next": "https://example.com/api/v1/items/?page=2",
  "previous": null,
  "results": [
    {"slug": "example", "name": "Example Item", "...": "..."}
  ]
}

SDK Packages

PyPI
pip install fishfyi

Fish species API client and CLI

npm
npm install fishfyi

TypeScript fish data utilities

Embed Widget

Embed data cards on your site: https://widget.fishfyi.com
npm install fishfyi-embed

Format Support

  • Markdown endpoints: Append .md to any page URL for LLM-friendly markdown output.
  • Internationalization: Content available in 14 languages: ko, ja, zh-hans, es, fr, de, pt, ru, vi, tr, ar, hi, th, id.