Sign in
Materials Electronic Structure

Get ElectronicStructureDoc documents

get/materials/electronic_structure/dos/

Query parameters

projection_typestring nullable

Projection type for the density of states data.

Projection type for the density of states data.

'1' | '-1'
OR
1 | -1

Enum type for Spin. Only up and down. Usage: Spin.up, Spin.down.

Spin channel for density of states data. '1' corresponds to spin up.

element'H' | 'D' | 'T' | 'He' | 'Li' | 'Be' | 'B' | 'C' | 'N' | 'O' | 'F' | 'Ne' | 'Na' | 'Mg' | 'Al' | 'Si' | 'P' | 'S' | 'Cl' | 'Ar' | 'K' | 'Ca' | 'Sc' | 'Ti' | 'V' | 'Cr' | 'Mn' | 'Fe' | 'Co' | 'Ni' | 'Cu' | 'Zn' | 'Ga' | 'Ge' | 'As' | 'Se' | 'Br' | 'Kr' | 'Rb' | 'Sr' | 'Y' | 'Zr' | 'Nb' | 'Mo' | 'Tc' | 'Ru' | 'Rh' | 'Pd' | 'Ag' | 'Cd' | 'In' | 'Sn' | 'Sb' | 'Te' | 'I' | 'Xe' | 'Cs' | 'Ba' | 'La' | 'Ce' | 'Pr' | 'Nd' | 'Pm' | 'Sm' | 'Eu' | 'Gd' | 'Tb' | 'Dy' | 'Ho' | 'Er' | 'Tm' | 'Yb' | 'Lu' | 'Hf' | 'Ta' | 'W' | 'Re' | 'Os' | 'Ir' | 'Pt' | 'Au' | 'Hg' | 'Tl' | 'Pb' | 'Bi' | 'Po' | 'At' | 'Rn' | 'Fr' | 'Ra' | 'Ac' | 'Th' | 'Pa' | 'U' | 'Np' | 'Pu' | 'Am' | 'Cm' | 'Bk' | 'Cf' | 'Es' | 'Fm' | 'Md' | 'No' | 'Lr' | 'Rf' | 'Db' | 'Sg' | 'Bh' | 'Hs' | 'Mt' | 'Ds' | 'Rg' | 'Cn' | 'Nh' | 'Fl' | 'Mc' | 'Lv' | 'Ts' | 'Og'

Enum representing an element in the periodic table.

Element type for projected density of states data.

orbital0 | 1 | 2 | 3

Enum type for orbital type. Indices are the azimuthal quantum number l.

Orbital type for projected density of states data.

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.

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.

id_formatstring nullable

Optional. If set to 'legacy', MP identifier fields in the response are returned in the form 'mp-149'. If set to 'alpha', they are returned in the padded AlphaID form 'mp-aaaaaaft'. If omitted (or set to any other value), identifiers are returned in their stored form. This is a purely cosmetic transform; query inputs accept either shape regardless.

Optional. If set to 'legacy', MP identifier fields in the response are returned in the form 'mp-149'. If set to 'alpha', they are returned in the padded AlphaID form 'mp-aaaaaaft'. If omitted (or set to any other value), identifiers are returned in their stored form. This is a purely cosmetic transform; query inputs accept either shape regardless.

Response

Search for a ElectronicStructureDoc

Changes

Changed in 3 of the 4 revisions of this API.6

  • 70f72d0670df4See the full diff
    • ○

      added the new optional query request parameter id_format

      new-optional-request-parameter

    • ○

      the api_version response's property default value changed from 0.87.2.dev19+g3f2daf4f8 to 0.87.3.dev3+gfbe8656b6 for the status 200

      response-property-default-value-changed

    • ○

      the emmet_version response's property default value changed from 0.87.1 to 0.87.2 for the status 200

      response-property-default-value-changed

    • ○

      the pymatgen_version response's property default value changed from 2026.5.18 to 2026.8.13 for the status 200

      response-property-default-value-changed

  • 54f2f79ab4f81See the full diff
    • ○

      the api_version response's property default value changed from 0.87.2.dev13+g62063a867 to 0.87.2.dev19+g3f2daf4f8 for the status 200

      response-property-default-value-changed

  • 9aac4fdf40811See the full diff
    • ○

      the api_version response's property default value changed from 0.87.2.dev4+g6bd8ed856 to 0.87.2.dev13+g62063a867 for the status 200

      response-property-default-value-changed