OPTIMADE API

optimade · Data

Data No Auth Free & Open open_data

The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API. This specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v0.16.0) v0.16.0.

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get Links

Get Links

https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links?sort=&filter=&include=references&api_hint=&page_above=0&page_below=0&page_limit=20&page_cursor=0&page_number=0&page_offset=0&email_address=&response_fields=&response_format=json

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links?sort=&filter=&include=references&api_hint=&page_above=0&page_below=0&page_limit=20&page_cursor=0&page_number=0&page_offset=0&email_address=&response_fields=&response_format=json"

import requests
params = {
    "sort": "",
    "filter": "",
    "include": "references",
    "api_hint": "",
    "page_above": "0",
    "page_below": "0",
    "page_limit": "20",
    "page_cursor": "0",
    "page_number": "0",
    "page_offset": "0",
    "email_address": "",
    "response_fields": "",
    "response_format": "json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links');
url.searchParams.set('sort', '');
url.searchParams.set('filter', '');
url.searchParams.set('include', 'references');
url.searchParams.set('api_hint', '');
url.searchParams.set('page_above', '0');
url.searchParams.set('page_below', '0');
url.searchParams.set('page_limit', '20');
url.searchParams.set('page_cursor', '0');
url.searchParams.set('page_number', '0');
url.searchParams.set('page_offset', '0');
url.searchParams.set('email_address', '');
url.searchParams.set('response_fields', '');
url.searchParams.set('response_format', 'json');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links")
	q := baseURL.Query()
	q.Set("sort", "")
	q.Set("filter", "")
	q.Set("include", "references")
	q.Set("api_hint", "")
	q.Set("page_above", "0")
	q.Set("page_below", "0")
	q.Set("page_limit", "20")
	q.Set("page_cursor", "0")
	q.Set("page_number", "0")
	q.Set("page_offset", "0")
	q.Set("email_address", "")
	q.Set("response_fields", "")
	q.Set("response_format", "json")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links")
uri.query = URI.encode_www_form({
  "sort" => "",
  "filter" => "",
  "include" => "references",
  "api_hint" => "",
  "page_above" => "0",
  "page_below" => "0",
  "page_limit" => "20",
  "page_cursor" => "0",
  "page_number" => "0",
  "page_offset" => "0",
  "email_address" => "",
  "response_fields" => "",
  "response_format" => "json"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/links?" . http_build_query([
    "sort" => "",
    "filter" => "",
    "include" => "references",
    "api_hint" => "",
    "page_above" => "0",
    "page_below" => "0",
    "page_limit" => "20",
    "page_cursor" => "0",
    "page_number" => "0",
    "page_offset" => "0",
    "email_address" => "",
    "response_fields" => "",
    "response_format" => "json"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get References

Get References

https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references?sort=&filter=&include=references&api_hint=&page_above=0&page_below=0&page_limit=20&page_cursor=0&page_number=0&page_offset=0&email_address=&response_fields=&response_format=json

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references?sort=&filter=&include=references&api_hint=&page_above=0&page_below=0&page_limit=20&page_cursor=0&page_number=0&page_offset=0&email_address=&response_fields=&response_format=json"

import requests
params = {
    "sort": "",
    "filter": "",
    "include": "references",
    "api_hint": "",
    "page_above": "0",
    "page_below": "0",
    "page_limit": "20",
    "page_cursor": "0",
    "page_number": "0",
    "page_offset": "0",
    "email_address": "",
    "response_fields": "",
    "response_format": "json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references');
url.searchParams.set('sort', '');
url.searchParams.set('filter', '');
url.searchParams.set('include', 'references');
url.searchParams.set('api_hint', '');
url.searchParams.set('page_above', '0');
url.searchParams.set('page_below', '0');
url.searchParams.set('page_limit', '20');
url.searchParams.set('page_cursor', '0');
url.searchParams.set('page_number', '0');
url.searchParams.set('page_offset', '0');
url.searchParams.set('email_address', '');
url.searchParams.set('response_fields', '');
url.searchParams.set('response_format', 'json');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references")
	q := baseURL.Query()
	q.Set("sort", "")
	q.Set("filter", "")
	q.Set("include", "references")
	q.Set("api_hint", "")
	q.Set("page_above", "0")
	q.Set("page_below", "0")
	q.Set("page_limit", "20")
	q.Set("page_cursor", "0")
	q.Set("page_number", "0")
	q.Set("page_offset", "0")
	q.Set("email_address", "")
	q.Set("response_fields", "")
	q.Set("response_format", "json")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references")
uri.query = URI.encode_www_form({
  "sort" => "",
  "filter" => "",
  "include" => "references",
  "api_hint" => "",
  "page_above" => "0",
  "page_below" => "0",
  "page_limit" => "20",
  "page_cursor" => "0",
  "page_number" => "0",
  "page_offset" => "0",
  "email_address" => "",
  "response_fields" => "",
  "response_format" => "json"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/references?" . http_build_query([
    "sort" => "",
    "filter" => "",
    "include" => "references",
    "api_hint" => "",
    "page_above" => "0",
    "page_below" => "0",
    "page_limit" => "20",
    "page_cursor" => "0",
    "page_number" => "0",
    "page_offset" => "0",
    "email_address" => "",
    "response_fields" => "",
    "response_format" => "json"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get Structures

Get Structures

https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures?sort=&filter=&include=references&api_hint=&page_above=0&page_below=0&page_limit=20&page_cursor=0&page_number=0&page_offset=0&email_address=&response_fields=&response_format=json

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures?sort=&filter=&include=references&api_hint=&page_above=0&page_below=0&page_limit=20&page_cursor=0&page_number=0&page_offset=0&email_address=&response_fields=&response_format=json"

import requests
params = {
    "sort": "",
    "filter": "",
    "include": "references",
    "api_hint": "",
    "page_above": "0",
    "page_below": "0",
    "page_limit": "20",
    "page_cursor": "0",
    "page_number": "0",
    "page_offset": "0",
    "email_address": "",
    "response_fields": "",
    "response_format": "json"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures');
url.searchParams.set('sort', '');
url.searchParams.set('filter', '');
url.searchParams.set('include', 'references');
url.searchParams.set('api_hint', '');
url.searchParams.set('page_above', '0');
url.searchParams.set('page_below', '0');
url.searchParams.set('page_limit', '20');
url.searchParams.set('page_cursor', '0');
url.searchParams.set('page_number', '0');
url.searchParams.set('page_offset', '0');
url.searchParams.set('email_address', '');
url.searchParams.set('response_fields', '');
url.searchParams.set('response_format', 'json');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures")
	q := baseURL.Query()
	q.Set("sort", "")
	q.Set("filter", "")
	q.Set("include", "references")
	q.Set("api_hint", "")
	q.Set("page_above", "0")
	q.Set("page_below", "0")
	q.Set("page_limit", "20")
	q.Set("page_cursor", "0")
	q.Set("page_number", "0")
	q.Set("page_offset", "0")
	q.Set("email_address", "")
	q.Set("response_fields", "")
	q.Set("response_format", "json")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures")
uri.query = URI.encode_www_form({
  "sort" => "",
  "filter" => "",
  "include" => "references",
  "api_hint" => "",
  "page_above" => "0",
  "page_below" => "0",
  "page_limit" => "20",
  "page_cursor" => "0",
  "page_number" => "0",
  "page_offset" => "0",
  "email_address" => "",
  "response_fields" => "",
  "response_format" => "json"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/optimade.local/1.1.0~develop/structures?" . http_build_query([
    "sort" => "",
    "filter" => "",
    "include" => "references",
    "api_hint" => "",
    "page_above" => "0",
    "page_below" => "0",
    "page_limit" => "20",
    "page_cursor" => "0",
    "page_number" => "0",
    "page_offset" => "0",
    "email_address" => "",
    "response_fields" => "",
    "response_format" => "json"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with OPTIMADE API?

OPTIMADE API is a Data API. Developers commonly use data APIs for:

enriching your app with third-party datasets
building data pipelines and ETL workflows
querying and searching large datasets
powering research, analysis, and reporting tools
syncing reference data into your own systems

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. OPTIMADE API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide · Learn about API keys · What is REST?

Open documentation ↗