Working with the Archilyse API — Getting Started

Different Potential View Simulations

You can easily access the power of Archilyse through our RESTful API. You can easily integrate our analysis with your own tools or use it on it’s own. To make things even easier, we’ve created a management platform to get you started. This platform is open source so you are free to take the code and do what you want with it. All you need is an API key.

Let’s take a look at how to get started with the Archilyse API and our management platform.

About the Management Platform

The Archilyse team calls this the ‘Portfolio Management Platform’ — but we know that terminology might have a slightly different meaning in your team. Nonetheless, the intention with this platform is to provide you with a starting point to manage the assets that you want to run Archilyse analysis against.

Portfolio Manager Platform populated with data

We have open-sourced this platform under an MIT-licence. This means that you are completely free to take the code and do what you want with it. Use it as it is, contribute your own changes, or adapt it to your own needs. You can find the GitHub repository here.

There’s lots of features we can explore in the Portfolio Manager but here we’ll just focus on getting started with it.

Steps

Below are the steps we need to take. But as a quick overview here they are in brief:

1. Create an Archilyse account
2. Log in to the Portfolio Manager
3. Add a building
4. Run a simulation

Step 1: Create an Archilyse account

You can create an Archilyse account. To learn more contact us at contact@archilyse.com. Once registered you can access your API Key or go right ahead and log into the Portfolio Management Platform.

The Archilyse console’s Registration, Dashboard, and User Profile pages

Step 2: Log in to the Portfolio Manager

You’ll find a link to the Portfolio Manager on the sidebar. Otherwise, you can log into it at https://portfolio.archilyse.com/login.

Log in with the email and password you used to create your Archilyse account.

The Portfolio Management Platform’s Login and Building Overview pages

Step 3: Add a building

Unsurprisingly, to begin, there won’t be any assets for you to work with. We can start by creating a building and then, fill in an address.

Create a new building and then enter the address

Once the building has been created and the address added, we automatically geolocate the building. You can verify that the location is correct and alter it if needed. Simply click on the ‘Georef’ button in the main toolbar.

Easily verify automatic georeferencing

Step 4: Run a simulation

At this point, with only the address, you can already run two of the Archilyse simulations.

Scroll along to the ‘Simulations’ section of the table and select a simulation to start, it’ll take a few moments to complete but you can then view the results and download them as a .csv file.

In the example below, I have opted to run a DPOI simulation. You can find more information about the DPOI simulations in my previous article.

Running a DPOI simulation against our new building

Would you like to try Archilyse contact us directly at contact@archilyse.com to get more information. We will find the optimal solution for you.

In an upcoming article, I’ll show you how to get started with our open-source code.