Developer Documentation

Comprehensive astronomy encyclopedia — stars, constellations, exoplanets, and deep-sky objects. Harvard spectral classification (OBAFGKM), photometric data (apparent/absolute magnitude), physical properties (mass, radius, luminosity, temperature), positional data (RA/Dec), and star comparisons.

Quick Start

curl -s "https://starfyi.com/api/v1/stars/"

API Endpoints

Method Endpoint Description
GET /api/v1/stars/ List stars (DRF, paginated)
GET /api/v1/stars/{slug}/ Star detail
GET /api/v1/constellations/ Constellations (DRF, paginated)
GET /api/v1/spectral-classes/ Spectral classes (DRF, paginated)
GET /api/v1/exoplanets/ Exoplanets (DRF, paginated)
GET /api/v1/deep-sky/ Deep-sky objects (DRF, paginated)
GET /api/v1/glossary/ Glossary terms (DRF, paginated)
GET /api/v1/guides/ Guides (DRF, paginated)
GET /api/v1/tools/ Interactive tools (DRF, paginated)
GET /api/v1/faqs/ FAQs (DRF, paginated)
GET /api/v1/search/?q={query} Unified search (DRF)
GET /api/v1/stats/ Site statistics
GET /api/search/suggest/?q={query} Search autocomplete

URL Patterns

Use these patterns to construct URLs programmatically:

/ Homepage with featured stars and stats (e.g. /)
/stars/ Browse all stars (e.g. /stars/)
/star/{slug}/ Star detail page (e.g. /star/sirius/)
/constellations/ Browse all 88 constellations (e.g. /constellations/)
/constellation/{slug}/ Constellation detail (e.g. /constellation/orion/)
/spectral-classes/ Harvard spectral classification OBAFGKM (e.g. /spectral-classes/)
/spectral-class/{slug}/ Spectral class detail (e.g. /spectral-class/g/)
/exoplanets/ Browse exoplanets (e.g. /exoplanets/)
/exoplanet/{slug}/ Exoplanet detail (e.g. /exoplanet/proxima-centauri-b/)
/deep-sky/ Browse deep-sky objects (e.g. /deep-sky/)
/deep-sky/{slug}/ Deep-sky object detail (e.g. /deep-sky/andromeda-galaxy/)
/compare/ Star comparison index (e.g. /compare/)
/compare/{slug1}/vs/{slug2}/ Star comparison (e.g. /compare/sirius/vs/betelgeuse/)
/glossary/ Astronomy glossary (e.g. /glossary/)
/glossary/{slug}/ Glossary term (e.g. /glossary/parallax/)
/guide/ Astronomy guides (e.g. /guide/)
/guide/{slug}/ Guide article (e.g. /guide/stargazing-basics/)
/tools/ Interactive astronomy tools (e.g. /tools/)
/tools/{slug}/ Tool page (e.g. /tools/star-magnitude-calculator/)
/constellation/{slug}/mythology/ Constellation mythology (e.g. /constellation/orion/mythology/)
/search/ Search stars, constellations, exoplanets (e.g. /search/?q=sirius)

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", "...": "..."}
  ]
}

OpenAPI Specification

Full API schema available as OpenAPI 3.1.0 JSON. Import into Swagger UI, Postman, or any OpenAPI-compatible tool.

SDK Packages

PyPI
pip install starfyi

Star catalog, constellation data, spectral classification

Embed Widget

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