Connect your REST API

ADD THE JS form HERE.

Instructions

Step 1: Running the REST API

On your local AiiDA computer run on the command line:

$ verdi restapi

This command starts the REST API with the default parameters (default AiiDA profile, port 5000 of localhost). If your version of AiiDA is equal to 1.0.1 or later, its base URL is:

http://127.0.0.1:5000/api/v4

If your version of AiiDA is from 1.0.0b3 to 1.0.0b6, the base URL is:

http://127.0.0.1:5000/api/v3

If your version of AiiDA is previous or equal to 1.0.0b2, the base URL is:

http://127.0.0.1:5000/api/v2

Note that the REST API of the AiiDA 1.0.0 version is not supported; you should upgrade to 1.0.1 or to a later version to use the "Connect to your AiiDA REST API" feature.

Step 2: Connecting to your REST API

Type the base URL in the input box above and click "GO!" to browse your own data in the Explore section. To directly connect to your AiiDA REST API you can also pass the base_url parameter to the url query string, e.g.:

https://dev-www.materialscloud.org/explore/ownrestapi?base_url=http://127.0.0.1:5000/api/v4

Note that if the backend of your AiiDA profile is SQLAlchemy, you might have to reload the page after the first connection to your REST API in order to correctly load the nodes dashboard.
If you notice other issues please report them here.

Note: all data remains local to your computer and is not transferred to Materials Cloud.

For more information on the REST API see the AiiDA documentation.