v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Chemical Environment

Get ChemEnvDoc documents

get/materials/chemenv/

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

chemenv_iucrstring nullable

A comma delimited string list of unique (cationic) species in IUCR format.

A comma delimited string list of unique (cationic) species in IUCR format.

chemenv_iupacstring nullable

A comma delimited string list of unique (cationic) species in IUPAC format.

A comma delimited string list of unique (cationic) species in IUPAC format.

chemenv_namestring nullable

A comma delimited string list of coordination environment descriptions for unique (cationic) species.

A comma delimited string list of coordination environment descriptions for unique (cationic) species.

chemenv_symbolstring nullable

A comma delimited string list of ChemEnv symbols for unique (cationic) species in the structure.

A comma delimited string list of ChemEnv symbols for unique (cationic) species in the structure.

speciesstring nullable

A comma delimited string list of unique (cationic) species in the structure.

A comma delimited string list of unique (cationic) species in the structure.

csm_minnumber nullable

Minimum value of the continous symmetry measure for any site.

Minimum value of the continous symmetry measure for any site.

csm_maxnumber nullable

Maximum value of the continous symmetry measure for any site.

Maximum value of the continous symmetry measure for any site.

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

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 ChemEnvDoc 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 property_name valences species chemenv_symbol chemenv_iupac chemenv_iucr chemenv_name chemenv_name_with_alternatives csm method mol_from_site_environments wyckoff_positions

Fields to project from ChemEnvDoc 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 property_name valences species chemenv_symbol chemenv_iupac chemenv_iucr chemenv_name chemenv_name_with_alternatives csm method mol_from_site_environments wyckoff_positions

_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

Response

Search for a ChemEnvDoc