v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Oxidation States

Get OxidationStateDoc documents

get/materials/oxidation_states/

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

possible_speciesstring

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

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

_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 OxidationStateDoc 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 possible_species possible_valences average_oxidation_states method

Fields to project from OxidationStateDoc 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 possible_species possible_valences average_oxidation_states method

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