v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials

Get MaterialsDoc documents

get/materials/core/

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

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

task_idsstring nullable

Comma-separated list of task_ids to query on

Comma-separated list of task_ids to query on

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.

deprecatedboolean nullable

Whether the material is marked as deprecated

Whether the material is marked as deprecated

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

_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 MaterialsDoc as a list of comma separated strings. Fields include: 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 initial_structures task_ids deprecated_tasks calc_types created_at task_types run_types entries

Fields to project from MaterialsDoc as a list of comma separated strings. Fields include: 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 initial_structures task_ids deprecated_tasks calc_types created_at task_types run_types entries

_all_fieldsboolean

Include all fields.

Include all fields.

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

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

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

batch_idstring nullable

Query by batch identifier

Query by batch identifier

batch_id_not_eqstring nullable

Exclude batch identifier

Exclude batch identifier

batch_id_eq_anystring nullable

Query by a comma-separated list of batch identifiers

Query by a comma-separated list of batch identifiers

batch_id_neq_anystring nullable

Exclude a comma-separated list of batch identifiers

Exclude a comma-separated list of batch identifiers

Response

Search for a MaterialsDoc