v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Provenance

Get ProvenanceDoc documents

get/materials/provenance/

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

deprecatedboolean nullable

Whether the material is marked as deprecated

Whether the material is marked as deprecated

_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 ProvenanceDoc 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 created_at references authors remarks tags theoretical database_IDs history

Fields to project from ProvenanceDoc 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 created_at references authors remarks tags theoretical database_IDs history

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a ProvenanceDoc