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 . 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 .\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: type: string description: 'Fields to project from ConversionElectrodeDoc 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` `reaction` `initial_comp_formula` `adj_pairs` `electrode_object`' title: ' Fields' description: 'Fields to project from ConversionElectrodeDoc 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` `reaction` `initial_comp_formula` `adj_pairs` `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. responses: '200': description: Search for a ConversionElectrodeDoc content: application/json: schema: $ref: '#/components/schemas/Response_ConversionElectrodeDoc_' '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. Response_ConversionElectrodeDoc_: properties: data: anyOf: - items: $ref: '#/components/schemas/ConversionElectrodeDoc' type: array - type: 'null' title: Data description: List of returned data errors: anyOf: - items: $ref: '#/components/schemas/Error' type: array - type: 'null' title: Errors description: Any errors on processing this query meta: anyOf: - $ref: '#/components/schemas/Meta' - type: 'null' description: Extra information for the query type: object title: Response[ConversionElectrodeDoc] 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 ConversionVoltagePairDoc: properties: formula_charge: anyOf: - type: string - type: 'null' title: Formula Charge description: The chemical formula of the charged material. formula_discharge: anyOf: - type: string - type: 'null' title: Formula Discharge description: The chemical formula of the discharged material. max_delta_volume: anyOf: - type: number - type: 'null' title: Max Delta Volume description: 'Volume changes in % for a particular voltage step using: max(charge, discharge) / min(charge, discharge) - 1.' average_voltage: anyOf: - type: number - type: 'null' title: Average Voltage description: The average voltage in V for a particular voltage step. capacity_grav: anyOf: - type: number - type: 'null' title: Capacity Grav description: Gravimetric capacity in mAh/g. capacity_vol: anyOf: - type: number - type: 'null' title: Capacity Vol description: Volumetric capacity in mAh/cc. energy_grav: anyOf: - type: number - type: 'null' title: Energy Grav description: Gravimetric energy (Specific energy) in Wh/kg. energy_vol: anyOf: - type: number - type: 'null' title: Energy Vol description: Volumetric energy (Energy Density) in Wh/l. fracA_charge: anyOf: - type: number - type: 'null' title: Fraca Charge description: Atomic fraction of the working ion in the charged state. fracA_discharge: anyOf: - type: number - type: 'null' title: Fraca Discharge description: Atomic fraction of the working ion in the discharged state. reaction: anyOf: - $ref: '#/components/schemas/TypedBalancedReactionDict' - type: 'null' title: Reaction description: The reaction that characterizes that particular voltage step. type: object title: ConversionVoltagePairDoc description: Features specific to conversion electrode InsertionElectrodeDoc: properties: builder_meta: anyOf: - $ref: '#/components/schemas/EmmetMeta' - type: 'null' description: Builder metadata. battery_type: anyOf: - type: string - type: 'null' title: Battery Type description: The type of battery (insertion or conversion). battery_id: anyOf: - type: string - type: 'null' title: Battery Id description: The id for this battery document is the numerically smallest material_id followed by the working ion. thermo_type: anyOf: - type: string - type: 'null' title: Thermo Type description: The functional type used to compute the thermodynamics of this electrode document. battery_formula: anyOf: - type: string - type: 'null' title: Battery Formula description: Reduced formula with working ion range produced by combining the charge and discharge formulas. working_ion: anyOf: - type: string - type: 'null' title: Working Ion description: The working ion as an Element object. num_steps: anyOf: - type: integer - type: 'null' title: Num Steps description: The number of distinct voltage steps in from fully charge to discharge based on the stable intermediate states. max_voltage_step: anyOf: - type: number - type: 'null' title: Max Voltage Step description: Maximum absolute difference in adjacent voltage steps. last_updated: type: string format: date-time title: Last Updated description: Timestamp for the most recent calculation for this Material document. framework: anyOf: - additionalProperties: type: number type: object - type: 'null' title: Framework description: The chemical compositions of the host framework. framework_formula: anyOf: - type: string - type: 'null' title: Framework Formula description: The id for this battery document. elements: anyOf: - items: type: string type: array - type: 'null' title: Elements description: The atomic species contained in this electrode (not including the working ion). nelements: anyOf: - type: integer - type: 'null' title: Nelements description: The number of elements in the material (not including the working ion). chemsys: anyOf: - type: string - type: 'null' title: Chemsys description: The chemical system this electrode belongs to (not including the working ion). formula_anonymous: anyOf: - type: string - type: 'null' title: Anonymous Formula description: Anonymized representation of the formula (not including the working ion). warnings: items: type: string type: array title: Warnings description: Any warnings related to this electrode data. default: [] formula_charge: anyOf: - type: string - type: 'null' title: Formula Charge description: The chemical formula of the charged material. formula_discharge: anyOf: - type: string - type: 'null' title: Formula Discharge description: The chemical formula of the discharged material. max_delta_volume: anyOf: - type: number - type: 'null' title: Max Delta Volume description: 'Volume changes in % for a particular voltage step using: max(charge, discharge) / min(charge, discharge) - 1.' average_voltage: anyOf: - type: number - type: 'null' title: Average Voltage description: The average voltage in V for a particular voltage step. capacity_grav: anyOf: - type: number - type: 'null' title: Capacity Grav description: Gravimetric capacity in mAh/g. capacity_vol: anyOf: - type: number - type: 'null' title: Capacity Vol description: Volumetric capacity in mAh/cc. energy_grav: anyOf: - type: number - type: 'null' title: Energy Grav description: Gravimetric energy (Specific energy) in Wh/kg. energy_vol: anyOf: - type: number - type: 'null' title: Energy Vol description: Volumetric energy (Energy Density) in Wh/l. fracA_charge: anyOf: - type: number - type: 'null' title: Fraca Charge description: Atomic fraction of the working ion in the charged state. fracA_discharge: anyOf: - type: number - type: 'null' title: Fraca Discharge description: Atomic fraction of the working ion in the discharged state. stability_charge: anyOf: - type: number - type: 'null' title: Stability Charge description: The energy above hull of the charged material in eV/atom. stability_discharge: anyOf: - type: number - type: 'null' title: Stability Discharge description: The energy above hull of the discharged material in eV/atom. id_charge: anyOf: - type: string pattern: ^([A-Za-z]+-)?(\d+)(-[A-Za-z0-9]+)*$ examples: - mp-3534 - '3453' - mp-834-Ag - type: string examples: - mp-ft - task:pqrs - type: integer - type: 'null' title: Id Charge description: The Materials Project ID of the charged structure. id_discharge: anyOf: - type: string pattern: ^([A-Za-z]+-)?(\d+)(-[A-Za-z0-9]+)*$ examples: - mp-3534 - '3453' - mp-834-Ag - type: string examples: - mp-ft - task:pqrs - type: integer - type: 'null' title: Id Discharge description: The Materials Project ID of the discharged structure. host_structure: anyOf: - $ref: '#/components/schemas/TypedStructureDict' - type: 'null' title: Host Structure description: Host structure (structure without the working ion). adj_pairs: anyOf: - items: $ref: '#/components/schemas/InsertionVoltagePairDoc' type: array - type: 'null' title: Adj Pairs description: Returns all of the voltage steps material pairs. material_ids: anyOf: - items: anyOf: - type: string pattern: ^([A-Za-z]+-)?(\d+)(-[A-Za-z0-9]+)*$ examples: - mp-3534 - '3453' - mp-834-Ag - type: string examples: - mp-ft - task:pqrs type: array - type: 'null' title: Material Ids description: The ids of all structures that matched to the present host lattice, regardless of stability. The stable entries can be found in the adjacent pairs. entries_composition_summary: anyOf: - $ref: '#/components/schemas/EntriesCompositionSummary' - type: 'null' description: Composition summary data for all material in entries across all voltage pairs. electrode_object: anyOf: - additionalProperties: true type: object - type: 'null' title: Electrode Object description: The Pymatgen electrode object. type: object title: InsertionElectrodeDoc description: Insertion electrode 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 Response_InsertionElectrodeDoc_: properties: data: anyOf: - items: $ref: '#/components/schemas/InsertionElectrodeDoc' type: array - type: 'null' title: Data description: List of returned data errors: anyOf: - items: $ref: '#/components/schemas/Error' type: array - type: 'null' title: Errors description: Any errors on processing this query meta: anyOf: - $ref: '#/components/schemas/Meta' - type: 'null' description: Extra information for the query type: object title: Response[InsertionElectrodeDoc] 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 InsertionVoltagePairDoc: properties: formula_charge: anyOf: - type: string - type: 'null' title: Formula Charge description: The chemical formula of the charged material. formula_discharge: anyOf: - type: string - type: 'null' title: Formula Discharge description: The chemical formula of the discharged material. max_delta_volume: anyOf: - type: number - type: 'null' title: Max Delta Volume description: 'Volume changes in % for a particular voltage step using: max(charge, discharge) / min(charge, discharge) - 1.' average_voltage: anyOf: - type: number - type: 'null' title: Average Voltage description: The average voltage in V for a particular voltage step. capacity_grav: anyOf: - type: number - type: 'null' title: Capacity Grav description: Gravimetric capacity in mAh/g. capacity_vol: anyOf: - type: number - type: 'null' title: Capacity Vol description: Volumetric capacity in mAh/cc. energy_grav: anyOf: - type: number - type: 'null' title: Energy Grav description: Gravimetric energy (Specific energy) in Wh/kg. energy_vol: anyOf: - type: number - type: 'null' title: Energy Vol description: Volumetric energy (Energy Density) in Wh/l. fracA_charge: anyOf: - type: number - type: 'null' title: Fraca Charge description: Atomic fraction of the working ion in the charged state. fracA_discharge: anyOf: - type: number - type: 'null' title: Fraca Discharge description: Atomic fraction of the working ion in the discharged state. stability_charge: anyOf: - type: number - type: 'null' title: Stability Charge description: The energy above hull of the charged material in eV/atom. stability_discharge: anyOf: - type: number - type: 'null' title: Stability Discharge description: The energy above hull of the discharged material in eV/atom. id_charge: anyOf: - type: string pattern: ^([A-Za-z]+-)?(\d+)(-[A-Za-z0-9]+)*$ examples: - mp-3534 - '3453' - mp-834-Ag - type: string examples: - mp-ft - task:pqrs - type: integer - type: 'null' title: Id Charge description: The Materials Project ID of the charged structure. id_discharge: anyOf: - type: string pattern: ^([A-Za-z]+-)?(\d+)(-[A-Za-z0-9]+)*$ examples: - mp-3534 - '3453' - mp-834-Ag - type: string examples: - mp-ft - task:pqrs - type: integer - type: 'null' title: Id Discharge description: The Materials Project ID of the discharged structure. type: object title: InsertionVoltagePairDoc description: Features specific to insertion electrode 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 EntriesCompositionSummary: properties: all_formulas: anyOf: - items: type: string type: array - type: 'null' title: All Formulas description: Reduced formulas for material entries across all voltage pairs. all_chemsys: anyOf: - items: type: string type: array - type: 'null' title: All Chemsys description: Chemical systems for material entries across all voltage pairs. all_formula_anonymous: anyOf: - items: type: string type: array - type: 'null' title: All Formula Anonymous description: Anonymous formulas for material entries across all voltage pairs. all_elements: anyOf: - items: anyOf: - type: string - properties: '@class': type: string enum: - Species '@module': type: string enum: - pymatgen.core.periodic_table '@version': type: string type: object required: - '@class' - '@module' - properties: '@class': type: string enum: - DummySpecies '@module': type: string enum: - pymatgen.core.periodic_table '@version': type: string type: object required: - '@class' - '@module' type: array - type: 'null' title: All Elements description: Elements in material entries across all voltage pairs. all_composition_reduced: anyOf: - additionalProperties: items: type: number type: array type: object - type: 'null' title: All Composition Reduced description: Composition reduced data for entries across all voltage pairs. type: object title: EntriesCompositionSummary description: 'Composition summary data for all material entries associated with this electrode. Included to enable better searching via the API.' ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ConversionElectrodeDoc: properties: builder_meta: anyOf: - $ref: '#/components/schemas/EmmetMeta' - type: 'null' description: Builder metadata. battery_type: anyOf: - type: string - type: 'null' title: Battery Type description: The type of battery (insertion or conversion). battery_id: anyOf: - type: string - type: 'null' title: Battery Id description: The id for this battery document is the numerically smallest material_id followed by the working ion. thermo_type: anyOf: - type: string - type: 'null' title: Thermo Type description: The functional type used to compute the thermodynamics of this electrode document. battery_formula: anyOf: - type: string - type: 'null' title: Battery Formula description: Reduced formula with working ion range produced by combining the charge and discharge formulas. working_ion: anyOf: - type: string - type: 'null' title: Working Ion description: The working ion as an Element object. num_steps: anyOf: - type: integer - type: 'null' title: Num Steps description: The number of distinct voltage steps in from fully charge to discharge based on the stable intermediate states. max_voltage_step: anyOf: - type: number - type: 'null' title: Max Voltage Step description: Maximum absolute difference in adjacent voltage steps. last_updated: type: string format: date-time title: Last Updated description: Timestamp for the most recent calculation for this Material document. framework: anyOf: - additionalProperties: type: number type: object - type: 'null' title: Framework description: The chemical compositions of the host framework. framework_formula: anyOf: - type: string - type: 'null' title: Framework Formula description: The id for this battery document. elements: anyOf: - items: type: string type: array - type: 'null' title: Elements description: The atomic species contained in this electrode (not including the working ion). nelements: anyOf: - type: integer - type: 'null' title: Nelements description: The number of elements in the material (not including the working ion). chemsys: anyOf: - type: string - type: 'null' title: Chemsys description: The chemical system this electrode belongs to (not including the working ion). formula_anonymous: anyOf: - type: string - type: 'null' title: Anonymous Formula description: Anonymized representation of the formula (not including the working ion). warnings: items: type: string type: array title: Warnings description: Any warnings related to this electrode data. default: [] formula_charge: anyOf: - type: string - type: 'null' title: Formula Charge description: The chemical formula of the charged material. formula_discharge: anyOf: - type: string - type: 'null' title: Formula Discharge description: The chemical formula of the discharged material. max_delta_volume: anyOf: - type: number - type: 'null' title: Max Delta Volume description: 'Volume changes in % for a particular voltage step using: max(charge, discharge) / min(charge, discharge) - 1.' average_voltage: anyOf: - type: number - type: 'null' title: Average Voltage description: The average voltage in V for a particular voltage step. capacity_grav: anyOf: - type: number - type: 'null' title: Capacity Grav description: Gravimetric capacity in mAh/g. capacity_vol: anyOf: - type: number - type: 'null' title: Capacity Vol description: Volumetric capacity in mAh/cc. energy_grav: anyOf: - type: number - type: 'null' title: Energy Grav description: Gravimetric energy (Specific energy) in Wh/kg. energy_vol: anyOf: - type: number - type: 'null' title: Energy Vol description: Volumetric energy (Energy Density) in Wh/l. fracA_charge: anyOf: - type: number - type: 'null' title: Fraca Charge description: Atomic fraction of the working ion in the charged state. fracA_discharge: anyOf: - type: number - type: 'null' title: Fraca Discharge description: Atomic fraction of the working ion in the discharged state. reaction: anyOf: - $ref: '#/components/schemas/TypedBalancedReactionDict' - type: 'null' title: Reaction description: The reaction that characterizes that particular voltage step. initial_comp_formula: anyOf: - type: string - type: 'null' title: Initial Comp Formula description: The starting composition for the ConversionElectrode represented as a string/formula. adj_pairs: anyOf: - items: $ref: '#/components/schemas/ConversionVoltagePairDoc' type: array - type: 'null' title: Adj Pairs description: Returns all of the voltage steps material pairs. electrode_object: anyOf: - additionalProperties: true type: object - type: 'null' title: Electrode Object description: The Pymatgen conversion electrode object. type: object title: ConversionElectrodeDoc description: Conversion electrode TypedLatticeDict: properties: matrix: items: items: type: number type: array type: array title: Matrix pbc: anyOf: - prefixItems: - type: boolean - type: boolean - type: boolean type: array maxItems: 3 minItems: 3 - type: 'null' title: Pbc a: type: number title: A b: type: number title: B c: type: number title: C alpha: type: number title: Alpha beta: type: number title: Beta gamma: type: number title: Gamma volume: type: number title: Volume type: object required: - matrix - a - b - c - alpha - beta - gamma - volume title: TypedLatticeDict TypedBalancedReactionDict: properties: '@module': type: string title: '@Module' '@class': type: string title: '@Class' reactants: additionalProperties: type: number type: object title: Reactants products: additionalProperties: type: number type: object title: Products type: object required: - '@module' - '@class' - reactants - products title: TypedBalancedReactionDict securitySchemes: ApiKeyAuth: descriptions: MP API key to authorize requests name: X-API-KEY in: header type: apiKey