Materials API
Complete REST API docs for materials endpoints
API Overview
Base URL, versioning, response format, and general conventions for the MatCraft Materials API.
Authentication
JWT tokens, OAuth providers, and guest access for the MatCraft API.
List Materials
GET /materials endpoint with all filter parameters, sorting, and pagination.
Get Material Detail
GET /materials/{id} endpoint returning full material properties and structure data.
Export Structure
GET /materials/{id}/export/{format} to download crystal structures as CIF, POSCAR, or XYZ.
Similar Materials
GET /materials/{id}/similar to find structurally and compositionally related materials.
Scatter Plot Data
GET /materials/scatter to retrieve property pairs for visualization scatter plots.
Band Structure
GET /electronic/bandstructure/{mp_id} to retrieve electronic band structure data.
Density of States
GET /electronic/dos/{mp_id} to retrieve total and element-projected DOS data.
XRD Simulation
GET /electronic/xrd/{mp_id} to retrieve simulated powder X-ray diffraction patterns.
Phase Diagram
GET /electronic/phase_diagram to compute convex hull phase diagrams for chemical systems.
Supercell Builder
POST /builder/supercell to generate expanded periodic structures from unit cells.
Surface Builder
POST /builder/surface to generate surface slab structures with specified Miller indices.
Nanoparticle Builder
POST /builder/nanoparticle to carve spherical nanoparticles from bulk crystal structures.
Substitution Builder
POST /builder/substitute to replace elements in a crystal structure for doping studies.