Skip to main content

Thank you for visiting nature.com. You are using a browser version with limited support for CSS. To obtain the best experience, we recommend you use a more up to date browser (or turn off compatibility mode in Internet Explorer). In the meantime, to ensure continued support, we are displaying the site without styles and JavaScript.

OPTIMADE, an API for exchanging materials data

Abstract

The Open Databases Integration for Materials Design (OPTIMADE) consortium has designed a universal application programming interface (API) to make materials databases accessible and interoperable. We outline the first stable release of the specification, v1.0, which is already supported by many leading databases and several software packages. We illustrate the advantages of the OPTIMADE API through worked examples on each of the public materials databases that support the full API specification.

Introduction

Data has become a crucial resource in many scientific fields, and materials science is no exception. Experimental data has long been meticulously curated in handbooks and databases, with the first edition of Landolt-Börnstein1 being published in 1883. Nowadays, various commercial and non-commercial experimental databases, such as the Inorganic Crystal Structure Database (ICSD)2, are widely used throughout the field.

High-throughput electronic structure calculations, themselves enabled by algorithmic improvements and growing computational resources, have significantly increased the availability of useful data from computational simulations of materials. Since the pioneering work of Ceder et al.3, a large number of high-throughput first-principles studies have been reported in the literature (for a review, see ref. 4), with results typically collated in databases. This explosion in the amount of available data has kick-started a new paradigm of data-driven materials science5, creating opportunities for concurrent, automated materials design, boosted by databases that can be queried by humans and machines via an application programming interface (API)6,7,8,9.

As materials databases differ in fidelity and focus across material classes and properties, it is extremely beneficial to be able to liberate and unify data from multiple sources. However, retrieving data from multiple databases is difficult as each database has its own specialized, and sometimes esoteric, API that governs data access patterns, querying and the representation of the underlying data. Moreover, as the APIs of individual databases inevitably evolve, existing clients must also evolve; a significant maintenance effort is required to translate the responses from the new API to the representation of the client.

Motivated by these considerations, providers of several materials databases united to design and implement an API specification that enables seamless access and interoperability across materials databases. The effort started at the workshop “Open Databases Integration for Materials Design”, held at the Lorentz Center in Leiden, Netherlands in October 2016, and continued at followup workshops held at CECAM in Lausanne, Switzerland in June 2018, June 2019, and June 2020. The result is the OPTIMADE specification (v1.0)10; OPTIMADE defines a RESTful API that is queried with URLs, with responses adhering to the JSON:API specification11. Specification development adheres to Semantic Versioning12 to avoid surprises and enable backwards-compatibility where possible, without impeding further development. By extracting the technical and scientific commonalities from existing APIs, the OPTIMADE API has been designed so that it can be implemented across a broad range of materials domains, database back-ends and sizes.

In this paper, we first review the query format of existing databases to motivate the design and construction of the OPTIMADE API specification. We then illustrate the use of the API with a set of worked examples; databases that already fully support the OPTIMADE API are enumerated alongside their results for representative queries in Table 1. We further highlight libraries that could accelerate uptake and assist materials data curators to support the OPTIMADE API format. Finally, we discuss future prospects and ongoing development of the OPTIMADE API.

Table 1 Materials databases with active OPTIMADE API implementations and the number of entries they return for the filters presented in this paper.

Current Generation of Materials Database APIs

Materials databases are a veritable treasure trove of information, but they only become useful once a human, or machine, can access them. In this section we review the current range of APIs used by various databases to enable access to an example compound, SiO2, which serves to highlight the variation of APIs that a user must navigate in order to make use of multiple materials databases. We then demonstrate the universal nature of the OPTIMADE API that permits seamless access to all materials databases that support it.

We first compare and contrast the APIs that must be used to request records on an exemplar system, SiO2, from three different databases: AFLOW, the Materials Project, and the Crystallographic Open Database (COD). All three queried databases support requests using a representational state transfer through a web service (RESTful), at the following URLs:

AFLOW      http://aflow.org/API/aflux/?species(Si,O),nspecies(2)

Materials Project    https://www.materialsproject.org/rest/v2/materials/SiO2/vasp/structure

COD       https://www.crystallography.net/cod/result.php?formula=O2%20Si

