Materials Phonon

Get PhononBSDOSDoc documents

get/materials/phonon/

Query parameters

identifiersstring nullable

Comma-separated list of phonon_ids to query on

Comma-separated list of phonon_ids 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.

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

crystal_systemstring nullable

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

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.

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

phonon_methodstring

Phonon Method to search for

Phonon Method to search for

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

total_dft_energy_maxnumber nullable

Query for maximum value of total_dft_energy

Query for maximum value of total_dft_energy

total_dft_energy_minnumber nullable

Query for minimum value of total_dft_energy

Query for minimum value of total_dft_energy

volume_per_formula_unit_maxnumber nullable

Query for maximum value of volume_per_formula_unit

Query for maximum value of volume_per_formula_unit

volume_per_formula_unit_minnumber nullable

Query for minimum value of volume_per_formula_unit

Query for minimum value of volume_per_formula_unit

formula_units_maxinteger nullable

Query for maximum value of formula_units

Query for maximum value of formula_units

formula_units_mininteger nullable

Query for minimum value of formula_units

Query for minimum value of formula_units

formula_unitsinteger nullable

Query for formula_units being equal to an exact value

Query for formula_units being equal to an exact value

formula_units_not_eqinteger nullable

Query for formula_units being not equal to an exact value

Query for formula_units being not equal to an exact value

formula_units_eq_anystring

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

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

formula_units_neq_anystring

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

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

_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 PhononBSDOSDoc as a list of comma separated strings. Fields include: nsites elements nelements composition composition_reduced formula_pretty formula_anonymous chemsys volume density density_atomic symmetry identifier phonon_method epsilon_static epsilon_electronic born last_updated sum_rules_breaking structure total_dft_energy volume_per_formula_unit formula_units supercell_matrix primitive_matrix code post_process_settings thermal_displacement_data calc_meta phonon_bandstructure phonon_dos force_constants

Fields to project from PhononBSDOSDoc as a list of comma separated strings. Fields include: nsites elements nelements composition composition_reduced formula_pretty formula_anonymous chemsys volume density density_atomic symmetry identifier phonon_method epsilon_static epsilon_electronic born last_updated sum_rules_breaking structure total_dft_energy volume_per_formula_unit formula_units supercell_matrix primitive_matrix code post_process_settings thermal_displacement_data calc_meta phonon_bandstructure phonon_dos force_constants

_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 PhononBSDOSDoc

ResponsePhononBSDOSDoc required— unresolved $ref

Changes