Sign in
Materials Similarity

Get SimilarityDoc documents

get/materials/similarity/

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

_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 SimilarityDoc 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 sim feature_vector method

Fields to project from SimilarityDoc 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 sim feature_vector method

_all_fieldsboolean

Include all fields.

Include all fields.

id_formatstring nullable

Optional. If set to 'legacy', MP identifier fields in the response are returned in the form 'mp-149'. If set to 'alpha', they are returned in the padded AlphaID form 'mp-aaaaaaft'. If omitted (or set to any other value), identifiers are returned in their stored form. This is a purely cosmetic transform; query inputs accept either shape regardless.

Optional. If set to 'legacy', MP identifier fields in the response are returned in the form 'mp-149'. If set to 'alpha', they are returned in the padded AlphaID form 'mp-aaaaaaft'. If omitted (or set to any other value), identifiers are returned in their stored form. This is a purely cosmetic transform; query inputs accept either shape regardless.

Response

Search for a SimilarityDoc

Changes

Changed in 3 of the 4 revisions of this API.6

  • 70f72d0670df4See the full diff
    • ○

      added the new optional query request parameter id_format

      new-optional-request-parameter

    • ○

      the api_version response's property default value changed from 0.87.2.dev19+g3f2daf4f8 to 0.87.3.dev3+gfbe8656b6 for the status 200

      response-property-default-value-changed

    • ○

      the emmet_version response's property default value changed from 0.87.1 to 0.87.2 for the status 200

      response-property-default-value-changed

    • ○

      the pymatgen_version response's property default value changed from 2026.5.18 to 2026.8.13 for the status 200

      response-property-default-value-changed

  • 54f2f79ab4f81See the full diff
    • ○

      the api_version response's property default value changed from 0.87.2.dev13+g62063a867 to 0.87.2.dev19+g3f2daf4f8 for the status 200

      response-property-default-value-changed

  • 9aac4fdf40811See the full diff
    • ○

      the api_version response's property default value changed from 0.87.2.dev4+g6bd8ed856 to 0.87.2.dev13+g62063a867 for the status 200

      response-property-default-value-changed