Developer Documentation

Comprehensive gemstone encyclopedia — gemstones with physical, optical, value, and cultural properties. Categories include precious, semi-precious, organic, and synthetic gems. Covers Mohs hardness, refractive index, color science, birthstones, origins, treatments, and jewelry suitability.

Quick Start

curl -s "https://gemfyi.com/api/v1/gems/"

API Endpoints

Method Endpoint Description
GET /api/v1/gems/ List gemstones (DRF, paginated)
GET /api/v1/gems/{slug}/ Gemstone detail
GET /api/v1/categories/ Gem categories (DRF, paginated)
GET /api/v1/origins/ Gem origins (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

URL Patterns

Use these patterns to construct URLs programmatically:

/ Homepage with featured gems and stats (e.g. /)
/gems/ Browse all gemstones (e.g. /gems/)
/gems/{slug}/ Gemstone detail page (e.g. /gems/diamond/)
/compare/ Gem comparison index (e.g. /compare/)
/compare/{slug_a}-vs-{slug_b}/ Gem comparison (e.g. /compare/diamond-vs-moissanite/)
/category/{slug}/ Gem category (precious, semi-precious, etc.) (e.g. /category/precious/)
/colors/ Browse gems by color (e.g. /colors/)
/colors/{color}/ Gems of a specific color (e.g. /colors/red/)
/origins/ Gemstone origins and mining regions (e.g. /origins/)
/origins/{slug}/ Origin detail (e.g. /origins/kashmir/)
/birthstones/ Birthstone guide by month (e.g. /birthstones/)
/birthstones/{month}/ Birthstone for a month (e.g. /birthstones/april/)
/glossary/ Gemology glossary (e.g. /glossary/)
/glossary/{slug}/ Glossary term (e.g. /glossary/birefringence/)
/guides/ Gemstone guides (e.g. /guides/)
/guide/{slug}/ Guide article (e.g. /guide/diamond-buying-guide/)
/tools/ Interactive gemstone tools (e.g. /tools/)
/tool/{slug}/ Tool page (e.g. /tool/gem-comparator/)
/gems/{slug}/buying-guide/ Buying guide for a gem (e.g. /gems/emerald/buying-guide/)

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 gemfyi

Gemstone data, Mohs scale, optical properties

Embed Widget

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