Note that the Materials Project requires the user to supply an API key (http://materialsproject.org/open) preferably specified in the X-API-KEY HTTP header.

The three APIs vary syntactically (in format), taxonomically (having different names for terms), and semantically (in the conflicting definitions of chemical formula as an intensive or extensive property). AFLOW returns all structures with both Si and O present, whereas both the Materials Project and COD deliver any structure with a formula unit of SiO2. The wide range of query formats that will deliver non-overlapping structures significantly complicates access to all available data for SiO2, without even considering the differing representations of the structures returned.

The inconsistent format of the query is further complicated by the difficulty of accessing other structures with the SiO2 formula. Focusing on just AFLOW, two possible queries that users more familiar with the other APIs might attempt are

http://aflow.org/API/aflux/?compound(SiO2)

which returns no response;

http://aflow.org/API/aflux/?compound(O2Si1)

now lists the elements in alphabetical order as required by AFLOW, and includes the “1” after element symbols, so that “SiO2” becomes “O2Si1”. This returns entries where the unit cell is SiO2, but does not return Si2O4 or simulation cells containing more formula units.

The exemplar http://aflow.org/API/aflux/?species(Si,O),nspecies(2) returns all entries with at least one Si and an O, so while the response includes the SiO2 phases of interest, it may also contain other stoichiometries.

The distinctions between the request format for each database require the user to become an expert in many different APIs. This again emphasises the need for a single well-designed and standardized API to access all materials databases, which is the aim of the OPTIMADE API.

The OPTIMADE API

The OPTIMADE API provides a holistic standard for serving and accessing the information in compatible materials databases. To retrieve information about materials from a particular database, the user submits a request via a URL. Each database provider will have published a base URL that serves the OPTIMADE API, for example https://example.com/optimade/. The same URL path, across different OPTIMADE API implementations, allows uniform access to the underlying databases. Both human-readable and machine-readable versions of the OPTIMADE API specification are available online with releases archived at Zenodo10. The specification is also registered as an API standard on FAIRsharing.org13.

Design philosophy

The OPTIMADE specification strives to enable materials information to be filtered and retrieved in a straightforward and intuitive manner. The three queries from the previous section can each be performed on a standardised, versioned endpoint (/v1/structures) that enables access to a structures entry resource type that consists of many well-defined attributes. The specification then defines a grammar for filtering entries against these attributes, allowing the previous SiO2 f ilter example to be expressed in a common way (?filter=chemical_formula_reduced="O2Si"). Altogether, the universal OPTIMADE URL, where only the implementation URL changes, becomes:

<optimade_implementation_url>/v1/structures?filter=chemical_formula_reduced="O2Si"

The OPTIMADE specification also aims to be flexible to many different underlying data representations, and thus there are very few properties that are mandatory. Instead of enforcing an exhaustive set of property definitions, individual OPTIMADE implementations can describe the data they serve via /info endpoints for each entry type. These introspective endpoints allow clients to adapt to the particular implementation for an underlying database, and allow providers to disseminate properties beyond the simple structural and chemical information standardized by the specification. To avoid naming collisions, each provider-specific property name must be prefixed by a provider-specific token, itself bookended by underscores (_). The property custom_property from an example provider with assigned prefix exmpl would be expressed as _exmpl_custom_property: e.g., _tcod_a for the lattice constant, a, in TCOD, or _aflow_spacegroup_relax for the space group of the relaxed structure in AFLOW.

Implementation discovery

The list of implementations confirmed and tested in this paper to support the OPTIMADE API is shown in Table 1. They are all publicly accessible, providing users with open access to large international repositories of computational and experimental materials science data.

The OPTIMADE consortium provides an open, federated list of implementations (https://providers.optimade.org). It is considered to be a catalogue of currently available and/or known public OPTIMADE implementations. New implementations are welcome and can register themselves via a pull request on GitHub (https://github.com/Materials-Consortia/providers).

The requirements for appearing in the above providers list are very loose. Some databases listed in the catalogue are signalling the intent of future implementations, while others only have partial implementations of the OPTIMADE API, including JARVIS (https://jarvis.nist.gov/optimade)14 and MatCloud (https://matcloud.com.cn)15. Some software frameworks, such as AiiDA16,17,18, also enable users to access their personal data through an OPTIMADE API, and therefore have a dedicated provider-specific ID, but no single official OPTIMADE implementation base URL.

The OPTIMADE API also specifies an endpoint for semi-automated cross-provider discovery. The /links endpoint serves links resources that may refer to either provider internal (child, root) or external (external, providers) resources based on the link_type attribute. To avoid being overly restrictive, it is at the provider’s discretion whether they serve a list of known providers; however, this provides a mechanism for scalable and decentralised discovery of new implementations beyond the federated provider list.

Worked Example

To illustrate the effective use of the OPTIMADE API we now provide a worked example of querying structures. We explore materials containing Group 14 elements (the carbon family), starting with a general search before drilling down to specific materials. The Group 14 elements are of particular interest as their atomic orbitals regularly hybridise, enabling a variety of bonding with differing geometries. The hybridised orbitals enable these elements to form the backbone of a wide range of compounds, both inorganic and organic, that underpin plastics, drugs, and semiconductors. Group 14 therefore forms both a diverse and important family of compounds that heavily populates databases, so are an ideal case study to demonstrate the OPTIMADE API.

Common features of the response

Whilst our previous exploration of the Group 14 compounds considered only SiO2, the flexibility of the OPTIMADE API allows us to start with a search over all materials in Group 14, comprising carbon (C), silicon (Si), germanium (Ge), tin (Sn), and lead (Pb). We start with a simple API call that searches for all materials that contain at least one element in Group 14:

/v1/structures?filter=elements HAS ANY "C", "Si", "Ge", "Sn", "Pb"

This string can be appended to the base URL of any of the available implementations, to gather results in a standardised form. The base URL can be found on the providers dashboard (https://www.optimade.org/providers-dashboard).

As an example, this query is run through the Theoretical Crystallography Open Database (TCOD)19 with the following URL:

https://www.crystallography.net/tcod/optimade/v1/structures?filter=elements+HAS+ANY+"C","Si","Ge","Sn","Pb"

The JSON response is summarized in Boxes 1 through 5, where some lines have been omitted for brevity; the full response is given in Supplementary File 1.

The first tranche of the JSON response comprises the “data” field that contains a list of entries returned for the query; a truncated version of this field is shown in Box 1, displaying a few salient properties of just one of the ten entries from the full response. The response for a particular material entry comprises multiple sections:

attributes. Box 1 shows the physical properties of the material comprising both mandatory information such as elements and lattice_vectors, as well as optional, additional database-specific information prefixed with the database name (e.g., _tcod_, here used to provide lattice parameters). This ensures that all databases return the most important and common information in a standardized format, as well as allowing them to include additional database-specific data. Importantly, the OPTIMADE specification provides a standardized way for database implementations to be self-documenting, via introspective /info endpoints. We see in the elements section that here we have returned a material comprising the element of interest, Sn, as well as O and Ta.

id and links. Box 2 shows the unique ID for the entry within the database, and a self-link to the database-specific representation/rendering of the entry (in this case, a link to a Crystallographic Information File20).

relationships. The relationships section in Box 3 links the user to other entries in the database and beyond, here the bibliographic references.

The additional nine materials not shown here all comprised of compounds containing either C, Si, Ge, Sn, or Pb, supplemented by a variety of other elements. The foot of the response contains information about the underlying database, comprised of three sections:

links. The response returned the first ten (i.e., the default page limit) entries that matched the query, however, more materials are available within the database. Box 4 shows the JSON:API-compliant pagination links to the current and next page of results for this query, as well as relevant external links.

meta. Box 5 provides metadata associated with the request, such as number of results, the details of the database provider, the implementation and the representation and timestamp of the submitted query.

A benefit of the OPTIMADE API is that the structure of the response is common to all materials databases. The responses differ only in the optional and database-specific information prefixed with the database name (here _tcod_). Table 1 lists several materials databases that have active OPTIMADE API implementations, and the large number of results (N1) that they return for this particular filter.

Database filtering

Requesting the example filter above from the TCOD database returns 2,631 materials entries, but the same filter could return millions (see Table 1). For some requests the volume of the materials data could become unmanageable so the specification allows for the use of several pagination methods laid out by JSON:API11. These approaches all provide a link to the “next” page of data:

/v1/structures?page_limit=10&page_offset=10&filter=elements HAS ANY "C", "Si", "Ge", "Sn", "Pb"

with parameter page_offset = 10 to allow the user to select which page to enter, and the parameter page_limit = 10 to control the number of materials returned per individual request.

The most useful way to explore an OPTIMADE database is to apply a filter; the specification mandates that several relevant properties must be queryable. For example, we can perform a more focused search for materials comprising at least one element in Group 14, and a maximum of two elements (a binary material), with the filter

/v1/structures?filter=elements HAS ANY "C", "Si", "Ge", "Sn", "Pb" AND nelements=2

This query returns 296 materials from the TCOD database, with the response summarized in Box 6, where some lines have been omitted for brevity and the full response is given in the Supplementary File 2. The number of matching entries (N2) across all implementations for this filter are shown in Table 1.

We can now see that the first structure, and indeed all structures, returned are comprised of at least one element in Group 14, here Ge, and a maximum of one other element (a binary material), here O. Additional filters can be chained to further refine the materials returned, or to construct more complex queries. For example, ternary structures that contain at least one of the elements C, Si, Ge, or Sn, but do not contain Pb (e.g., for applications where Pb toxicity would be a concern), can be retrieved using the filter

/v1/structures?filter=elements HAS ANY "C", "Si", "Ge", "Sn" AND NOT elements HAS "Pb" AND elements LENGTH 3

The number of entries matching this filter are denoted as N3 in Table 1.

These simple examples demonstrate how useful chemical queries are expressible with the OPTIMADE API, allowing users to refine their queries and to suit their specific application. Further functionality of the OPTIMADE API can be found in the specification10.

Related Libraries

The wider usage of the OPTIMADE API is a key goal for the consortium; to this end, several open source libraries have been developed to help users of the OPTIMADE API (either implementation developers, or client end-users), of which three are introduced below. The first two libraries offer tools that aid the implementation of the API for materials database developers, with the first also containing tools to construct and validate queries, while the third library is intended for end users of OPTIMADE-compliant APIs.

optimade-python-tools

optimade-python-tools is an open source Python package available on GitHub (https://github.com/Materials-Consortia/optimade-python-tools). The package contains a complete set of tools for implementing an OPTIMADE-compliant API, as well as several utilities that can be used by client code. The package is listed on the Python Package Index (PyPI) as optimade (https://pypi.org/project/optimade). Current (v0.14) functionality of the package includes:

OPTIMADE::Filter

OPTIMADE::Filter is a Perl library for the syntactical analysis of the OPTIMADE filter language. Apart from the construction of abstract syntax trees, the library can translate simple filter strings to SQL queries. The Git repository with the source code is publicly available on GitHub (https://github.com/Materials-Consortia/OPTIMADE-Filter).

pymatgen optimade module

pymatgen24 (https://pymatgen.org) is a Python library for materials science. A user-friendly OptimadeRester client has been added to a new OPTIMADE module within pymatgen to provide a way to query OPTIMADE structure resources in a way familiar to existing users of pymatgen and the Materials Project API. The Git repository with the source code is publicly available on GitHub (https://github.com/materialsproject/pymatgen).

Summary

The latest OPTIMADE API specification v1.010 offers holistic access to many leading crystal structure databases, namely: AFLOW, COD, TCOD, Materials Cloud, Materials Project, NOMAD, odbx, Open Materials Database (omdb), and OQMD. Open client implementations are also available (https://optimade.science, https://materialscloud.org/optimadeclient) that enable aggregated searches over many databases as well as user-friendly graphical widgets that can create an OPTIMADE filter to empower the user with even easier access to data. OPTIMADE provides researchers easy access to over 10000000 results for different materials, providing benchmarking opportunities and offering a huge opportunity for high-throughput screening and machine learning studies. The ability of the OPTIMADE API to search databases, expose links between databases, and deliver standardized results makes it well-positioned to significantly enhance the impact and permeability of pre-existing data silos. This should empower researchers to scan through new and unexpected material families, and train models from all available data that can understand deep correlations.

The OPTIMADE API is flexible and will be extended to more use cases going forward. The development and adoption of the OPTIMADE API relies on the involvement of a large number of scientists, so contributions from the community are strongly encouraged, and questions on development, registration of a provider, or usage can be directed to the web forum (https://matsci.org/optimade) or mailing list (dev@optimade.org). Proposed developments include the standardization of more filterable materials properties, the integration of molecular dynamics simulations and of experimental results, and extensions beyond electronic-structure calculations. The future development of APIs, including OPTIMADE, should herald an era of effective use of big, open data in materials science.

Data availability

The OPTIMADE specification is developed openly on GitHub with releases archived on Zenodo10. Version 1.0.0 was released on 1 July 2020 and is licensed under Creative Commons Attribution 4.0 International (CC-BY 4.0).

Code availability

All associated code is hosted under the Materials-Consortia organisation on GitHub (https://github.com/Materials-Consortia).

References

  1. Landolt, H. & Bornstein, R. Physikalisch-Chemische Tabellen (Julius Springer, Berlin, 1883).

  2. Zagorac, D., Müller, H., Ruehl, S., Zagorac, J. & Rehme, S. Recent developments in the inorganic crystal structure database: theoretical crystal structure data and related features. J. Appl. Crystallogr. 52, 918–925, https://doi.org/10.1107/S160057671900997X (2019).

    CAS  Article  PubMed  PubMed Central  Google Scholar 

  3. Ceder, G. et al. Identification of cathode materials for lithium batteries guided by first-principles calculations. Nature 392, 694–696, https://doi.org/10.1038/33647 (1998).

    ADS  CAS  Article  Google Scholar 

  4. Curtarolo, S. et al. The high-throughput highway to computational materials design. Nat. Mater. 12, 191-201, https://doi.org/10.1038/nmat3568 (2013).

    ADS  CAS  Article  PubMed  Google Scholar 

  5. Himanen, L., Geurts, A., Foster, A. S. & Rinke, P. Data-Driven Materials Science: Status, Challenges, and Perspectives. Adv. Sci. 6, 1900808, https://doi.org/10.1002/advs.201900808 (2019).

    Article  Google Scholar 

  6. Taylor, R. H. et al. A RESTful API for exchanging materials data in the AFLOWLIB.org consortium. Comput. Mater. Sci. 93, 178–192, https://doi.org/10.1016/j.commatsci.2014.05.014 (2014).

    Article  Google Scholar 

  7. Rose, F. et al. AFLUX: The LUX materials search API for the AFLOW data repositories. Comput. Mater. Sci. 137, 362–370, https://doi.org/10.1016/j.commatsci.2017.04.036 (2017).

    Article  Google Scholar 

  8. Ong, S. P. et al. The Materials Application Programming Interface (API): A simple, flexible and efficient API for materials data based on REpresentational State Transfer (REST) principles. Comput. Mater. Sci. 97, 209–215, https://doi.org/10.1016/j.commatsci.2014.10.037 (2015).

    Article  Google Scholar 

  9. Talirz, L. et al. Materials Cloud, a platform for open computational science. Sci. Data 7, 299, https://doi.org/10.1038/s41597-020-00637-5 (2020).

    Article  PubMed  PubMed Central  Google Scholar 

  10. Andersen, C. W. et al. The OPTIMADE Specification (Version 1.0.0). Zenodo https://doi.org/10.5281/zenodo.4195051 (2020).

  11. The JSON:API Specification (Version 1.0). https://jsonapi.org/format (2015).

  12. Semantic Versioning (Version 2.0.0). https://semver.org/spec/v2.0.0.html (2013).

  13. FAIRsharing.org: OPTIMADE; Open Databases Integration for Materials Design. https://doi.org/10.25504/FAIRsharing.xvfqAC (2020).

  14. Choudhary, K. et al. The joint automated repository for various integrated simulations (JARVIS) for data-driven materials design. npj Comput. Mater. 6, 173, https://doi.org/10.1038/s41524-020-00440-1 (2020).

    ADS  Article  Google Scholar 

  15. Yang, X. et al. Matcloud: A high-throughput computational infrastructure for integrated management of materials simulation, data and resources. Comput. Mater. Sci. 146, 319–333, https://doi.org/10.1016/j.commatsci.2018.01.039 (2018).

    CAS  Article  Google Scholar 

  16. Pizzi, G., Cepellotti, A., Sabatini, R., Marzari, N. & Kozinsky, B. AiiDA: automated interactive infrastructure and database for computational science. Comput. Mater. Sci. 111, 218–230, https://doi.org/10.1016/j.commatsci.2015.09.013 (2016).

    Article  Google Scholar 

  17. Huber, S. P. et al. AiiDA 1.0, a scalable computational infrastructure for automated reproducible workflows and data provenance. Sci. Data 7, 300, https://doi.org/10.1038/s41597-020-00638-4 (2020).

    Article  PubMed  PubMed Central  Google Scholar 

  18. Uhrin, M., Huber, S. P., Yu, J., Marzari, N. & Pizzi, G. Workflows in AiiDA: Engineering a high-throughput, event-based engine for robust and modular computational workflows. Comput. Mater. Sci. 187, 110086, https://doi.org/10.1016/j.commatsci.2020.110086 (2021).

    Article  Google Scholar 

  19. Merkys, A. et al. A posteriori metadata from automated provenance tracking: integration of AiiDA and TCOD. J. Cheminform. 9, 56, https://doi.org/10.1186/s13321-017-0242-y (2017).

    CAS  Article  PubMed  PubMed Central  Google Scholar 

  20. Bernstein, H. J. et al. Specification of the crystallographic information file format, version 2.0. J. Appl. Crystallogr. 49, 277–284, https://doi.org/10.1107/S1600576715021871 (2016).

    CAS  Article  Google Scholar 

  21. Jain, A. et al. Commentary: The Materials Project: A materials genome approach to accelerating materials innovation. APL Mater. 1, 011002, https://doi.org/10.1063/1.4812323 (2013).

    ADS  CAS  Article  Google Scholar 

  22. Draxl, C. & Scheffler, M. NOMAD: The FAIR concept for big data-driven materials science. MRS Bull. 43, 676–682, https://doi.org/10.1557/mrs.2018.208 (2018).

    Article  Google Scholar 

  23. The OpenAPI Specification (Version 3.1.0). https://spec.openapis.org/oas/v3.1.0.html (2021).

  24. Ong, S. P. et al. Python Materials Genomics (pymatgen): A robust, open-source python library for materials analysis. Comput. Mater. Sci. 68, 314–319, https://doi.org/10.1016/j.commatsci.2012.10.028 (2013).

    CAS  Article  Google Scholar 

  25. Larsen, A. H. et al. The atomic simulation environment—a python library for working with atoms. J. Phys. Condens. Matter 29, 273002, https://doi.org/10.1088/1361-648x/aa680e (2017).

    CAS  Article  Google Scholar 

  26. Curtarolo, S. et al. AFLOWLIB.ORG: A distributed materials properties repository from high-throughput ab initio calculations. Comput. Mater. Sci 58, 227–235, https://doi.org/10.1016/j.commatsci.2012.02.002 (2012).

    CAS  Article  Google Scholar 

  27. Toher, C. et al. The AFLOW fleet for materials discovery. In Andreoni, W. & Yip, S. (eds.) Handbook of Materials Modeling, 1–28, https://doi.org/10.1007/978-3-319-42913-7_63-1 (Springer International Publishing, Cham, Switzerland, 2018).

  28. Gražulis, S. et al. Crystallography Open Database - an open-access collection of crystal structures. J. Appl. Crystallogr 42, 726–729, https://doi.org/10.1107/S0021889809016690 (2009).

    CAS  Article  PubMed  PubMed Central  Google Scholar 

  29. Gražulis, S. et al. Crystallography Open Database (COD): an open-access collection of crystal structures and platform for world-wide collaboration. Nucleic Acids Res. 40, D420–D427, https://doi.org/10.1093/nar/gkr900 (2012).

    CAS  Article  PubMed  Google Scholar 

  30. Jain, A. et al. A high-throughput infrastructure for density functional theory calculations. Comput. Mater. Sci. 50, 2295–2310, https://doi.org/10.1016/j.commatsci.2011.02.023 (2011).

    CAS  Article  Google Scholar 

  31. Mathew, K. et al. Atomate: A high-level interface to generate, execute, and analyze computational materials science workflows. Comput. Mater. Sci. 139, 140–152, https://doi.org/10.1016/j.commatsci.2017.07.030 (2017).

    Article  Google Scholar 

  32. Ghiringhelli, L. M. et al. Towards efficient data exchange and sharing for big-data driven materials science: metadata and data formats. npj Computational Materials 3, 46, https://doi.org/10.1038/s41524-017-0048-5 (2017).

  33. Evans, M. L. & Morris, A. J. matador: a Python library for analysing, curating and performing high-throughput density-functional theory calculations. J. Open Source Softw. 5, 2563, https://doi.org/10.21105/joss.02563 (2020).

    ADS  Article  Google Scholar 

  34. Armiento, R. Database-Driven High-Throughput Calculations and Machine Learning Models for Materials Design. In Schütt, K. T. et al. (eds.) Machine Learning Meets Quantum Physics, Lecture Notes in Physics, 377–395, https://doi.org/10.1007/978-3-030-40245-7_17 (Springer International Publishing, Cham, 2020).

  35. Saal, J. E., Kirklin, S., Aykol, M., Meredig, B. & Wolverton, C. Materials design and discovery with high-throughput density functional theory: The Open Quantum Materials Database (OQMD). JOM 65, 1501–1509, https://doi.org/10.1007/s11837-013-0755-4 (2013).

    CAS  Article  Google Scholar 

Download references

Acknowledgements

The authors acknowledge support from CECAM in Lausanne (Switzerland) and the Lorentz Center in Leiden (Netherlands) for hosting OPTIMADE workshops. C.W.A., S.K., N.M., G.Pi., M.U., and L.T. acknowledge financial support by the MARVEL National Centre of Competence in Research funded by the Swiss National Science Foundation (grant agreement ID 51NF40-182892), the European Centre of Excellence MaX “Materials design at the Exascale” (grant no. 824143) and by the the “MARKETPLACE” H2020 project (grant agreement ID 760173). R.Ar. acknowledges financial support from the Swedish e-Science Research Centre (SeRC) and the Swedish Research Council (VR) project no. 2016-04810 and 2020-05402. R.Av. has received funding from the European Union’s Horizon 2020 Research and Innovation Program under grant agreement No. 654360 NFFA-EUROPE. G.J.C. would like to acknowledge financial support from the Royal Society. S.D., D.Wi., M.Wu., M.H., P.H., and K.P. acknowledge financial support by the U.S. Department of Energy, Office of Science, Office of Basic Energy Sciences, Materials Sciences and Engineering Division under Contract No. DE-AC02-05-CH11231 (Materials Project program KC23MP). C.D., M.L.E., G.H., G.-M.R., M.Schef., M.Schei., and D.Wa. acknowledge support from the European Union’s Horizon 2020 research and innovation program under the European Union’s Grant agreement No. 951786 (NOMAD CoE). M.L.E. acknowledges the EPSRC CDT in Computational Methods for Materials Science for funding under grant number EP/L015552/1. A.G., M.L., V.H., and C.W. acknowledges support by Toyota Research Institute, and the award 70NANB14H012 from U.S. Department of Commerce, National Institute of Standards and Technology as part of the Center for Hierarchical Materials Design (CHiMaD). M.Go. acknowledges support by MICCoM, as part of the Computational Materials Sciences Program funded by the U.S. Department of Energy, Office of Science, Basic Energy Sciences, Materials Sciences and Engineering Division. S.G., A.Me., and A.V. were supported by funding from the European Union’s Horizon 2020 research and innovation program under grant agreement No. 689868 (SOLSA). A.J.M. acknowledges networking support via the EPSRC Collaborative Computational Projects, CCP9 (EP/M022595/1) and CCP-NC (EP/T026642/1) and the EPSRC High-End Computing Consorium, UKCP (EP/P022561/1). G.-M.R. acknowledges support from the F.R.S.-FNRS. MSchei acknowledges support from the European Union’s Horizon 2020 research and innovation program under the European Union’s Grant agreement No. 676580 (NoMaD) and financial support from the Max Planck research network on big-data-driven materials science (BiGmax). C.O., C.T., P.C., M.Es., F.Ro., and S.C. acknowledge support by DOD-ONR (N00014-17-1-2090, N00014-17-1-2876) and by the National Science Foundation under DMREF Grant No. DMR-1921909. X.Y. acknowledges support from the National Key Research and Development Program of China (Grants No. 2017YFB0701702 and 2016YFB0700501).

Author information

Authors and Affiliations

Authors

Contributions

All authors participated in discussions that lead to the OPTIMADE specification version 1.0, in particular, by taking part to the OPTIMADE workshops that took place at the Lorentz Center in Leiden (Netherlands) in 2016, and at the CECAM in Lausanne (Switzerland) in 2018, 2019, and 2020. They also revised and approved the final version of the paper. C.W.A., R.Ar., E.B., G.J.C., S.D., M.L.E., A.F., A.G., S.G., A.Me., F.M., C.O., G.Pi., G.-M.R., M.Schei., L.T., C.T., and D.Wi. provided the key ideas for the design of the API, took part to the discussions about the issues opened on the Materials Consortia GitHub repositories, writing its specifications, and prepared the paper. C.W.A. and M.L.E., with help from A.F., S.D., and M.Schei., write and maintain the optimade-python-tools library, which is based on initial work by D.Wi. and M.Wu., with contributions from R.Ar., K.C., A.G., A.Me., F.M., L.T., and T.P. This library forms the basis of the Materials Cloud, Materials Project, NOMAD and odbx providers as well as the client hosted on Materials Cloud. C.D., G.H., N.M., G.-M.R. and M.Schef. started the OPTIMADE workshop series, N.M. suggesting to dedicate these to the creation of a common API for databases of materials properties. R.Ar., G.J.C., C.D., S.G., N.M., G.H., G.Pi., G.-M.R., M.Schef., M.Schei., and C.T. were on the organizing committee. C.W.A. implemented the OPTIMADE server for the AiiDA framework and the Materials Cloud databases with contributions from G.Pi., L.T., and S.K. R.Ar. has contributed very actively to the OPTIMADE specification GitHub repository. He also implemented the OPTIMADE server in the high-throughput toolkit (httk) open source framework used for the omdb database. S.D. implemented the OPTIMADE server for the Materials Project provider, with assistance from M.K.H. and P.H.. M.K.H. wrote the OPTIMADE client in pymatgen. M.L.E. implemented the OPTIMADE server for the odbx provider, with assistance from A.J.M.. A.G. and M.L. implemented OPTIMADE server for OQMD provider with assistance from V.H., S.G., A.Me., and L.T. contributed to the implementation of the OPTIMADE::Filter Perl library for the syntactical analysis of the OPTIMADE filter language. M.Schei. implemented the OPTIMADE server for the NOMAD provider with contributions from F.M. C.T., C.O., P.C., M.E., F.Ro., and S.C. implemented the OPTIMADE server for the AFLOW provider. A.V. contributed to the long-term maintenance of the COD, to make it suitable for presentation via the OPTIMADE API.

Corresponding author

Correspondence to Gian-Marco Rignanese.

Ethics declarations

Competing interests

G.J.C. is a shareholder and Director of Intellegens Ltd. G.H., G.Pe., G.-M.R. and D.Wa. are shareholders and Directors of Matgenix SRL. The other authors declare no competing commercial interests.

Additional information

Publisher’s note Springer Nature remains neutral with regard to jurisdictional claims in published maps and institutional affiliations.

Supplementary information

Rights and permissions

Open Access This article is licensed under a Creative Commons Attribution 4.0 International License, which permits use, sharing, adaptation, distribution and reproduction in any medium or format, as long as you give appropriate credit to the original author(s) and the source, provide a link to the Creative Commons license, and indicate if changes were made. The images or other third party material in this article are included in the article’s Creative Commons license, unless indicated otherwise in a credit line to the material. If material is not included in the article’s Creative Commons license and your intended use is not permitted by statutory regulation or exceeds the permitted use, you will need to obtain permission directly from the copyright holder. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/.

Reprints and Permissions

About this article

Verify currency and authenticity via CrossMark

Cite this article

Andersen, C.W., Armiento, R., Blokhin, E. et al. OPTIMADE, an API for exchanging materials data. Sci Data 8, 217 (2021). https://doi.org/10.1038/s41597-021-00974-z

Download citation

  • Received:

  • Accepted:

  • Published:

  • DOI: https://doi.org/10.1038/s41597-021-00974-z

Further reading

Search

Quick links

Nature Briefing

Sign up for the Nature Briefing newsletter — what matters in science, free to your inbox daily.

Get the most important science stories of the day, free in your inbox. Sign up for Nature Briefing