--- title: "Get PhononBSDOSDoc documents" method: GET path: "/materials/phonon/" tags: ["Materials Phonon"] --- # Get PhononBSDOSDoc documents `GET /materials/phonon/` ## Query parameters - `identifiers` string, nullable — Comma-separated list of phonon_ids to query on - `formula` string, 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. - `chemsys` string, nullable — A comma delimited string list of chemical systems. Wildcards for unknown elements only supported for single chemsys queries - `elements` string, nullable — Query by elements in the material composition as a comma-separated list - `exclude_elements` string, nullable — Query by excluded elements in the material composition as a comma-separated list - `crystal_system` string, nullable — Crystal system of the material. If a comma-separated string, will query by multiple crystal systems. - `spacegroup_number` union — Space group number of the material. If a comma-separated string, will query by multiple space group numbers. - integer - string - `spacegroup_symbol` string, nullable — Space group symbol of the material. If a comma-separated string, will query by multiple space group numbers. - `phonon_method` string — Phonon Method to search for - `nsites_max` integer, nullable — Query for maximum value of nsites - `nsites_min` integer, nullable — Query for minimum value of nsites - `nsites` integer, nullable — Query for nsites being equal to an exact value - `nsites_not_eq` integer, nullable — Query for nsites being not equal to an exact value - `nsites_eq_any` string — Query for nsites being any of these values. Provide a comma separated list. - `nsites_neq_any` string — Query for nsites being not any of these values. Provide a comma separated list. - `nelements_max` integer, nullable — Query for maximum value of nelements - `nelements_min` integer, nullable — Query for minimum value of nelements - `nelements` integer, nullable — Query for nelements being equal to an exact value - `nelements_not_eq` integer, nullable — Query for nelements being not equal to an exact value - `nelements_eq_any` string — Query for nelements being any of these values. Provide a comma separated list. - `nelements_neq_any` string — Query for nelements being not any of these values. Provide a comma separated list. - `volume_max` number, nullable — Query for maximum value of volume - `volume_min` number, nullable — Query for minimum value of volume - `density_max` number, nullable — Query for maximum value of density - `density_min` number, nullable — Query for minimum value of density - `density_atomic_max` number, nullable — Query for maximum value of density_atomic - `density_atomic_min` number, nullable — Query for minimum value of density_atomic - `total_dft_energy_max` number, nullable — Query for maximum value of total_dft_energy - `total_dft_energy_min` number, nullable — Query for minimum value of total_dft_energy - `volume_per_formula_unit_max` number, nullable — Query for maximum value of volume_per_formula_unit - `volume_per_formula_unit_min` number, nullable — Query for minimum value of volume_per_formula_unit - `formula_units_max` integer, nullable — Query for maximum value of formula_units - `formula_units_min` integer, nullable — Query for minimum value of formula_units - `formula_units` integer, nullable — Query for formula_units being equal to an exact value - `formula_units_not_eq` integer, nullable — Query for formula_units being not equal to an exact value - `formula_units_eq_any` string — Query for formula_units being any of these values. Provide a comma separated list. - `formula_units_neq_any` string — Query for formula_units being not any of these values. Provide a comma separated list. - `_page` integer — Page number to request (takes precedent over _limit and _skip). - `_per_page` integer — Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000. - `_skip` integer — Number of entries to skip in the search. - `_limit` integer — Max number of entries to return in a single query. Limited to 1000. - `_fields` string — 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_fields` boolean — Include all fields. - `id_format` string, 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. ## Response `200` Search for a PhononBSDOSDoc - ResponsePhononBSDOSDoc — unresolved $ref ## Other responses - `422` — Validation Error ## Changes > 4 revisions in range; 1 could not be searched. - **2026-07-31** `54f2f79ab4f8` — 1 info - 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` - **2026-07-26** `9aac4fdf4081` — 1 info - 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` [Change history](https://skmtc.dev/materialsproject/apis/materials-project-api/changes/materials/phonon/get.md) --- [API](https://skmtc.dev/materialsproject/apis/materials-project-api.md) · [All operations](https://skmtc.dev/materialsproject/apis/materials-project-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/materialsproject/materials-project-api/revisions/70f72d0670df/schema)