logo
API docs by Redocly

ESG API (1.0)

Download OpenAPI specification:

You can use the Alasco API to integrate your application with Alasco. The Alasco API is REST-based and follows JSON:API principles for structuring responses.

Starting from version 1.0, the API is stable. We are continuously improving our API and new endpoints will be added. Any updates or changes within this major version will be backward-compatible and can be found in this documentation.

For getting acccess to the Alasco API, please reach out to us: kontakt@alasco.de.

The base URL for all endpoints is: https://api.alasco.de/esg/v1

The Alasco API supports compressed payloads. If you would like to make use of this, you have to specify the Accept-Encoding header. Supported encodings are gzip and br.

The Alasco API uses pagination. The page size is 100, additional pages can be accessed using a next link.

Buildings

Get Buildings

Authorizations:
API KeyAPI Token
query Parameters
include
string (Include)
Default: ""
Example: include=energy_certificates,building_certificates
    Optional, comma-separated list of entities to include in the building attributes.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Consumption Intervals

Bulk Create Consumption Intervals

Authorizations:
API KeyAPI Token
Request Body schema: application/json
required
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Create Consumption Interval

Authorizations:
API KeyAPI Token
Request Body schema: application/json
required
required
object (ConsumptionIntervalPayloadData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Utility Data Batch Info

Add Utility Data Batch Info

Authorizations:
API KeyAPI Token
Request Body schema: application/json
required
required
object (alasco__components__public_api__esg__web__v1__schemas__utilities__utility_batch_info__UtilityDataBatchInfoWrite)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Utility Meter Readings

Bulk Create Utility Meter Readings

Authorizations:
API KeyAPI Token
Request Body schema: application/json
required
required
Array of objects (Data)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Create Utility Meter Reading

Authorizations:
API KeyAPI Token
path Parameters
building_uuid
required
string <uuid> (Building Uuid)
meter_uuid
required
string <uuid> (Meter Uuid)
Request Body schema: application/json
required
required
object (UtilityMeterReadingPayloadData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Create Utility Meter Reading With External Id

Authorizations:
API KeyAPI Token
Request Body schema: application/json
required
required
object (UtilityMeterReadingWithExternalIdPayloadData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Utility Meters

Add Utility Meter

Authorizations:
API KeyAPI Token
Request Body schema: application/json
required
required
object (UtilityMeterCreatePayloadData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Get Utility Meters

Authorizations:
API KeyAPI Token
path Parameters
building_uuid
required
string <uuid> (Building Uuid)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}

Update Utility Meter

Authorizations:
API KeyAPI Token
path Parameters
meter_external_id
required
string (Meter External Id)
Request Body schema: application/json
required
required
object (UtilityMeterPatchPayloadData)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "errors": [
    ],
  • "included": [
    ],
  • "links": {
    }
}