Developer Documentation

Interactive bird encyclopedia. 11,251 bird species, 258 families across 40 orders, 15 habitats, 197 countries with regional presence data, 19,160 regional records, 74 glossary terms, 15 guides, and interactive ornithology tools in 15 languages.

Quick Start

curl -s "https://birdfyi.com/api/v1/birds/?limit=5"

API Endpoints

Method Endpoint Description
GET /api/v1/birds/ List all birds (paginated)
GET /api/v1/birds/{id}/ Bird 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/habitats/ List habitat types
GET /api/v1/habitats/{id}/ Habitat detail
GET /api/v1/countries/ List all countries
GET /api/v1/countries/{id}/ Country detail
GET /api/v1/regional-presences/ Regional presence records
GET /api/v1/comparisons/ Bird comparisons
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 birds, glossary
GET /api/v1/stats/ Site statistics

URL Patterns

Use these patterns to construct URLs programmatically:

/birds/ Bird species directory (paginated, filterable) (e.g. /birds/)
/bird/{slug}/ Bird species detail with taxonomy, traits, conservation (e.g. /bird/bald-eagle/)
/orders/ Taxonomic orders list (e.g. /orders/)
/order/{slug}/ Order detail with families and species (e.g. /order/passeriformes/)
/family/{slug}/ Family detail with species list (e.g. /family/corvidae/)
/countries/ Countries with bird data (e.g. /countries/)
/country/{code}/ Country bird profile (ISO alpha-2) (e.g. /country/us/)
/habitats/ Habitat types list (e.g. /habitats/)
/habitat/{slug}/ Habitat detail with species (e.g. /habitat/forest/)
/regional/ Regional presence index (Country x Season) (e.g. /regional/)
/regional/{code}/{season}/ Regional detail (e.g. /regional/us/spring/)
/compare/ Bird comparison tool (N²) (e.g. /compare/)
/compare/{slug1}/vs/{slug2}/ Compare two bird species (e.g. /compare/bald-eagle/vs/golden-eagle/)
/glossary/ Ornithology glossary (74 terms) (e.g. /glossary/)
/glossary/{slug}/ Glossary term definition (e.g. /glossary/migration/)
/guides/ Educational bird guides (15) (e.g. /guides/)
/guides/series/{slug}/ Guide series (e.g. /guides/series/birdwatching-basics/)
/guide/{slug}/ Guide article (e.g. /guide/identifying-raptors/)
/tools/ Interactive ornithology tools (e.g. /tools/)
/tools/{slug}/ Tool page (e.g. /tools/bird-size-comparison/)
/search/ Search birds, glossary (e.g. /search/?q=eagle)

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 birdfyi

Bird species API client and CLI

npm
npm install birdfyi

TypeScript bird data utilities

Embed Widget

Embed data cards on your site: https://widget.birdfyi.com
npm install birdfyi-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.