Route providing computed elasticity data for a material following the methodology discussed by [de Jong *et al.*](https://doi.org/10.1038/sdata.2015.9) Note that elasticity data has not been calculated for all materials in the Materials Project database. See the `ElasticityDoc` schema for a full list of fields returned by this route.
openapi: 3.1.0
info:
title: Materials Project Defect Tasks Materials Elasticity API
description: "\nThe Materials Project API allows anyone to have direct access to current, up-to-date information from the Materials Project database in a structured way.\n\nThis allows for analysis, development of automated tools, machine learning, downloading personal copies of the Materials Project database and more on a large scale.\n\nThe API is offered with the hopes of making Materials Project data more useful to you. We want you to use our data! As such, the API is offered free-of-charge and we support several tools to help you get started.\n\n## API Key\nTo make any request to the Materials Project API, you must use an API key. Your API key is generated for you automatically upon registering with the Materials Project website and is synced with the email you used to register.\n\nRemember to keep your API key safe and to not share it with anyone you do not trust.\n\nIf you are logged in, you can always access your API key from this page or from your [dashboard](https://next-gen.materialsproject.org/dashboard).\n\nIf you intend heavy API usage, you can give us a heads up by sending a message to <heavy.api.use@materialsproject.org>. With the exception of retrieving charge densities, this is not required, but may help us if we see unusual load on our servers.\n\n## Accessing Data\nTo use the API, you have three options:\n\n1. You can use our first-party supported Python client. This is the recommend route. The `mp-api` package containing the client is pip installable.\n\n ```\n pip install mp-api\n ```\n\n The `MPRester` client can be accessed by importing from it. This will ultimately replace the legacy `MPRester` available in pymatgen.\n\n For more details on how to use this, including code examples, please see <https://next-gen.materialsproject.org/api>.\n\n2. You can demo the API interactively on this documentation page. Click the \"Authorize\" button, paste in your API key, and then click the appropriate section to try out a query.\n\n3. Since this is a REST API, and offers a fully-compliant OpenAPI specification, it's possible to use the API with many libraries in many languages and environments, including JavaScript, MATLAB, Mathematica, etc. However, we do not offer first-party support for explaining how to do this, and you will have to follow the specification yourself.\n\n"
version: 0.86.4rc5.dev1+g77c2c1315
x-logo:
url: https://raw.githubusercontent.com/materialsproject/emmet/master/emmet-api/emmet/api/core/assets/mp_logo_small.png
security:
- ApiKeyAuth: []
tags:
- name: Materials Elasticity
description: Route providing computed elasticity data for a material following the methodology discussed by [de Jong *et al.*](https://doi.org/10.1038/sdata.2015.9) Note that elasticity data has not been calculated for all materials in the Materials Project database. See the `ElasticityDoc` schema for a full list of fields returned by this route.
externalDocs:
description: For a more detailed description
url: https://docs.materialsproject.org/methodology/elasticity
paths:
/materials/elasticity/:
get:
tags:
- Materials Elasticity
summary: Get ElasticityDoc documents
operationId: search_materials_elasticity__get
parameters:
- name: material_ids
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Comma-separated list of material_id values to query on
title: Material Ids
description: Comma-separated list of material_id values to query on
- name: chemsys
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: A comma delimited string list of chemical systems.
title: Chemsys
description: A comma delimited string list of chemical systems.
- name: k_voigt_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the Voigt average of the bulk modulus in GPa.
title: K Voigt Max
description: Maximum value for the Voigt average of the bulk modulus in GPa.
- name: k_voigt_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for the Voigt average of the bulk modulus in GPa.
title: K Voigt Min
description: Minimum value for the Voigt average of the bulk modulus in GPa.
- name: k_reuss_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the Reuss average of the bulk modulus in GPa.
title: K Reuss Max
description: Maximum value for the Reuss average of the bulk modulus in GPa.
- name: k_reuss_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for the Reuss average of the bulk modulus in GPa.
title: K Reuss Min
description: Minimum value for the Reuss average of the bulk modulus in GPa.
- name: k_vrh_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the Voigt-Reuss-Hill average of the bulk modulus in GPa.
title: K Vrh Max
description: Maximum value for the Voigt-Reuss-Hill average of the bulk modulus in GPa.
- name: k_vrh_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for the Voigt-Reuss-Hill average of the bulk modulus in GPa.
title: K Vrh Min
description: Minimum value for the Voigt-Reuss-Hill average of the bulk modulus in GPa.
- name: g_voigt_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the Voigt average of the shear modulus in GPa.
title: G Voigt Max
description: Maximum value for the Voigt average of the shear modulus in GPa.
- name: g_voigt_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for the Voigt average of the shear modulus in GPa.
title: G Voigt Min
description: Minimum value for the Voigt average of the shear modulus in GPa.
- name: g_reuss_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the Reuss average of the shear modulus in GPa.
title: G Reuss Max
description: Maximum value for the Reuss average of the shear modulus in GPa.
- name: g_reuss_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for the Reuss average of the shear modulus in GPa.
title: G Reuss Min
description: Minimum value for the Reuss average of the shear modulus in GPa.
- name: g_vrh_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the Voigt-Reuss-Hill average of the shear modulus in GPa.
title: G Vrh Max
description: Maximum value for the Voigt-Reuss-Hill average of the shear modulus in GPa.
- name: g_vrh_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for the Voigt-Reuss-Hill average of the shear modulus in GPa.
title: G Vrh Min
description: Minimum value for the Voigt-Reuss-Hill average of the shear modulus in GPa.
- name: elastic_anisotropy_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the elastic anisotropy.
title: Elastic Anisotropy Max
description: Maximum value for the elastic anisotropy.
- name: elastic_anisotropy_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for the elastic anisotropy.
title: Elastic Anisotropy Min
description: Maximum value for the elastic anisotropy.
- name: poisson_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Maximum value for Poisson's ratio.
title: Poisson Max
description: Maximum value for Poisson's ratio.
- name: poisson_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Minimum value for Poisson's ratio.
title: Poisson Min
description: Minimum value for Poisson's ratio.
- name: _page
in: query
required: false
schema:
type: integer
description: Page number to request (takes precedent over _limit and _skip).
title: ' Page'
description: Page number to request (takes precedent over _limit and _skip).
- name: _per_page
in: query
required: false
schema:
type: integer
description: Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.
default: 100
title: ' Per Page'
description: Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.
- name: _skip
in: query
required: false
schema:
type: integer
description: Number of entries to skip in the search.
default: 0
title: ' Skip'
description: Number of entries to skip in the search.
- name: _limit
in: query
required: false
schema:
type: integer
description: Max number of entries to return in a single query. Limited to 1000.
default: 100
title: ' Limit'
description: Max number of entries to return in a single query. Limited to 1000.
- name: _fields
in: query
required: false
schema:
type: string
description: 'Fields to project from ElasticityDoc 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` `order` `elastic_tensor` `compliance_tensor` `bulk_modulus` `shear_modulus` `sound_velocity` `thermal_conductivity` `young_modulus` `universal_anisotropy` `homogeneous_poisson` `debye_temperature` `fitting_data` `fitting_method` `state`'
title: ' Fields'
description: 'Fields to project from ElasticityDoc 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` `order` `elastic_tensor` `compliance_tensor` `bulk_modulus` `shear_modulus` `sound_velocity` `thermal_conductivity` `young_modulus` `universal_anisotropy` `homogeneous_poisson` `debye_temperature` `fitting_data` `fitting_method` `state`'
- name: _all_fields
in: query
required: false
schema:
type: boolean
description: Include all fields.
default: false
title: ' All Fields'
description: Include all fields.
responses:
'200':
description: Search for a ElasticityDoc
content:
application/json:
schema:
$ref: '#/components/schemas/Response_ElasticityDoc_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
EmmetMeta:
properties:
emmet_version:
anyOf:
- type: string
- type: 'null'
title: Emmet Version
description: The version of emmet this document was built with.
default: 0.86.4rc4
pymatgen_version:
anyOf:
- type: string
- type: 'null'
title: Pymatgen Version
description: The version of pymatgen this document was built with.
default: 2026.4.16
run_id:
anyOf:
- type: string
- type: 'null'
title: Run Id
description: The run id associated with this data build.
batch_id:
anyOf:
- type: string
- type: 'null'
title: Batch Id
description: Identifier corresponding to the origin of this document's blessed task.
database_version:
anyOf:
- type: string
- type: 'null'
title: Database Version
description: The database version for the built data.
build_date:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Build Date
description: The build date for this document.
license:
anyOf:
- type: string
enum:
- BY-C
- BY-NC
- type: 'null'
title: License
description: License for the data entry.
type: object
title: EmmetMeta
description: Default emmet metadata.
TypedAggregateProperitesDict:
properties:
magmom:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Magmom
charge:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Charge
velocities:
anyOf:
- items:
prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
type: array
- type: 'null'
title: Velocities
selective_dynamics:
anyOf:
- items:
prefixItems:
- type: boolean
- type: boolean
- type: boolean
type: array
maxItems: 3
minItems: 3
type: array
- type: 'null'
title: Selective Dynamics
type: object
title: TypedAggregateProperitesDict
ElasticTensorDoc:
properties:
raw:
anyOf:
- prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
type: array
maxItems: 6
minItems: 6
- type: 'null'
title: Raw
description: Elastic tensor corresponding to structure orientation (GPa)
ieee_format:
anyOf:
- prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
type: array
maxItems: 6
minItems: 6
- type: 'null'
title: Ieee Format
description: Elastic tensor corresponding to IEEE orientation (GPa)
type: object
title: ElasticTensorDoc
SoundVelocity:
properties:
transverse:
anyOf:
- type: number
- type: 'null'
title: Transverse
description: Transverse sound velocity (SI units)
longitudinal:
anyOf:
- type: number
- type: 'null'
title: Longitudinal
description: Longitudinal sound velocity (SI units)
snyder_acoustic:
anyOf:
- type: number
- type: 'null'
title: Snyder Acoustic
description: Snyder's acoustic sound velocity (SI units)
snyder_optical:
anyOf:
- type: number
- type: 'null'
title: Snyder Optical
description: Snyder's optical sound velocity (SI units)
snyder_total:
anyOf:
- type: number
- type: 'null'
title: Snyder Total
description: Snyder's total sound velocity (SI units)
type: object
title: SoundVelocity
Meta:
properties:
api_version:
type: string
title: Api Version
description: A string containing the version of the Materials API implementation, e.g. v0.9.5
default: 0.86.4rc5.dev1+g77c2c1315
time_stamp:
type: string
format: date-time
title: Time Stamp
description: A string containing the date and time at which the query was executed
total_doc:
anyOf:
- type: integer
minimum: 0.0
- type: 'null'
title: Total Doc
description: The total number of documents available for this query
facet:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Facet
description: A dictionary containing the facets available for this query
additionalProperties: true
type: object
title: Meta
description: Meta information for the MAPI Response.
TypedSpeciesDict:
properties:
element:
anyOf:
- type: string
- type: 'null'
title: Element
oxidation_state:
anyOf:
- type: number
- type: 'null'
title: Oxidation State
spin:
anyOf:
- type: number
- type: 'null'
title: Spin
occu:
anyOf:
- type: number
- type: 'null'
title: Occu
type: object
title: TypedSpeciesDict
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
TypedSiteDict:
properties:
label:
anyOf:
- type: string
- type: 'null'
title: Label
name:
anyOf:
- type: string
- type: 'null'
title: Name
properties:
anyOf:
- $ref: '#/components/schemas/TypedSiteProperitesDict'
- type: 'null'
species:
anyOf:
- items:
$ref: '#/components/schemas/TypedSpeciesDict'
type: array
- type: 'null'
title: Species
abc:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Abc
xyz:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Xyz
type: object
title: TypedSiteDict
ComplianceTensorDoc:
properties:
raw:
anyOf:
- prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
type: array
maxItems: 6
minItems: 6
- type: 'null'
title: Raw
description: Compliance tensor corresponding to structure orientation (TPa^-1)
ieee_format:
anyOf:
- prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
- prefixItems:
- type: number
- type: number
- type: number
- type: number
- type: number
- type: number
type: array
maxItems: 6
minItems: 6
type: array
maxItems: 6
minItems: 6
- type: 'null'
title: Ieee Format
description: Compliance tensor corresponding to IEEE orientation (TPa^-1)
type: object
title: ComplianceTensorDoc
TypedStructureDict:
properties:
'@module':
type: string
title: '@Module'
'@class':
type: string
title: '@Class'
charge:
anyOf:
- type: number
- type: 'null'
title: Charge
lattice:
$ref: '#/components/schemas/TypedLatticeDict'
sites:
items:
$ref: '#/components/schemas/TypedSiteDict'
type: array
title: Sites
properties:
anyOf:
- $ref: '#/components/schemas/TypedAggregateProperitesDict'
- type: 'null'
type: object
required:
- '@module'
- '@class'
- lattice
- sites
title: TypedStructureDict
ShearModulus:
properties:
voigt:
anyOf:
- type: number
- type: 'null'
title: Voigt
description: Shear modulus Voigt average (GPa)
reuss:
anyOf:
- type: number
- type: 'null'
title: Reuss
description: Shear modulus Reuss average (GPa)
vrh:
anyOf:
- type: number
- type: 'null'
title: Vrh
description: Shear modulus Voigt-Reuss-Hill average (GPa)
type: object
title: ShearModulus
ThermalConductivity:
properties:
clarke:
anyOf:
- type: number
- type: 'null'
title: Clarke
description: Clarke's thermal conductivity (SI units)
cahill:
anyOf:
- type: number
- type: 'null'
title: Cahill
description: Cahill's thermal conductivity (SI units)
type: object
title: ThermalConductivity
Error:
properties:
code:
type: integer
title: Code
description: The error code
message:
type: string
title: Message
description: The description of the error
type: object
required:
- code
- message
title: Error
description: Base Error model for General API.
TypedSiteProperitesDict:
properties:
magmom:
anyOf:
- type: number
- type: 'null'
title: Magmom
charge:
anyOf:
- type: number
- type: 'null'
title: Charge
velocities:
anyOf:
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- type: 'null'
title: Velocities
selective_dynamics:
anyOf:
- prefixItems:
- type: boolean
- type: boolean
- type: boolean
type: array
maxItems: 3
minItems: 3
- type: 'null'
title: Selective Dynamics
coordination_no:
anyOf:
- type: integer
- type: 'null'
title: Coordination No
forces:
anyOf:
- items:
type: number
type: array
- type: 'null'
title: Forces
type: object
title: TypedSiteProperitesDict
FittingData:
properties:
deformations:
items:
prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
type: array
maxItems: 3
minItems: 3
type: array
title: Deformations
description: Deformations corresponding to the strained structures
strains:
items:
prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
type: array
maxItems: 3
minItems: 3
type: array
title: Strains
description: Lagrangian strain tensors applied to structures
cauchy_stresses:
items:
prefixItems:
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- prefixItems:
- type: number
- type: number
- type: number
type: array
maxItems: 3
minItems: 3
- prefixItems:
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/materials-project/refs/heads/main/openapi/materials-project-materials-elasticity-api-openapi.yml