Route providing computed electrode data for a material following the methodology discussed by [Shen *et al.*](https://doi.org/10.1038/s41524-020-00422-3) Note that electrode data has not been calculated for all materials in the Materials Project database. See the `InsertionElectrodeDoc` and `ConversionElectrodeDoc` schema for a full list of fields returned by this route.
openapi: 3.1.0
info:
title: Materials Project Defect Tasks Materials Electrodes 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 Electrodes
description: Route providing computed electrode data for a material following the methodology discussed by [Shen *et al.*](https://doi.org/10.1038/s41524-020-00422-3) Note that electrode data has not been calculated for all materials in the Materials Project database. See the `InsertionElectrodeDoc` and `ConversionElectrodeDoc` schema for a full list of fields returned by this route.
paths:
/materials/insertion_electrodes/:
get:
tags:
- Materials Electrodes
summary: Get InsertionElectrodeDoc documents
operationId: search_materials_insertion_electrodes__get
parameters:
- name: battery_ids
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Comma-separated list of battery_id values to query on
title: Battery Ids
description: Comma-separated list of battery_id values 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: working_ion
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Element of the working ion, or comma-delimited string list of working ion elements.
- name: elements
in: query
required: false
schema:
anyOf:
- type: string
- 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
- 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: num_steps_max
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for maximum value of num_steps
title: Num Steps Max
description: Query for maximum value of num_steps
- name: num_steps_min
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for minimum value of num_steps
title: Num Steps Min
description: Query for minimum value of num_steps
- name: num_steps
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for num_steps being equal to an exact value
title: Num Steps
description: Query for num_steps being equal to an exact value
- name: num_steps_not_eq
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for num_steps being not equal to an exact value
title: Num Steps Not Eq
description: Query for num_steps being not equal to an exact value
- name: num_steps_eq_any
in: query
required: false
schema:
type: string
description: Query for num_steps being any of these values. Provide a comma separated list.
title: Num Steps Eq Any
description: Query for num_steps being any of these values. Provide a comma separated list.
- name: num_steps_neq_any
in: query
required: false
schema:
type: string
description: Query for num_steps being not any of these values. Provide a comma separated list.
title: Num Steps Neq Any
description: Query for num_steps being not any of these values. Provide a comma separated list.
- name: max_voltage_step_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of max_voltage_step
title: Max Voltage Step Max
description: Query for maximum value of max_voltage_step
- name: max_voltage_step_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of max_voltage_step
title: Max Voltage Step Min
description: Query for minimum value of max_voltage_step
- 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: max_delta_volume_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of max_delta_volume
title: Max Delta Volume Max
description: Query for maximum value of max_delta_volume
- name: max_delta_volume_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of max_delta_volume
title: Max Delta Volume Min
description: Query for minimum value of max_delta_volume
- name: average_voltage_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of average_voltage
title: Average Voltage Max
description: Query for maximum value of average_voltage
- name: average_voltage_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of average_voltage
title: Average Voltage Min
description: Query for minimum value of average_voltage
- name: capacity_grav_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of capacity_grav
title: Capacity Grav Max
description: Query for maximum value of capacity_grav
- name: capacity_grav_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of capacity_grav
title: Capacity Grav Min
description: Query for minimum value of capacity_grav
- name: capacity_vol_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of capacity_vol
title: Capacity Vol Max
description: Query for maximum value of capacity_vol
- name: capacity_vol_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of capacity_vol
title: Capacity Vol Min
description: Query for minimum value of capacity_vol
- name: energy_grav_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of energy_grav
title: Energy Grav Max
description: Query for maximum value of energy_grav
- name: energy_grav_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of energy_grav
title: Energy Grav Min
description: Query for minimum value of energy_grav
- name: energy_vol_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of energy_vol
title: Energy Vol Max
description: Query for maximum value of energy_vol
- name: energy_vol_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of energy_vol
title: Energy Vol Min
description: Query for minimum value of energy_vol
- name: fracA_charge_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of fracA_charge
title: Fraca Charge Max
description: Query for maximum value of fracA_charge
- name: fracA_charge_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of fracA_charge
title: Fraca Charge Min
description: Query for minimum value of fracA_charge
- name: fracA_discharge_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of fracA_discharge
title: Fraca Discharge Max
description: Query for maximum value of fracA_discharge
- name: fracA_discharge_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of fracA_discharge
title: Fraca Discharge Min
description: Query for minimum value of fracA_discharge
- name: stability_charge_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of stability_charge
title: Stability Charge Max
description: Query for maximum value of stability_charge
- name: stability_charge_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of stability_charge
title: Stability Charge Min
description: Query for minimum value of stability_charge
- name: stability_discharge_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of stability_discharge
title: Stability Discharge Max
description: Query for maximum value of stability_discharge
- name: stability_discharge_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of stability_discharge
title: Stability Discharge Min
description: Query for minimum value of stability_discharge
- 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 InsertionElectrodeDoc as a list of comma separated strings. Fields include: `builder_meta` `battery_type` `battery_id` `thermo_type` `battery_formula` `working_ion` `num_steps` `max_voltage_step` `last_updated` `framework` `framework_formula` `elements` `nelements` `chemsys` `formula_anonymous` `warnings` `formula_charge` `formula_discharge` `max_delta_volume` `average_voltage` `capacity_grav` `capacity_vol` `energy_grav` `energy_vol` `fracA_charge` `fracA_discharge` `stability_charge` `stability_discharge` `id_charge` `id_discharge` `host_structure` `adj_pairs` `material_ids` `entries_composition_summary` `electrode_object`'
title: ' Fields'
description: 'Fields to project from InsertionElectrodeDoc as a list of comma separated strings. Fields include: `builder_meta` `battery_type` `battery_id` `thermo_type` `battery_formula` `working_ion` `num_steps` `max_voltage_step` `last_updated` `framework` `framework_formula` `elements` `nelements` `chemsys` `formula_anonymous` `warnings` `formula_charge` `formula_discharge` `max_delta_volume` `average_voltage` `capacity_grav` `capacity_vol` `energy_grav` `energy_vol` `fracA_charge` `fracA_discharge` `stability_charge` `stability_discharge` `id_charge` `id_discharge` `host_structure` `adj_pairs` `material_ids` `entries_composition_summary` `electrode_object`'
- name: _all_fields
in: query
required: false
schema:
type: boolean
description: Include all fields.
default: false
title: ' All Fields'
description: Include all fields.
- name: _sort_fields
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Comma delimited fields to sort with. Prefixing '-' to a field will force a sort in descending order.
title: ' Sort Fields'
description: Comma delimited fields to sort with. Prefixing '-' to a field will force a sort in descending order.
responses:
'200':
description: Search for a InsertionElectrodeDoc
content:
application/json:
schema:
$ref: '#/components/schemas/Response_InsertionElectrodeDoc_'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/materials/conversion_electrodes/:
get:
tags:
- Materials Electrodes
summary: Get ConversionElectrodeDoc documents
operationId: search_materials_conversion_electrodes__get
parameters:
- name: battery_ids
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Comma-separated list of battery_id values to query on
title: Battery Ids
description: Comma-separated list of battery_id values to query on
- name: working_ion
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Element of the working ion, or comma-delimited string list of working ion elements.
- name: num_steps_max
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for maximum value of num_steps
title: Num Steps Max
description: Query for maximum value of num_steps
- name: num_steps_min
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for minimum value of num_steps
title: Num Steps Min
description: Query for minimum value of num_steps
- name: num_steps
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for num_steps being equal to an exact value
title: Num Steps
description: Query for num_steps being equal to an exact value
- name: num_steps_not_eq
in: query
required: false
schema:
anyOf:
- type: integer
- type: 'null'
description: Query for num_steps being not equal to an exact value
title: Num Steps Not Eq
description: Query for num_steps being not equal to an exact value
- name: num_steps_eq_any
in: query
required: false
schema:
type: string
description: Query for num_steps being any of these values. Provide a comma separated list.
title: Num Steps Eq Any
description: Query for num_steps being any of these values. Provide a comma separated list.
- name: num_steps_neq_any
in: query
required: false
schema:
type: string
description: Query for num_steps being not any of these values. Provide a comma separated list.
title: Num Steps Neq Any
description: Query for num_steps being not any of these values. Provide a comma separated list.
- name: max_voltage_step_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of max_voltage_step
title: Max Voltage Step Max
description: Query for maximum value of max_voltage_step
- name: max_voltage_step_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of max_voltage_step
title: Max Voltage Step Min
description: Query for minimum value of max_voltage_step
- 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: max_delta_volume_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of max_delta_volume
title: Max Delta Volume Max
description: Query for maximum value of max_delta_volume
- name: max_delta_volume_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of max_delta_volume
title: Max Delta Volume Min
description: Query for minimum value of max_delta_volume
- name: average_voltage_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of average_voltage
title: Average Voltage Max
description: Query for maximum value of average_voltage
- name: average_voltage_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of average_voltage
title: Average Voltage Min
description: Query for minimum value of average_voltage
- name: capacity_grav_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of capacity_grav
title: Capacity Grav Max
description: Query for maximum value of capacity_grav
- name: capacity_grav_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of capacity_grav
title: Capacity Grav Min
description: Query for minimum value of capacity_grav
- name: capacity_vol_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of capacity_vol
title: Capacity Vol Max
description: Query for maximum value of capacity_vol
- name: capacity_vol_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of capacity_vol
title: Capacity Vol Min
description: Query for minimum value of capacity_vol
- name: energy_grav_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of energy_grav
title: Energy Grav Max
description: Query for maximum value of energy_grav
- name: energy_grav_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of energy_grav
title: Energy Grav Min
description: Query for minimum value of energy_grav
- name: energy_vol_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of energy_vol
title: Energy Vol Max
description: Query for maximum value of energy_vol
- name: energy_vol_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of energy_vol
title: Energy Vol Min
description: Query for minimum value of energy_vol
- name: fracA_charge_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of fracA_charge
title: Fraca Charge Max
description: Query for maximum value of fracA_charge
- name: fracA_charge_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of fracA_charge
title: Fraca Charge Min
description: Query for minimum value of fracA_charge
- name: fracA_discharge_max
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for maximum value of fracA_discharge
title: Fraca Discharge Max
description: Query for maximum value of fracA_discharge
- name: fracA_discharge_min
in: query
required: false
schema:
anyOf:
- type: number
- type: 'null'
description: Query for minimum value of fracA_discharge
title: Fraca Discharge Min
description: Query for minimum value of fracA_discharge
- 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:
ty
# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/materials-project/refs/heads/main/openapi/materials-project-materials-electrodes-api-openapi.yml