Authentication

For our partners we offer an API key based authentication.

<aside> ☎️ If you do not have an API key yet but you are interested in integrating syte via this partner-API, please contact us via https://www.syte.ms/kontakt.

</aside>

For this type of authentication you must provide your email address and your API key with every request as the following Request headers:

Authorization: Bearer <YOU_API_KEY>

X-API-Customer: <YOU_EMAIL>

<aside> 🚨 It is very important that you keep your API key secret.

</aside>

Example Request

curl -X 'GET' \\
	'<https://api.syte.ms/api/cadastral/building-at?lat=51.9911041641&lng=7.59131190917>' \\
  -H "Authorization: Bearer $YOUR_API_KEY" \\
  -H "X-API-Customer: $YOU_EMAIL"

API Docs

You can find the full API documentation with example Requests and OpenAPI specification here:

<aside> 🔗 https://api.syte.ms/docs

</aside>

The most relevant APIs for partners are most likely:

API Endpoint Description
/api/cadastral/building-at Get all data about a building at the given location
/api/cadastral/property-at Get all data about a property at the given location
/api/potential/building-potential-at Calculate building potential with the help of AI for a property at the given location
/api/potential/on-roof-building-pv-at Calculate photovoltaic potential with the help of AI for a building at the given location
/api/search/properties/results Search for properties with many filter parameters

Data Overview

The following sheet provides an overview about all the attributes that are available through the API for buildings, properties, photovoltaic and energy potential. The API docs above also contains this information but this overview can be helpful.

<aside> 📄 syte Building and Property Data and API Sheet

</aside>