v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Electronic Structure

Get ElectronicStructureDoc documents

get/materials/electronic_structure/

Query parameters

material_idsstring nullable

Comma-separated list of material_id values to query on

Comma-separated list of material_id values to query on

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.

formulastring nullable

Query by formula including anonymized formula or by including wild cards. A comma delimited string list of anonymous formulas or regular formulas can also be provided.

Query by formula including anonymized formula or by including wild cards. A comma delimited string list of anonymous formulas or regular formulas can also be provided.

chemsysstring nullable

A comma delimited string list of chemical systems. Wildcards for unknown elements only supported for single chemsys queries

A comma delimited string list of chemical systems. Wildcards for unknown elements only supported for single chemsys queries

elementsstring nullable

Query by elements in the material composition as a comma-separated list

Query by elements in the material composition as a comma-separated list

exclude_elementsstring nullable

Query by excluded elements in the material composition as a comma-separated list

Query by excluded elements in the material composition as a comma-separated list

band_gap_maxnumber

Query for maximum value of band_gap

Query for maximum value of band_gap

band_gap_minnumber

Query for minimum value of band_gap

Query for minimum value of band_gap

cbm_maxnumber nullable

Query for maximum value of cbm

Query for maximum value of cbm

cbm_minnumber nullable

Query for minimum value of cbm

Query for minimum value of cbm

vbm_maxnumber nullable

Query for maximum value of vbm

Query for maximum value of vbm

vbm_minnumber nullable

Query for minimum value of vbm

Query for minimum value of vbm

efermi_maxnumber nullable

Query for maximum value of efermi

Query for maximum value of efermi

efermi_minnumber nullable

Query for minimum value of efermi

Query for minimum value of efermi

nsites_maxinteger nullable

Query for maximum value of nsites

Query for maximum value of nsites

nsites_mininteger nullable

Query for minimum value of nsites

Query for minimum value of nsites

nsitesinteger nullable

Query for nsites being equal to an exact value

Query for nsites being equal to an exact value

nsites_not_eqinteger nullable

Query for nsites being not equal to an exact value

Query for nsites being not equal to an exact value

nsites_eq_anystring

Query for nsites being any of these values. Provide a comma separated list.

Query for nsites being any of these values. Provide a comma separated list.

nsites_neq_anystring

Query for nsites being not any of these values. Provide a comma separated list.

Query for nsites being not any of these values. Provide a comma separated list.

nelements_maxinteger nullable

Query for maximum value of nelements

Query for maximum value of nelements

nelements_mininteger nullable

Query for minimum value of nelements

Query for minimum value of nelements

nelementsinteger nullable

Query for nelements being equal to an exact value

Query for nelements being equal to an exact value

nelements_not_eqinteger nullable

Query for nelements being not equal to an exact value

Query for nelements being not equal to an exact value

nelements_eq_anystring

Query for nelements being any of these values. Provide a comma separated list.

Query for nelements being any of these values. Provide a comma separated list.

nelements_neq_anystring

Query for nelements being not any of these values. Provide a comma separated list.

Query for nelements being not any of these values. Provide a comma separated list.

volume_maxnumber nullable

Query for maximum value of volume

Query for maximum value of volume

volume_minnumber nullable

Query for minimum value of volume

Query for minimum value of volume

density_maxnumber nullable

Query for maximum value of density

Query for maximum value of density

density_minnumber nullable

Query for minimum value of density

Query for minimum value of density

density_atomic_maxnumber nullable

Query for maximum value of density_atomic

Query for maximum value of density_atomic

density_atomic_minnumber nullable

Query for minimum value of density_atomic

Query for minimum value of density_atomic

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