Get SummaryDoc documents

material_idsstring nullable

Comma-separated list of material_id values to query on

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.

chemsysstring nullable

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

exclude_elementsstring nullable

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

possible_speciesstring

Comma delimited list of element symbols appended with oxidation states. (e.g. Cr2+,O2-)

crystal_systemstring nullable

Crystal system of the material. If a comma-separated string, will query by multiple crystal systems.

integer

OR

string

Space group number of the material. If a comma-separated string, will query by multiple space group numbers.

spacegroup_symbolstring nullable

Space group symbol of the material. If a comma-separated string, will query by multiple space group numbers.

is_stableboolean nullable

Whether the material is stable.

theoreticalboolean nullable

Whether the material is theoretical.

ordering'FM' | 'AFM' | 'FiM' | 'NM' | 'Unknown'

Enumeration defining possible magnetic orderings.

Magnetic ordering of the material.

is_gap_directboolean nullable

Whether a band gap is direct or not.

is_metalboolean nullable

Whether the material is considered a metal.

weighted_surface_energy_EV_PER_ANG2_maxnumber nullable

Query for maximum value of weighted_surface_energy_EV_PER_ANG2

weighted_surface_energy_EV_PER_ANG2_minnumber nullable

Query for minimum value of weighted_surface_energy_EV_PER_ANG2

weighted_surface_energy_maxnumber nullable

Query for maximum value of weighted_surface_energy

weighted_surface_energy_minnumber nullable

Query for minimum value of weighted_surface_energy

weighted_work_function_maxnumber nullable

Query for maximum value of weighted_work_function

weighted_work_function_minnumber nullable

Query for minimum value of weighted_work_function

surface_anisotropy_maxnumber nullable

Query for maximum value of surface_anisotropy

surface_anisotropy_minnumber nullable

Query for minimum value of surface_anisotropy

shape_factor_maxnumber nullable

Query for maximum value of shape_factor

shape_factor_minnumber nullable

Query for minimum value of shape_factor

e_ij_max_maxnumber nullable

Query for maximum value of e_ij_max

e_ij_max_minnumber nullable

Query for minimum value of e_ij_max

e_total_maxnumber nullable

Query for maximum value of e_total

e_total_minnumber nullable

Query for minimum value of e_total

e_ionic_maxnumber nullable

Query for maximum value of e_ionic

e_ionic_minnumber nullable

Query for minimum value of e_ionic

e_electronic_maxnumber nullable

Query for maximum value of e_electronic

e_electronic_minnumber nullable

Query for minimum value of e_electronic

n_maxnumber nullable

Query for maximum value of n

n_minnumber nullable

Query for minimum value of n

universal_anisotropy_maxnumber nullable

Query for maximum value of universal_anisotropy

universal_anisotropy_minnumber nullable

Query for minimum value of universal_anisotropy

homogeneous_poisson_maxnumber nullable

Query for maximum value of homogeneous_poisson

homogeneous_poisson_minnumber nullable

Query for minimum value of homogeneous_poisson

total_magnetization_maxnumber nullable

Query for maximum value of total_magnetization

total_magnetization_minnumber nullable

Query for minimum value of total_magnetization

total_magnetization_normalized_vol_maxnumber nullable

Query for maximum value of total_magnetization_normalized_vol

total_magnetization_normalized_vol_minnumber nullable

Query for minimum value of total_magnetization_normalized_vol

total_magnetization_normalized_formula_units_maxnumber nullable

Query for maximum value of total_magnetization_normalized_formula_units

total_magnetization_normalized_formula_units_minnumber nullable

Query for minimum value of total_magnetization_normalized_formula_units

num_magnetic_sites_maxinteger nullable

Query for maximum value of num_magnetic_sites

num_magnetic_sites_mininteger nullable

Query for minimum value of num_magnetic_sites

num_magnetic_sitesinteger nullable

Query for num_magnetic_sites being equal to an exact value

num_magnetic_sites_not_eqinteger nullable

Query for num_magnetic_sites being not equal to an exact value

num_magnetic_sites_eq_anystring

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

num_magnetic_sites_neq_anystring

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

num_unique_magnetic_sites_maxinteger nullable

Query for maximum value of num_unique_magnetic_sites

num_unique_magnetic_sites_mininteger nullable

Query for minimum value of num_unique_magnetic_sites

num_unique_magnetic_sitesinteger nullable

Query for num_unique_magnetic_sites being equal to an exact value

num_unique_magnetic_sites_not_eqinteger nullable

Query for num_unique_magnetic_sites being not equal to an exact value

num_unique_magnetic_sites_eq_anystring

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

num_unique_magnetic_sites_neq_anystring

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

dos_energy_up_maxnumber nullable

Query for maximum value of dos_energy_up

dos_energy_up_minnumber nullable

Query for minimum value of dos_energy_up

dos_energy_down_maxnumber nullable

Query for maximum value of dos_energy_down

dos_energy_down_minnumber nullable

Query for minimum value of dos_energy_down

band_gap_maxnumber nullable

Query for maximum value of band_gap

band_gap_minnumber nullable

Query for minimum value of band_gap

cbm_maxnumber nullable

Query for maximum value of cbm

cbm_minnumber nullable

Query for minimum value of cbm

vbm_maxnumber nullable

