OPTIMADE

OPTIMADE API

The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by…

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

This specification is generated using optimade-python-tools v0.16.0.

Endpoints 8

Info

  • GETGet Info/info
  • GETGet Entry Info/info/:entry

Links

  • GETGet Links/links?filter=&response_format=json&email_address=&response_fields=&sort=&page_limit=20&page_offset=0&page_number=0&page_cursor=0&page_above=0&page_below=0&include=references&api_hint=

References

  • GETGet References/references?filter=&response_format=json&email_address=&response_fields=&sort=&page_limit=20&page_offset=0&page_number=0&page_cursor=0&page_above=0&page_below=0&include=references&api_hint=
  • GETGet Single Reference/references/:entry_id?response_format=json&email_address=&response_fields=&include=references&api_hint=

Structures

  • GETGet Structures/structures?filter=&response_format=json&email_address=&response_fields=&sort=&page_limit=20&page_offset=0&page_number=0&page_cursor=0&page_above=0&page_below=0&include=references&api_hint=
  • GETGet Single Structure/structures/:entry_id?response_format=json&email_address=&response_fields=&include=references&api_hint=

Versions

  • GETGet Versions/versionsRespond with the text/csv representation for the served versions.

API details

Base URL
http://optimade.local
Authentication
None declared in the description
Operations
8 operations on 8 pathsGET 8
Main resources
Info 2References 2Structures 2Links 1Versions 1
Response formats
application/json text/csv; header=present
Description format
OpenAPI 3.0.2, API version 1.1.0~develop
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the OPTIMADE API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the OPTIMADE API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get Info” (GET /info), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the OPTIMADE API?

The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by… It is listed under Data & analytics and has 8 endpoints.

Who publishes the OPTIMADE API?

It is listed from OPTIMADE's public API description (an OpenAPI document), not published by OPTIMADE on Swastik Codes. Anyone who controls optimade.org can claim the profile by adding a DNS TXT record.

What is the base URL of the OPTIMADE API?

Requests go to http://optimade.local. Endpoint paths are added to this base URL.

How do I authenticate with the OPTIMADE API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the OPTIMADE API have?

8 operations on 8 paths (8 GET). The largest groups are Info, References, Structures, Links.

Is forking the OPTIMADE API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.