Software Open Access

The OPTIMADE Specification

Andersen, Casper; Armiento, Rickard; Blokhin, Evgeny; Conduit, Gareth; Dwaraknath, Shyam; Evans, Matthew L; Fekete, Adam; Gopakumar, Abhijith; Gražulis, Saulius; Hegde, Vinay; Horton, Matthew; Merkys, Andrius; Mohamed, Fawzi; Morris, Andrew; Oses, Corey; Pizzi, Giovanni; Purcell, Thomas; Rignanese, Gian-Marco; Scheffler, Matthias; Scheidgen, Markus; Talirz, Leopold; Toher, Cormac; Uhrin, Martin; Winston, Donald; Wolverton, Chris

The Open Databases Integration for Materials Design (OPTIMADE) consortium aims to make materials databases interoperational by developing a common REST API.

This repository contains the specification of the OPTIMADE API.

The subdirectory schemas/ contains OpenAPI schemas for the main OPTIMADE API and index meta-database as implemented by the optimade-python-tools repository. Note: These schemas are an approximation of the full human-readable specification and may be missing certain constraints. Furthermore, they may not be up to date in the develop branch of this repository.

Files (235.1 kB)
Name Size
235.1 kB Download
  • Andersen et al, "OPTIMADE, an API for exchanging materials data" Sci Data 8, 217 (2021).

All versions This version
Views 1,887846
Downloads 268
Data volume 6.0 MB1.9 MB
Unique views 1,676758
Unique downloads 247


Cite as