Query for maximum value of vbm

vbm_minnumber nullable

Query for minimum value of vbm

efermi_maxnumber nullable

Query for maximum value of efermi

efermi_minnumber nullable

Query for minimum value of efermi

uncorrected_energy_per_atom_maxnumber nullable

Query for maximum value of uncorrected_energy_per_atom

uncorrected_energy_per_atom_minnumber nullable

Query for minimum value of uncorrected_energy_per_atom

energy_per_atom_maxnumber nullable

Query for maximum value of energy_per_atom

energy_per_atom_minnumber nullable

Query for minimum value of energy_per_atom

formation_energy_per_atom_maxnumber nullable

Query for maximum value of formation_energy_per_atom

formation_energy_per_atom_minnumber nullable

Query for minimum value of formation_energy_per_atom

energy_above_hull_maxnumber nullable

Query for maximum value of energy_above_hull

energy_above_hull_minnumber nullable

Query for minimum value of energy_above_hull

equilibrium_reaction_energy_per_atom_maxnumber nullable

Query for maximum value of equilibrium_reaction_energy_per_atom

equilibrium_reaction_energy_per_atom_minnumber nullable

Query for minimum value of equilibrium_reaction_energy_per_atom

nsites_maxinteger nullable

Query for maximum value of nsites

nsites_mininteger nullable

Query for minimum value of nsites

nsitesinteger nullable

Query for nsites being equal to an exact value

nsites_not_eqinteger nullable

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.

nsites_neq_anystring

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

nelements_maxinteger nullable

Query for maximum value of nelements

nelements_mininteger nullable

Query for minimum value of nelements

nelementsinteger nullable

Query for nelements being equal to an exact value

nelements_not_eqinteger nullable

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.

nelements_neq_anystring

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

volume_maxnumber nullable

Query for maximum value of volume

volume_minnumber nullable

Query for minimum value of volume

density_maxnumber nullable

Query for maximum value of density

density_minnumber nullable

Query for minimum value of density

density_atomic_maxnumber nullable

Query for maximum value of density_atomic

density_atomic_minnumber nullable

Query for minimum value of density_atomic

k_voigt_maxnumber nullable

Maximum value for the Voigt average of the bulk modulus in GPa.

k_voigt_minnumber nullable

Minimum value for the Voigt average of the bulk modulus in GPa.

k_reuss_maxnumber nullable

Maximum value for the Reuss average of the bulk modulus in GPa.

k_reuss_minnumber nullable

Minimum value for the Reuss average of the bulk modulus in GPa.

k_vrh_maxnumber nullable

Maximum value for the Voigt-Reuss-Hill average of the bulk modulus in GPa.

k_vrh_minnumber nullable

Minimum value for the Voigt-Reuss-Hill average of the bulk modulus in GPa.

g_voigt_maxnumber nullable

Maximum value for the Voigt average of the shear modulus in GPa.

g_voigt_minnumber nullable

Minimum value for the Voigt average of the shear modulus in GPa.

g_reuss_maxnumber nullable

Maximum value for the Reuss average of the shear modulus in GPa.

g_reuss_minnumber nullable

Minimum value for the Reuss average of the shear modulus in GPa.

g_vrh_maxnumber nullable

Maximum value for the Voigt-Reuss-Hill average of the shear modulus in GPa.

g_vrh_minnumber nullable

Minimum value for the Voigt-Reuss-Hill average of the shear modulus in GPa.

has_reconstructedboolean nullable

Whether an entry or material has a reconstructed surface.

has_propsstring nullable

Comma-delimited list of possible properties given by HasPropsEnum to search for.

deprecatedboolean nullable

Whether the material is marked as deprecated

_pageinteger

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.

_skipinteger

Number of entries to skip in the search.

_limitinteger

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

_fieldsstring

Fields to project from SummaryDoc as a list of comma separated strings. Fields include: prop_origins phonon_IDs theoretical database_IDs possible_species weighted_surface_energy_EV_PER_ANG2 weighted_surface_energy weighted_work_function surface_anisotropy shape_factor has_reconstructed e_ij_max e_total e_ionic e_electronic n bulk_modulus shear_modulus universal_anisotropy homogeneous_poisson is_magnetic ordering total_magnetization total_magnetization_normalized_vol total_magnetization_normalized_formula_units num_magnetic_sites num_unique_magnetic_sites types_of_magnetic_species dos dos_energy_up dos_energy_down bandstructure band_gap cbm vbm efermi is_gap_direct is_metal grain_boundaries xas uncorrected_energy_per_atom energy_per_atom formation_energy_per_atom energy_above_hull is_stable equilibrium_reaction_energy_per_atom decomposes_to 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 task_ids has_props

_all_fieldsboolean

Include all fields.

license'BY-C' | 'BY-NC' | 'All' nullable

Query by license. Can be commercial or non-commercial, or both

_sort_fieldsstring nullable

Comma delimited fields to sort with. Prefixing '-' to a field will force a sort in descending order.

batch_idstring nullable

Query by batch identifier

batch_id_not_eqstring nullable

Exclude batch identifier

batch_id_eq_anystring nullable

Query by a comma-separated list of batch identifiers

batch_id_neq_anystring nullable

Exclude a comma-separated list of batch identifiers

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.

v3

Query parameters

Response