v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Electronic Structure

Get ElectronicStructureDoc documents

get/materials/electronic_structure/bandstructure/

Query parameters

path_typestring nullable

k-path selection convention for the band structure.

k-path selection convention for the band structure.

band_gap_maxnumber nullable

Maximum value for the band gap energy in eV.

Maximum value for the band gap energy in eV.

band_gap_minnumber nullable

Minimum value for the band gap energy in eV.

Minimum value for the band gap energy in eV.

efermi_maxnumber nullable

Maximum value for the fermi energy in eV.

Maximum value for the fermi energy in eV.

efermi_minnumber nullable

Minimum value for the fermi energy in eV.

Minimum value for the fermi energy in eV.

magnetic_ordering'FM' | 'AFM' | 'FiM' | 'NM' | 'Unknown'

Enumeration defining possible magnetic orderings.

Magnetic ordering associated with the data.

is_gap_directboolean nullable

Whether a band gap is direct or not.

Whether a band gap is direct or not.

is_metalboolean nullable

Whether the material is considered a metal.

Whether the material is considered a metal.

deprecatedboolean nullable

Whether the material is marked as deprecated

Whether the material is marked as deprecated

_pageinteger

Page number to request (takes precedent over _limit and _skip).

Page number to request (takes precedent over _limit and _skip).

_per_pageinteger

Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.

Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.

_skipinteger

Number of entries to skip in the search.

Number of entries to skip in the search.

_limitinteger

Max number of entries to return in a single query. Limited to 1000.

Max number of entries to return in a single query. Limited to 1000.

_fieldsstring

Fields to project from ElectronicStructureDoc as a list of comma separated strings. Fields include: band_gap cbm vbm efermi is_gap_direct is_metal magnetic_ordering builder_meta nsites elements nelements composition composition_reduced formula_pretty formula_anonymous chemsys volume density density_atomic symmetry material_id deprecated deprecation_reasons last_updated origins warnings structure property_name bandstructure dos

Fields to project from ElectronicStructureDoc as a list of comma separated strings. Fields include: band_gap cbm vbm efermi is_gap_direct is_metal magnetic_ordering builder_meta nsites elements nelements composition composition_reduced formula_pretty formula_anonymous chemsys volume density density_atomic symmetry material_id deprecated deprecation_reasons last_updated origins warnings structure property_name bandstructure dos

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a ElectronicStructureDoc