Materials Project Materials Summary API

openapi: 3.1.0
info:
  title: Materials Project Defect Tasks Materials Summary 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 Summary
  description: Route providing a large amount of amalgamated data for a material. This is constructed by             combining subsets of data from many of the other API endpoints. The summary endpoint is very useful for             performing queries for materials over a large property space. Note that every unique material within             the Materials Project should have a set of summary data. See the `SummaryDoc` schema for a full list of             fields returned by this route.
paths:
  /materials/summary/:
    get:
      tags:
      - Materials Summary
      summary: Get SummaryDoc documents
      operationId: search_materials_summary__get
      parameters:
      - name: material_ids
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Comma-separated list of material_ids to query on
          title: Material Ids
        description: Comma-separated list of material_ids to query on
      - name: formula
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Query by formula including anonymized formula or by including wild cards. A comma delimited string list of anonymous formulas or regular formulas can also be provided.
          title: Formula
        description: Query by formula including anonymized formula or by including wild cards. A comma delimited string list of anonymous formulas or regular formulas can also be provided.
      - name: chemsys
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: A comma delimited string list of chemical systems. Wildcards for unknown elements only supported for single chemsys queries
          title: Chemsys
        description: A comma delimited string list of chemical systems. Wildcards for unknown elements only supported for single chemsys queries
      - name: elements
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 60
          - type: 'null'
          description: Query by elements in the material composition as a comma-separated list
          title: Elements
        description: Query by elements in the material composition as a comma-separated list
      - name: exclude_elements
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 60
          - type: 'null'
          description: Query by excluded elements in the material composition as a comma-separated list
          title: Exclude Elements
        description: Query by excluded elements in the material composition as a comma-separated list
      - name: possible_species
        in: query
        required: false
        schema:
          type: string
          description: Comma delimited list of element symbols appended with oxidation states.                 (e.g. Cr2+,O2-)
          title: Possible Species
        description: Comma delimited list of element symbols appended with oxidation states.                 (e.g. Cr2+,O2-)
      - name: crystal_system
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Crystal system of the material. If a comma-separated string, will query by multiple crystal systems.
          title: Crystal System
        description: Crystal system of the material. If a comma-separated string, will query by multiple crystal systems.
      - name: spacegroup_number
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: string
          - type: 'null'
          description: Space group number of the material. If a comma-separated string, will query by multiple space group numbers.
          title: Spacegroup Number
        description: Space group number of the material. If a comma-separated string, will query by multiple space group numbers.
      - name: spacegroup_symbol
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Space group symbol of the material. If a comma-separated string, will query by multiple space group numbers.
          title: Spacegroup Symbol
        description: Space group symbol of the material. If a comma-separated string, will query by multiple space group numbers.
      - name: is_stable
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the material is stable.
          title: Is Stable
        description: Whether the material is stable.
      - name: theoretical
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the material is theoretical.
          title: Theoretical
        description: Whether the material is theoretical.
      - name: ordering
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/Ordering'
          - type: 'null'
          description: Magnetic ordering of the material.
          title: Ordering
        description: Magnetic ordering of the material.
      - name: is_gap_direct
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether a band gap is direct or not.
          title: Is Gap Direct
        description: Whether a band gap is direct or not.
      - name: is_metal
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether the material is considered a metal.
          title: Is Metal
        description: Whether the material is considered a metal.
      - name: nsites_max
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for maximum value of nsites
          title: Nsites Max
        description: Query for maximum value of nsites
      - name: nsites_min
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for minimum value of nsites
          title: Nsites Min
        description: Query for minimum value of nsites
      - name: nsites
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for nsites being equal to an exact value
          title: Nsites
        description: Query for nsites being equal to an exact value
      - name: nsites_not_eq
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for nsites being not equal to an exact value
          title: Nsites Not Eq
        description: Query for nsites being not equal to an exact value
      - name: nsites_eq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for nsites being any of these values. Provide a comma separated list.
          title: Nsites Eq Any
        description: Query for nsites being any of these values. Provide a comma separated list.
      - name: nsites_neq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for nsites being not any of these values.                             Provide a comma separated list.
          title: Nsites Neq Any
        description: Query for nsites being not any of these values.                             Provide a comma separated list.
      - name: nelements_max
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for maximum value of nelements
          title: Nelements Max
        description: Query for maximum value of nelements
      - name: nelements_min
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for minimum value of nelements
          title: Nelements Min
        description: Query for minimum value of nelements
      - name: nelements
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for nelements being equal to an exact value
          title: Nelements
        description: Query for nelements being equal to an exact value
      - name: nelements_not_eq
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for nelements being not equal to an exact value
          title: Nelements Not Eq
        description: Query for nelements being not equal to an exact value
      - name: nelements_eq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for nelements being any of these values. Provide a comma separated list.
          title: Nelements Eq Any
        description: Query for nelements being any of these values. Provide a comma separated list.
      - name: nelements_neq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for nelements being not any of these values.                             Provide a comma separated list.
          title: Nelements Neq Any
        description: Query for nelements being not any of these values.                             Provide a comma separated list.
      - name: volume_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of volume
          title: Volume Max
        description: Query for maximum value of volume
      - name: volume_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of volume
          title: Volume Min
        description: Query for minimum value of volume
      - name: density_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of density
          title: Density Max
        description: Query for maximum value of density
      - name: density_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of density
          title: Density Min
        description: Query for minimum value of density
      - name: density_atomic_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of density_atomic
          title: Density Atomic Max
        description: Query for maximum value of density_atomic
      - name: density_atomic_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of density_atomic
          title: Density Atomic Min
        description: Query for minimum value of density_atomic
      - name: uncorrected_energy_per_atom_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of uncorrected_energy_per_atom
          title: Uncorrected Energy Per Atom Max
        description: Query for maximum value of uncorrected_energy_per_atom
      - name: uncorrected_energy_per_atom_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of uncorrected_energy_per_atom
          title: Uncorrected Energy Per Atom Min
        description: Query for minimum value of uncorrected_energy_per_atom
      - name: energy_per_atom_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of energy_per_atom
          title: Energy Per Atom Max
        description: Query for maximum value of energy_per_atom
      - name: energy_per_atom_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of energy_per_atom
          title: Energy Per Atom Min
        description: Query for minimum value of energy_per_atom
      - name: formation_energy_per_atom_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of formation_energy_per_atom
          title: Formation Energy Per Atom Max
        description: Query for maximum value of formation_energy_per_atom
      - name: formation_energy_per_atom_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of formation_energy_per_atom
          title: Formation Energy Per Atom Min
        description: Query for minimum value of formation_energy_per_atom
      - name: energy_above_hull_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of energy_above_hull
          title: Energy Above Hull Max
        description: Query for maximum value of energy_above_hull
      - name: energy_above_hull_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of energy_above_hull
          title: Energy Above Hull Min
        description: Query for minimum value of energy_above_hull
      - name: equilibrium_reaction_energy_per_atom_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of equilibrium_reaction_energy_per_atom
          title: Equilibrium Reaction Energy Per Atom Max
        description: Query for maximum value of equilibrium_reaction_energy_per_atom
      - name: equilibrium_reaction_energy_per_atom_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of equilibrium_reaction_energy_per_atom
          title: Equilibrium Reaction Energy Per Atom Min
        description: Query for minimum value of equilibrium_reaction_energy_per_atom
      - name: band_gap_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of band_gap
          title: Band Gap Max
        description: Query for maximum value of band_gap
      - name: band_gap_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of band_gap
          title: Band Gap Min
        description: Query for minimum value of band_gap
      - name: cbm_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of cbm
          title: Cbm Max
        description: Query for maximum value of cbm
      - name: cbm_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of cbm
          title: Cbm Min
        description: Query for minimum value of cbm
      - name: vbm_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of vbm
          title: Vbm Max
        description: Query for maximum value of vbm
      - name: vbm_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of vbm
          title: Vbm Min
        description: Query for minimum value of vbm
      - name: efermi_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of efermi
          title: Efermi Max
        description: Query for maximum value of efermi
      - name: efermi_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of efermi
          title: Efermi Min
        description: Query for minimum value of efermi
      - name: dos_energy_up_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of dos_energy_up
          title: Dos Energy Up Max
        description: Query for maximum value of dos_energy_up
      - name: dos_energy_up_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of dos_energy_up
          title: Dos Energy Up Min
        description: Query for minimum value of dos_energy_up
      - name: dos_energy_down_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of dos_energy_down
          title: Dos Energy Down Max
        description: Query for maximum value of dos_energy_down
      - name: dos_energy_down_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of dos_energy_down
          title: Dos Energy Down Min
        description: Query for minimum value of dos_energy_down
      - name: total_magnetization_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of total_magnetization
          title: Total Magnetization Max
        description: Query for maximum value of total_magnetization
      - name: total_magnetization_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of total_magnetization
          title: Total Magnetization Min
        description: Query for minimum value of total_magnetization
      - name: total_magnetization_normalized_vol_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of total_magnetization_normalized_vol
          title: Total Magnetization Normalized Vol Max
        description: Query for maximum value of total_magnetization_normalized_vol
      - name: total_magnetization_normalized_vol_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of total_magnetization_normalized_vol
          title: Total Magnetization Normalized Vol Min
        description: Query for minimum value of total_magnetization_normalized_vol
      - name: total_magnetization_normalized_formula_units_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of total_magnetization_normalized_formula_units
          title: Total Magnetization Normalized Formula Units Max
        description: Query for maximum value of total_magnetization_normalized_formula_units
      - name: total_magnetization_normalized_formula_units_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of total_magnetization_normalized_formula_units
          title: Total Magnetization Normalized Formula Units Min
        description: Query for minimum value of total_magnetization_normalized_formula_units
      - name: num_magnetic_sites_max
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for maximum value of num_magnetic_sites
          title: Num Magnetic Sites Max
        description: Query for maximum value of num_magnetic_sites
      - name: num_magnetic_sites_min
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for minimum value of num_magnetic_sites
          title: Num Magnetic Sites Min
        description: Query for minimum value of num_magnetic_sites
      - name: num_magnetic_sites
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for num_magnetic_sites being equal to an exact value
          title: Num Magnetic Sites
        description: Query for num_magnetic_sites being equal to an exact value
      - name: num_magnetic_sites_not_eq
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for num_magnetic_sites being not equal to an exact value
          title: Num Magnetic Sites Not Eq
        description: Query for num_magnetic_sites being not equal to an exact value
      - name: num_magnetic_sites_eq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for num_magnetic_sites being any of these values. Provide a comma separated list.
          title: Num Magnetic Sites Eq Any
        description: Query for num_magnetic_sites being any of these values. Provide a comma separated list.
      - name: num_magnetic_sites_neq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for num_magnetic_sites being not any of these values.                             Provide a comma separated list.
          title: Num Magnetic Sites Neq Any
        description: Query for num_magnetic_sites being not any of these values.                             Provide a comma separated list.
      - name: num_unique_magnetic_sites_max
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for maximum value of num_unique_magnetic_sites
          title: Num Unique Magnetic Sites Max
        description: Query for maximum value of num_unique_magnetic_sites
      - name: num_unique_magnetic_sites_min
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for minimum value of num_unique_magnetic_sites
          title: Num Unique Magnetic Sites Min
        description: Query for minimum value of num_unique_magnetic_sites
      - name: num_unique_magnetic_sites
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for num_unique_magnetic_sites being equal to an exact value
          title: Num Unique Magnetic Sites
        description: Query for num_unique_magnetic_sites being equal to an exact value
      - name: num_unique_magnetic_sites_not_eq
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Query for num_unique_magnetic_sites being not equal to an exact value
          title: Num Unique Magnetic Sites Not Eq
        description: Query for num_unique_magnetic_sites being not equal to an exact value
      - name: num_unique_magnetic_sites_eq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for num_unique_magnetic_sites being any of these values. Provide a comma separated list.
          title: Num Unique Magnetic Sites Eq Any
        description: Query for num_unique_magnetic_sites being any of these values. Provide a comma separated list.
      - name: num_unique_magnetic_sites_neq_any
        in: query
        required: false
        schema:
          type: string
          description: Query for num_unique_magnetic_sites being not any of these values.                             Provide a comma separated list.
          title: Num Unique Magnetic Sites Neq Any
        description: Query for num_unique_magnetic_sites being not any of these values.                             Provide a comma separated list.
      - name: universal_anisotropy_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of universal_anisotropy
          title: Universal Anisotropy Max
        description: Query for maximum value of universal_anisotropy
      - name: universal_anisotropy_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of universal_anisotropy
          title: Universal Anisotropy Min
        description: Query for minimum value of universal_anisotropy
      - name: homogeneous_poisson_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of homogeneous_poisson
          title: Homogeneous Poisson Max
        description: Query for maximum value of homogeneous_poisson
      - name: homogeneous_poisson_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of homogeneous_poisson
          title: Homogeneous Poisson Min
        description: Query for minimum value of homogeneous_poisson
      - name: e_total_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of e_total
          title: E Total Max
        description: Query for maximum value of e_total
      - name: e_total_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of e_total
          title: E Total Min
        description: Query for minimum value of e_total
      - name: e_ionic_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of e_ionic
          title: E Ionic Max
        description: Query for maximum value of e_ionic
      - name: e_ionic_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of e_ionic
          title: E Ionic Min
        description: Query for minimum value of e_ionic
      - name: e_electronic_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of e_electronic
          title: E Electronic Max
        description: Query for maximum value of e_electronic
      - name: e_electronic_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of e_electronic
          title: E Electronic Min
        description: Query for minimum value of e_electronic
      - name: n_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of n
          title: N Max
        description: Query for maximum value of n
      - name: n_min
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for minimum value of n
          title: N Min
        description: Query for minimum value of n
      - name: e_ij_max_max
        in: query
        required: false
        schema:
          anyOf:
          - type: number
          - type: 'null'
          description: Query for maximum value of e_ij_max
          title: E Ij Max Max
        descrip

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/materials-project/refs/heads/main/openapi/materials-project-materials-summary-api-openapi.yml