v3

latestOpenAPI 3.1.02026-07-3137169523.4 KB
Materials Bonds

Get BondingDoc documents

get/materials/bonds/

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

max_bond_length_maxnumber nullable

Maximum value for the maximum bond length in the structure.

Maximum value for the maximum bond length in the structure.

max_bond_length_minnumber nullable

Minimum value for the maximum bond length in the structure.

Minimum value for the maximum bond length in the structure.

min_bond_length_maxnumber nullable

Maximum value for the minimum bond length in the structure.

Maximum value for the minimum bond length in the structure.

min_bond_length_minnumber nullable

Minimum value for the minimum bond length in the structure.

Minimum value for the minimum bond length in the structure.

mean_bond_length_maxnumber nullable

Maximum value for the mean bond length in the structure.

Maximum value for the mean bond length in the structure.

mean_bond_length_minnumber nullable

Minimum value for the mean bond length in the structure.

Minimum value for the mean bond length in the structure.

coordination_envsstring nullable

Query by coordination environments in the material composition as a comma-separated list (e.g. 'Mo-S(6),S-Mo(3)')

Query by coordination environments in the material composition as a comma-separated list (e.g. 'Mo-S(6),S-Mo(3)')

coordination_envs_anonymousstring nullable

Query by anonymous coordination environments in the material composition as a comma-separated list (e.g. 'A-B(6),A-B(3)')

Query by anonymous coordination environments in the material composition as a comma-separated list (e.g. 'A-B(6),A-B(3)')

_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 BondingDoc 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 structure_graph method bond_types bond_length_stats coordination_envs coordination_envs_anonymous

Fields to project from BondingDoc 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 structure_graph method bond_types bond_length_stats coordination_envs coordination_envs_anonymous

_all_fieldsboolean

Include all fields.

Include all fields.

Response

Search for a BondingDoc