v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Magnetism

Get MagnetismDoc documents

get/materials/magnetism/

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

ordering'FM' | 'AFM' | 'FiM' | 'NM' | 'Unknown'

Enumeration defining possible magnetic orderings.

Magnetic ordering of the material.

total_magnetization_maxnumber nullable

Maximum value for the total magnetization.

Maximum value for the total magnetization.

total_magnetization_minnumber nullable

Minimum value for the total magnetization.

Minimum value for the total magnetization.

total_magnetization_normalized_vol_maxnumber nullable

Maximum value for the total magnetization normalized with volume.

Maximum value for the total magnetization normalized with volume.

total_magnetization_normalized_vol_minnumber nullable

Minimum value for the total magnetization normalized with volume.

Minimum value for the total magnetization normalized with volume.

total_magnetization_normalized_formula_units_maxnumber nullable

Maximum value for the total magnetization normalized with formula units.

Maximum value for the total magnetization normalized with formula units.

total_magnetization_normalized_formula_units_minnumber nullable

Minimum value for the total magnetization normalized with formula units.

Minimum value for the total magnetization normalized with formula units.

num_magnetic_sites_maxinteger nullable

Maximum value for the total number of magnetic sites.

Maximum value for the total number of magnetic sites.

num_magnetic_sites_mininteger nullable

Minimum value for the total number of magnetic sites.

Minimum value for the total number of magnetic sites.

num_unique_magnetic_sites_maxinteger nullable

Maximum value for the total number of unique magnetic sites.

Maximum value for the total number of unique magnetic sites.

num_unique_magnetic_sites_mininteger nullable

Minimum value for the total number of unique magnetic sites.

Minimum value for the total number of unique magnetic sites.

_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 MagnetismDoc 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 ordering is_magnetic exchange_symmetry num_magnetic_sites num_unique_magnetic_sites types_of_magnetic_species magmoms total_magnetization total_magnetization_normalized_vol total_magnetization_normalized_formula_units

Fields to project from MagnetismDoc 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 ordering is_magnetic exchange_symmetry num_magnetic_sites num_unique_magnetic_sites types_of_magnetic_species magmoms total_magnetization total_magnetization_normalized_vol total_magnetization_normalized_formula_units

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a MagnetismDoc