Developer Documentation

Comprehensive metal alloy reference — alloys across 14 metal bases (steel, stainless steel, aluminum, copper, titanium, nickel, and more), organized by alloy families, with 6-axis rating system (strength, corrosion, weight, machinability, cost, temperature), composition data, mechanical and physical properties, and industrial applications.

Quick Start

curl -s "https://alloyfyi.com/api/v1/alloys/"

API Endpoints

Method Endpoint Description
GET /api/v1/alloys/ List alloys (DRF, paginated)
GET /api/v1/alloys/{slug}/ Alloy detail
GET /api/v1/families/ Alloy families (DRF, paginated)
GET /api/v1/applications/ Applications (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 alloys and stats (e.g. /)
/alloys/ Browse all alloys (e.g. /alloys/)
/alloys/{slug}/ Alloy detail page (e.g. /alloys/stainless-steel-304/)
/compare/ Alloy comparison index (e.g. /compare/)
/compare/{slug_a}-vs-{slug_b}/ Alloy comparison (e.g. /compare/304-vs-316/)
/families/ Browse alloy families (e.g. /families/)
/families/{slug}/ Alloy family detail (e.g. /families/austenitic-stainless-steel/)
/metals/ Browse by metal base (e.g. /metals/)
/metals/{base}/ Metal base detail (e.g. /metals/titanium/)
/applications/ Industrial applications (e.g. /applications/)
/applications/{slug}/ Application detail (e.g. /applications/aerospace/)
/glossary/ Metallurgy glossary (e.g. /glossary/)
/glossary/{slug}/ Glossary term (e.g. /glossary/austenite/)
/guides/ Alloy guides (e.g. /guides/)
/guides/{slug}/ Guide article (e.g. /guides/introduction-to-stainless-steel/)
/tools/ Interactive alloy tools (e.g. /tools/)
/tool/{slug}/ Tool page (e.g. /tool/material-selector/)

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 alloyfyi

Alloy data, composition lookup, property comparison

Embed Widget

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