openapi: 3.1.0
info:
title: Energy Data API
description: "V0: This API is currently accessible to the public, and we anticipate\
\ future updates and enhancements."
version: v0
externalDocs:
url: /
servers: []
tags: []
paths:
/energy-data/v0/meta/{entity}:
get:
tags:
- Meta
summary: Meta Endpoint for entity and dataset
operationId: meta
parameters:
- name: entity
in: path
description: Entity type for which metadata is requested
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: price-areas
responses:
"200":
description: Provides metadata
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.MetaResponse"
examples:
metaExample:
value: "{\"meta\":{\"created\":\"2026-09-22T12:35:11+02:00\",\"\
lastUpdated\":\"2026-09-22T12:35:11+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/meta/{entity}\"},\"data\"\
:{\"type\":\"entity\",\"id\":\"price-area\",\"attributes\":{\"\
description\":\"Metadata for price area\",\"noOfDataSets\":2}}}"
"400":
description: Invalid request parameters or entity
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
invalidEntity:
value: "{\"errors\":[{\"status\":\"400\",\"title\":\"Invalid query\
\ parameter\",\"detail\":\"The requested entity is invalid or\
\ unsupported.\",\"links\":{\"self\":\"https://api.elhub.no/energy-data/v0/meta/{entity}\"\
}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedError:
value: "{\"errors\":[{\"status\":\"500\",\"title\":\"Unexpected\
\ server error. Try again later.\",\"detail\":\"An unexpected\
\ error occurred on the server.\",\"links\":{\"self\":\"https://api.elhub.no/energy-data/v0/meta/{entity}\"\
}}]}"
deprecated: false
/energy-data/v0/parties:
get:
tags:
- Party
summary: Get list of parties
operationId: parties
parameters: []
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.PartyResponse"
examples:
PartyExample:
summary: PartyExample
value: "{\"meta\":{\"created\":\"2024-10-29T12:16:37+01:00\"},\"\
links\":{\"self\":\"api.elhub.no/energy-data/v0/parties\"},\"\
data\":[{\"type\":\"parties\",\"id\":\"String\",\"attributes\"\
:{\"gln\":\"String\",\"partyTypes\":[\"String\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"},\"relationships\":{\"grid-area\"\
:{\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\"}]}}},{\"\
type\":\"grid-areas\",\"id\":\"String\",\"attributes\":{\"name\"\
:\"String\",\"status\":\"String\",\"eic\":\"String\"},\"relationships\"\
:{\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"String\"\
}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/parties"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/parties/{id}:
get:
tags:
- Party
summary: Get list of parties
operationId: parties_id
parameters:
- name: id
in: path
description: A valid party id returned from /parties
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: "8000400000039"
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.PartyResponse"
examples:
PartyExample:
summary: PartyExample
value: "{\"meta\":{\"created\":\"2024-10-29T12:16:37+01:00\"},\"\
links\":{\"self\":\"api.elhub.no/energy-data/v0/parties\"},\"\
data\":[{\"type\":\"parties\",\"id\":\"String\",\"attributes\"\
:{\"gln\":\"String\",\"partyTypes\":[\"String\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"},\"relationships\":{\"grid-area\"\
:{\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\"}]}}},{\"\
type\":\"grid-areas\",\"id\":\"String\",\"attributes\":{\"name\"\
:\"String\",\"status\":\"String\",\"eic\":\"String\"},\"relationships\"\
:{\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"String\"\
}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/parties/{id}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/price-areas:
get:
tags:
- Price area
summary: Get list of price areas and aggregations
operationId: price_areas
parameters:
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMbaHour
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of aggregated data (inclusive). If empty, it will be set to\
\ a date one month in the past from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of aggregated data (inclusive). The time period from startDate to endDate\
\ cannot exceed one month. If empty, it will be set to current date and\
\ startDate will be set to a date one month in the past."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: consumptionGroup
in: query
description: The consumption group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: household
- name: productionGroup
in: query
description: The production group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: hydro
- name: estimatedAnnualConsumption
in: query
description: "The estimated annual consumption, integer between 1 and 500000"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: "10000"
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the onbehalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is OK. Choose a different dataset under 'Examples'
to see different responses
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.PriceAreaResponse"
examples:
'[No dataset chosen]':
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas\"},\"data\"\
:[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\":{\"\
name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
CompletenessDailyPerMba:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=CompletenessDailyPerMba\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"CompletenessDailyPerMba\"\
:[{\"actualIntervalCount\":\"Int\",\"combinedConsumptionActualIntervalCount\"\
:\"Int\",\"combinedConsumptionExpectedIntervalCount\":\"Int\"\
,\"combinedProductionActualIntervalCount\":\"Int\",\"combinedProductionExpectedIntervalCount\"\
:\"Int\",\"consumptionFifteenActualIntervalCount\":\"Int\",\"\
consumptionFifteenExpectedIntervalCount\":\"Int\",\"consumptionSixtyActualIntervalCount\"\
:\"Int\",\"consumptionSixtyExpectedIntervalCount\":\"Int\",\"\
estimatedAnnualConsumptionAll\":\"Long\",\"estimatedAnnualConsumptionCompleted\"\
:\"Long\",\"estimatedIntervalCount\":\"Int\",\"exchangeActualIntervalCount\"\
:\"Int\",\"exchangeExpectedIntervalCount\":\"Int\",\"expectedIntervalCount\"\
:\"Int\",\"finalEstimatedIntervalCount\":\"Int\",\"installedCapacityAll\"\
:\"Long\",\"installedCapacityCompleted\":\"Long\",\"largeProductionActualIntervalCount\"\
:\"Int\",\"largeProductionExpectedIntervalCount\":\"Int\",\"lastUpdatedTime\"\
:\"String\",\"loadLimitAll\":\"Long\",\"loadLimitCompleted\":\"\
Long\",\"meteredIntervalCount\":\"Int\",\"meteringPointCount\"\
:\"Int\",\"notCompleteMeteringPointCount\":\"Int\",\"priceArea\"\
:\"String\",\"temporaryIntervalCount\":\"Int\",\"usageDateId\"\
:\"Int\"}]}}]}"
ConsumptionPerGroupMbaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ConsumptionPerGroupMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ConsumptionPerGroupMbaHour\"\
:[{\"consumptionGroup\":\"String\",\"endTime\":\"String\",\"lastUpdatedTime\"\
:\"String\",\"meteringPointCount\":\"Int\",\"priceArea\":\"String\"\
,\"quantityKwh\":\"Float\",\"startTime\":\"String\"}]}}]}"
ProductionPerGroupMbaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ProductionPerGroupMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ProductionPerGroupMbaHour\"\
:[{\"endTime\":\"String\",\"lastUpdatedTime\":\"String\",\"priceArea\"\
:\"String\",\"productionGroup\":\"String\",\"quantityKwh\":\"\
Float\",\"startTime\":\"String\"}]}}]}"
ProductionPerMba15Min:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ProductionPerMba15Min\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ProductionPerMba15Min\"\
:[{\"endTime\":\"String\",\"lastUpdatedTime\":\"String\",\"priceArea\"\
:\"String\",\"quantityKwh\":\"Float\",\"startTime\":\"String\"\
}]}}]}"
ProductionPerGroupMba15Min:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ProductionPerGroupMba15Min\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ProductionPerGroupMba15Min\"\
:[{\"endTime\":\"String\",\"lastUpdatedTime\":\"String\",\"priceArea\"\
:\"String\",\"productionGroup\":\"String\",\"quantityKwh\":\"\
Float\",\"startTime\":\"String\"}]}}]}"
ExchangePerMbaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ExchangePerMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ExchangePerMbaHour\"\
:[{\"adjacentPriceArea\":\"String\",\"endTime\":\"String\",\"\
exchangeInQuantityKwh\":\"Float\",\"exchangeOutQuantityKwh\":\"\
Float\",\"lastUpdatedTime\":\"String\",\"priceArea\":\"String\"\
,\"startTime\":\"String\"}]}}]}"
ExchangePerMba15Min:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ExchangePerMba15Min\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ExchangePerMba15Min\"\
:[{\"adjacentPriceArea\":\"String\",\"endTime\":\"String\",\"\
exchangeInQuantityKwh\":\"Float\",\"exchangeOutQuantityKwh\":\"\
Float\",\"lastUpdatedTime\":\"String\",\"priceArea\":\"String\"\
,\"startTime\":\"String\"}]}}]}"
LossPerMbaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=LossPerMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"LossPerMbaHour\"\
:[{\"calculateLossFraction\":\"Float\",\"calculatedLossQuantityKwh\"\
:\"Float\",\"consumptionQuantityKwh\":\"Float\",\"endTime\":\"\
String\",\"exchangeInQuantityKwh\":\"Float\",\"exchangeOutQuantityKwh\"\
:\"Float\",\"lastUpdatedTime\":\"String\",\"netInfeedQuantityKwh\"\
:\"Float\",\"priceArea\":\"String\",\"productionQuantityKwh\"\
:\"Float\",\"startTime\":\"String\"}]}}]}"
CompletenessDailyPerBalanceSupplierMba:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=CompletenessDailyPerBalanceSupplierMba\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"CompletenessDailyPerBalanceSupplierMba\"\
:[{\"actualIntervalCount\":\"Int\",\"balanceSupplier\":\"String\"\
,\"combinedConsumptionActualIntervalCount\":\"Int\",\"combinedConsumptionExpectedIntervalCount\"\
:\"Int\",\"combinedProductionActualIntervalCount\":\"Int\",\"\
combinedProductionExpectedIntervalCount\":\"Int\",\"consumptionFifteenActualIntervalCount\"\
:\"Int\",\"consumptionFifteenExpectedIntervalCount\":\"Int\",\"\
consumptionSixtyActualIntervalCount\":\"Int\",\"consumptionSixtyExpectedIntervalCount\"\
:\"Int\",\"estimatedAnnualConsumptionAll\":\"Long\",\"estimatedAnnualConsumptionCompleted\"\
:\"Long\",\"estimatedIntervalCount\":\"Int\",\"expectedIntervalCount\"\
:\"Int\",\"finalEstimatedIntervalCount\":\"Int\",\"installedCapacityAll\"\
:\"Long\",\"installedCapacityCompleted\":\"Long\",\"largeProductionActualIntervalCount\"\
:\"Int\",\"largeProductionExpectedIntervalCount\":\"Int\",\"lastUpdatedTime\"\
:\"String\",\"loadLimitAll\":\"Long\",\"loadLimitCompleted\":\"\
Long\",\"meteredIntervalCount\":\"Int\",\"meteringPointCount\"\
:\"Int\",\"notCompleteMeteringPointCount\":\"Int\",\"priceArea\"\
:\"String\",\"temporaryIntervalCount\":\"Int\",\"usageDateId\"\
:\"Int\"}]}}]}"
ConsumptionPerBalanceSupplierMbaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ConsumptionPerBalanceSupplierMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ConsumptionPerBalanceSupplierMbaHour\"\
:[{\"balanceSupplier\":\"String\",\"endTime\":\"String\",\"lastUpdatedTime\"\
:\"String\",\"meteringPointCount\":\"Int\",\"priceArea\":\"String\"\
,\"quantityKwh\":\"Float\",\"startTime\":\"String\"}]}}]}"
ProductionPerBalanceSupplierMeteringPointTypeCodeMbaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=ProductionPerBalanceSupplierMeteringPointTypeCodeMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"ProductionPerBalanceSupplierMeteringPointTypeCodeMbaHour\"\
:[{\"balanceSupplier\":\"String\",\"endTime\":\"String\",\"lastUpdatedTime\"\
:\"String\",\"meteringPointCount\":\"Int\",\"meteringPointTypeCode\"\
:\"String\",\"priceArea\":\"String\",\"quantityKwh\":\"Float\"\
,\"startTime\":\"String\"}]}}]}"
NorgesprisConsumptionPerGroupEacMba:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=NorgesprisConsumptionPerGroupEacMbaHour\"\
},\"data\":[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\"\
:{\"name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\",\"NorgesprisConsumptionPerGroupEacMbaHour\"\
:[{\"consumptionGroup\":\"String\",\"endTime\":\"String\",\"estimatedAnnualConsumptionFrom\"\
:\"Long\",\"estimatedAnnualConsumptionTo\":\"Long\",\"lastUpdatedTime\"\
:\"String\",\"meteringPointCountNorwayPrice\":\"Int\",\"meteringPointCountNotNorwayPrice\"\
:\"Int\",\"quantityKwhNorwayPrice\":\"Float\",\"quantityKwhNotNorwayPrice\"\
:\"Float\",\"startTime\":\"String\",\"totalMeteringPointCount\"\
:\"Int\",\"totalQuantityKwh\":\"Float\"}]}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/price-areas"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
deprecated: false
/energy-data/v0/price-areas/{id}:
get:
tags:
- Price area
summary: Get list of price areas and aggregations
operationId: price_areas_id
parameters:
- name: id
in: path
description: A valid price area id returned from /price-areas
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: NO1
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMbaHour
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of aggregated data (inclusive). If empty, it will be set to\
\ a date one month in the past from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of aggregated data (inclusive). The time period from startDate to endDate\
\ cannot exceed one month. If empty, it will be set to current date and\
\ startDate will be set to a date one month in the past."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: consumptionGroup
in: query
description: The consumption group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: household
- name: productionGroup
in: query
description: The production group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: hydro
- name: estimatedAnnualConsumption
in: query
description: "The estimated annual consumption, integer between 1 and 500000"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: "10000"
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the onbehalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is OK. Choose a different dataset under 'Examples'
to see different responses
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.PriceAreaResponse"
examples:
'[No dataset chosen]':
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/price-areas\"},\"data\"\
:[{\"type\":\"price-areas\",\"id\":\"NO1\",\"attributes\":{\"\
name\":\"NO5\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/price-areas/{id}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
deprecated: false
/energy-data/v0/price-areas{suffix}:
get:
tags:
- Price area
summary: Get list of price areas and aggregations
operationId: price_areas_export
parameters:
- name: suffix
in: path
description: Suffix to specify type of data returned.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: .csv
- name: dataset
in: query
description: The dataset name.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMbaHour
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the onbehalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"302":
description: CSV export redirect
headers:
Location:
description: Redirect target (download URL)
required: false
deprecated: false
schema:
type: string
title: String
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/price-areas{suffix}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
deprecated: false
/energy-data/v0/grid-areas:
get:
tags:
- Grid area
summary: Get list of Grid Areas
operationId: grid_areas
parameters:
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMgaHour
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of aggregated data (inclusive). If empty, it will be set to\
\ a date one month in the past from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of aggregated data (inclusive). The time period from startDate to endDate\
\ cannot exceed one month. If empty, it will be set to current date and\
\ startDate will be set to a date one month in the past."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: consumptionGroup
in: query
description: The consumption group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: household
- name: productionGroup
in: query
description: The production group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: hydro
- name: consumptionTypeCode
in: query
description: The consumption type code.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: A04
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid. Choose a different dataset under 'Examples'
to see different responses
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.GridAreaResponse"
examples:
'[No dataset chosen]':
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas\"},\"data\"\
:[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\"}}],\"included\":[{\"type\":\"parties\"\
,\"id\":\"String\",\"attributes\":{\"gln\":\"String\",\"partyTypes\"\
:[\"String\"],\"name\":\"String\",\"organisationNumber\":\"String\"\
}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
CompletenessDailyPerMga:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=CompletenessDailyPerMga\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"CompletenessDailyPerMga\":[{\"actualIntervalCount\"\
:\"Int\",\"actualWithAdjacentExchangeIntervalCount\":\"Int\",\"\
adjacentExchangeActualIntervalCount\":\"Int\",\"adjacentExchangeExpectedIntervalCount\"\
:\"Int\",\"combinedConsumptionActualIntervalCount\":\"Int\",\"\
combinedConsumptionExpectedIntervalCount\":\"Int\",\"combinedProductionActualIntervalCount\"\
:\"Int\",\"combinedProductionExpectedIntervalCount\":\"Int\",\"\
consumptionFifteenActualIntervalCount\":\"Int\",\"consumptionFifteenExpectedIntervalCount\"\
:\"Int\",\"consumptionSixtyActualIntervalCount\":\"Int\",\"consumptionSixtyExpectedIntervalCount\"\
:\"Int\",\"estimatedIntervalCount\":\"Int\",\"exchangeActualIntervalCount\"\
:\"Int\",\"exchangeExpectedIntervalCount\":\"Int\",\"expectedIntervalCount\"\
:\"Int\",\"expectedWithAdjacentExchangeIntervalCount\":\"Int\"\
,\"finalEstimatedIntervalCount\":\"Int\",\"gridArea\":\"String\"\
,\"installedCapacityAll\":\"Long\",\"installedCapacityCompleted\"\
:\"Long\",\"largeProductionActualIntervalCount\":\"Int\",\"largeProductionExpectedIntervalCount\"\
:\"Int\",\"lastUpdatedTime\":\"String\",\"loadLimitAll\":\"Long\"\
,\"loadLimitCompleted\":\"Long\",\"meteredIntervalCount\":\"Int\"\
,\"meteringPointCount\":\"Int\",\"notCompleteAdjacentExchangePointCount\"\
:\"Int\",\"notCompleteMeteringPointCount\":\"Int\",\"priceArea\"\
:\"String\",\"temporaryIntervalCount\":\"Int\",\"usageDateId\"\
:\"Int\"}]}}],\"included\":[{\"type\":\"parties\",\"id\":\"String\"\
,\"attributes\":{\"gln\":\"String\",\"partyTypes\":[\"String\"\
],\"name\":\"String\",\"organisationNumber\":\"String\"}},{\"\
type\":\"price-areas\",\"id\":\"String\",\"attributes\":{\"name\"\
:\"String\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
ConsumptionPerGroupMgaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=ConsumptionPerGroupMgaHour\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"ConsumptionPerGroupMgaHour\":[{\"\
consumptionGroup\":\"String\",\"endTime\":\"String\",\"gridArea\"\
:\"String\",\"lastUpdatedTime\":\"String\",\"meteringPointCount\"\
:\"Int\",\"quantityKwh\":\"Float\",\"startTime\":\"String\"}]}}],\"\
included\":[{\"type\":\"parties\",\"id\":\"String\",\"attributes\"\
:{\"gln\":\"String\",\"partyTypes\":[\"String\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"}},{\"type\":\"price-areas\"\
,\"id\":\"String\",\"attributes\":{\"name\":\"String\",\"eic\"\
:\"String\",\"country\":\"NO\"}}]}"
ExchangePerMgaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=ExchangePerMgaHour\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"ExchangePerMgaHour\":[{\"adjacentGridArea\"\
:\"String\",\"adjacentPriceArea\":\"String\",\"endTime\":\"String\"\
,\"exchangeInQuantityKwh\":\"Float\",\"exchangeOutQuantityKwh\"\
:\"Float\",\"gridArea\":\"String\",\"lastUpdatedTime\":\"String\"\
,\"priceArea\":\"String\",\"startTime\":\"String\"}]}}],\"included\"\
:[{\"type\":\"parties\",\"id\":\"String\",\"attributes\":{\"gln\"\
:\"String\",\"partyTypes\":[\"String\"],\"name\":\"String\",\"\
organisationNumber\":\"String\"}},{\"type\":\"price-areas\",\"\
id\":\"String\",\"attributes\":{\"name\":\"String\",\"eic\":\"\
String\",\"country\":\"NO\"}}]}"
LossPerMgaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=LossPerMgaHour\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"LossPerMgaHour\":[{\"calculatedLossFraction\"\
:\"Float\",\"calculatedLossQuantityKwh\":\"Float\",\"endTime\"\
:\"String\",\"gridArea\":\"String\",\"lastUpdatedTime\":\"String\"\
,\"netInfeedQuantityKwh\":\"Float\",\"priceArea\":\"String\",\"\
startTime\":\"String\"}]}}],\"included\":[{\"type\":\"parties\"\
,\"id\":\"String\",\"attributes\":{\"gln\":\"String\",\"partyTypes\"\
:[\"String\"],\"name\":\"String\",\"organisationNumber\":\"String\"\
}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
CompletenessDailyPerBalanceSupplierMga:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=CompletenessDailyPerBalanceSupplierMga\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"CompletenessDailyPerBalanceSupplierMga\"\
:[{\"actualIntervalCount\":\"Int\",\"balanceSupplier\":\"String\"\
,\"combinedConsumptionActualIntervalCount\":\"Int\",\"combinedConsumptionExpectedIntervalCount\"\
:\"Int\",\"combinedProductionActualIntervalCount\":\"Int\",\"\
combinedProductionExpectedIntervalCount\":\"Int\",\"consumptionFifteenActualIntervalCount\"\
:\"Int\",\"consumptionFifteenExpectedIntervalCount\":\"Int\",\"\
consumptionSixtyActualIntervalCount\":\"Int\",\"consumptionSixtyExpectedIntervalCount\"\
:\"Int\",\"estimatedAnnualConsumptionAll\":\"Long\",\"estimatedAnnualConsumptionCompleted\"\
:\"Long\",\"estimatedIntervalCount\":\"Int\",\"expectedIntervalCount\"\
:\"Int\",\"finalEstimatedIntervalCount\":\"Int\",\"gridArea\"\
:\"String\",\"installedCapacityAll\":\"Long\",\"installedCapacityCompleted\"\
:\"Long\",\"largeProductionActualIntervalCount\":\"Int\",\"largeProductionExpectedIntervalCount\"\
:\"Int\",\"lastUpdatedTime\":\"String\",\"loadLimitAll\":\"Long\"\
,\"loadLimitCompleted\":\"Long\",\"meteredIntervalCount\":\"Int\"\
,\"meteringPointCount\":\"Int\",\"notCompleteMeteringPointCount\"\
:\"Int\",\"priceArea\":\"String\",\"temporaryIntervalCount\":\"\
Int\",\"usageDateId\":\"Int\"}]}}],\"included\":[{\"type\":\"\
parties\",\"id\":\"String\",\"attributes\":{\"gln\":\"String\"\
,\"partyTypes\":[\"String\"],\"name\":\"String\",\"organisationNumber\"\
:\"String\"}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
ConsumptionPerBalanceSupplierMgaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=ConsumptionPerBalanceSupplierMgaHour\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"ConsumptionPerBalanceSupplierMgaHour\"\
:[{\"balanceSupplier\":\"String\",\"endTime\":\"String\",\"gridArea\"\
:\"String\",\"lastUpdatedTime\":\"String\",\"meteringPointCount\"\
:\"Int\",\"quantityKwh\":\"Float\",\"startTime\":\"String\"}]}}],\"\
included\":[{\"type\":\"parties\",\"id\":\"String\",\"attributes\"\
:{\"gln\":\"String\",\"partyTypes\":[\"String\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"}},{\"type\":\"price-areas\"\
,\"id\":\"String\",\"attributes\":{\"name\":\"String\",\"eic\"\
:\"String\",\"country\":\"NO\"}}]}"
ProductionPerBalanceSupplierMeteringPointTypeMgaHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=ProductionPerBalanceSupplierMeteringPointTypeMgaHour\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"ProductionPerBalanceSupplierMeteringPointTypeMgaHour\"\
:[{\"balanceSupplier\":\"String\",\"endTime\":\"String\",\"gridArea\"\
:\"String\",\"lastUpdatedTime\":\"String\",\"meteringPointCount\"\
:\"Int\",\"meteringPointTypeCode\":\"String\",\"priceArea\":\"\
String\",\"quantityKwh\":\"Float\",\"startTime\":\"String\"}]}}],\"\
included\":[{\"type\":\"parties\",\"id\":\"String\",\"attributes\"\
:{\"gln\":\"String\",\"partyTypes\":[\"String\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"}},{\"type\":\"price-areas\"\
,\"id\":\"String\",\"attributes\":{\"name\":\"String\",\"eic\"\
:\"String\",\"country\":\"NO\"}}]}"
CostPerMgaMonth:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas?dataset=CostPerMgaMonth\"\
},\"data\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\",\"CostPerMgaMonth\":[{\"consumptionKwh\"\
:\"java.math.BigDecimal\",\"consumptionKwhNorwayPrice\":\"java.math.BigDecimal\"\
,\"consumptionKwhSpotPrice\":\"java.math.BigDecimal\",\"consumptionKwhSupportPrice\"\
:\"java.math.BigDecimal\",\"costNorwayPrice\":\"java.math.BigDecimal\"\
,\"costSpotPrice\":\"java.math.BigDecimal\",\"costSupportPrice\"\
:\"java.math.BigDecimal\",\"countEligibleForNorwayPrice\":\"Int\"\
,\"countEligibleForSupportPrice\":\"Int\",\"countNorwayPriceContract\"\
:\"Int\",\"countNorwayPriceContractEndOfMonth\":\"Int\",\"countSupportPriceContract\"\
:\"Int\",\"countSupportPriceContractEndOfMonth\":\"Int\",\"endTime\"\
:\"String\",\"lastUpdatedTime\":\"String\",\"startTime\":\"String\"\
,\"supportNorwayPrice\":\"java.math.BigDecimal\",\"supportSupportPrice\"\
:\"java.math.BigDecimal\",\"totalCost\":\"java.math.BigDecimal\"\
,\"yearMonth\":\"Int\"}]}}],\"included\":[{\"type\":\"parties\"\
,\"id\":\"String\",\"attributes\":{\"gln\":\"String\",\"partyTypes\"\
:[\"String\"],\"name\":\"String\",\"organisationNumber\":\"String\"\
}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/grid-areas"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
deprecated: false
/energy-data/v0/grid-areas/{id}:
get:
tags:
- Grid area
summary: Get list of Grid Areas
operationId: grid_areas_id
parameters:
- name: id
in: path
description: A valid grid area id returned from /grid-areas
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: 50YXGP9PZT7VC-7A
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMgaHour
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of aggregated data (inclusive). If empty, it will be set to\
\ a date one month in the past from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of aggregated data (inclusive). The time period from startDate to endDate\
\ cannot exceed one month. If empty, it will be set to current date and\
\ startDate will be set to a date one month in the past."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: consumptionGroup
in: query
description: The consumption group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: household
- name: productionGroup
in: query
description: The production group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: hydro
- name: consumptionTypeCode
in: query
description: The consumption type code.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: A04
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid. Choose a different dataset under 'Examples'
to see different responses
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.GridAreaResponse"
examples:
'[No dataset chosen]':
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\",\"\
lastUpdated\":\"2023-10-18T12:00:00+02:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/grid-areas\"},\"data\"\
:[{\"type\":\"grid-areas\",\"id\":\"String\",\"relationships\"\
:{\"grid-owner\":{\"data\":{\"type\":\"parties\",\"id\":\"String\"\
}},\"price-area\":{\"data\":{\"type\":\"price-areas\",\"id\":\"\
String\"}}},\"attributes\":{\"name\":\"String\",\"status\":\"\
Active\",\"eic\":\"String\"}}],\"included\":[{\"type\":\"parties\"\
,\"id\":\"String\",\"attributes\":{\"gln\":\"String\",\"partyTypes\"\
:[\"String\"],\"name\":\"String\",\"organisationNumber\":\"String\"\
}},{\"type\":\"price-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"eic\":\"String\",\"country\":\"NO\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/grid-areas/{id}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
deprecated: false
/energy-data/v0/grid-areas{suffix}:
get:
tags:
- Grid area
summary: Get list of Grid Areas
operationId: grid_areas_export
parameters:
- name: suffix
in: path
description: Suffix to specify type of data returned.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: .csv
- name: dataset
in: query
description: The dataset name.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMgaHour
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"302":
description: CSV export redirect
headers:
Location:
description: Redirect target (download URL)
required: false
deprecated: false
schema:
type: string
title: String
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/grid-areas{suffix}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
deprecated: false
/energy-data/v0/municipalities:
get:
tags:
- Municipality
summary: Get list of Municipalities and aggregations
operationId: municipalities
parameters:
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMunicipalityHour
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of aggregated data (inclusive). If startDate is empty, it will\
\ be set to a date one month in the past from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-09T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of aggregated data (inclusive). The time period from startDate to endDate\
\ cannot exceed one month. If endDate is empty, it will be set to current\
\ date and startDate will be set to a date one month in the past."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-10T03:00:00+02:00
- name: consumptionGroup
in: query
description: The consumption group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: industry
- name: priceArea
in: query
description: Price area filter
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: gridArea
in: query
description: Grid area filter
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: productionGroup
in: query
description: Production group filter
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: basicStatisticalUnit
in: query
description: Basic statistical unit
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: meteringPointTypeCode
in: query
description: Metering point type code
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid. Choose a different dataset under 'Examples'
to see different responses
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.MunicipalityResponse"
examples:
'[No dataset chosen]':
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\"}}]}"
ConsumptionPerGroupMunicipalityHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ConsumptionPerGroupMunicipalityHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ConsumptionPerGroupMunicipalityHour\":[{\"consumptionGroup\"\
:\"String\",\"endTime\":\"String\",\"lastUpdatedTime\":\"String\"\
,\"meteringPointCount\":\"Int\",\"quantityKwh\":\"Float\",\"startTime\"\
:\"String\"}]}}]}"
ProductionPerMeteringPointTypeMunicipalityHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ProductionPerMeteringPointTypeMunicipalityHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ProductionPerMeteringPointTypeMunicipalityHour\"\
:[{\"endTime\":\"String\",\"lastUpdatedTime\":\"String\",\"meteringPointCount\"\
:\"Int\",\"meteringPointTypeCode\":\"String\",\"quantityKwh\"\
:\"Float\",\"startTime\":\"String\"}]}}]}"
ConsumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ConsumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ConsumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour\"\
:[{\"consumptionCode\":\"String\",\"endTime\":\"String\",\"gridArea\"\
:\"String\",\"lastUpdatedTime\":\"String\",\"meteringPointCount\"\
:\"Int\",\"naceCode\":\"String\",\"priceArea\":\"String\",\"quantityKwh\"\
:\"Float\",\"startTime\":\"String\"}]}}]}"
ConsumptionPerGroupMunicipalityBasicStatisticalUnitHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ConsumptionPerGroupMunicipalityBasicStatisticalUnitHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ConsumptionPerGroupMunicipalityBasicStatisticalUnitHour\"\
:[{\"basicStatisticalUnit\":\"String\",\"consumptionGroup\":\"\
String\",\"endTime\":\"String\",\"lastUpdatedTime\":\"String\"\
,\"meteringPointCount\":\"Int\",\"quantityKwh\":\"Float\",\"startTime\"\
:\"String\"}]}}]}"
ConsumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ConsumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ConsumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour\"\
:[{\"consumptionCode\":\"String\",\"endTime\":\"String\",\"lastUpdatedTime\"\
:\"String\",\"meteringPointCount\":\"Int\",\"naceCode\":\"String\"\
,\"priceArea\":\"String\",\"quantityKwh\":\"Float\",\"startTime\"\
:\"String\"}]}}]}"
ConsumptionPerBalanceSupplierMunicipalityHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ConsumptionPerBalanceSupplierMunicipalityHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ConsumptionPerBalanceSupplierMunicipalityHour\"\
:[{\"consumptionGroup\":\"String\",\"endTime\":\"String\",\"lastUpdatedTime\"\
:\"String\",\"meteringPointCount\":\"Int\",\"quantityKwh\":\"\
Float\",\"startTime\":\"String\"}]}}]}"
ProductionPerBalanceSupplierMeteringPointTypeCodeMunicipalityHour:
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities?dataset=ProductionPerBalanceSupplierMeteringPointTypeCodeMunicipalityHour\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\",\"ProductionPerBalanceSupplierMeteringPointTypeCodeMunicipalityHour\"\
:[{\"endTime\":\"String\",\"lastUpdatedTime\":\"String\",\"meteringPointCount\"\
:\"Int\",\"meteringPointTypeCode\":\"String\",\"quantityKwh\"\
:\"Float\",\"startTime\":\"String\"}]}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/municipalities"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
deprecated: false
/energy-data/v0/municipalities/{id}:
get:
tags:
- Municipality
summary: Get list of Municipalities and aggregations
operationId: municipalities_id
parameters:
- name: id
in: path
description: A valid municipality id returned from /municipalities
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: "1101"
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMunicipalityHour
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of aggregated data (inclusive). If startDate is empty, it will\
\ be set to a date one month in the past from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-09T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of aggregated data (inclusive). The time period from startDate to endDate\
\ cannot exceed one month. If endDate is empty, it will be set to current\
\ date and startDate will be set to a date one month in the past."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-10T03:00:00+02:00
- name: consumptionGroup
in: query
description: The consumption group.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: industry
- name: priceArea
in: query
description: Price area filter
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: gridArea
in: query
description: Grid area filter
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: productionGroup
in: query
description: Production group filter
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: basicStatisticalUnit
in: query
description: Basic statistical unit
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: meteringPointTypeCode
in: query
description: Metering point type code
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid. Choose a different dataset under 'Examples'
to see different responses
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.MunicipalityResponse"
examples:
'[No dataset chosen]':
value: "{\"meta\":{\"created\":\"2023-10-01T12:00:00+02:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/municipalities\"\
},\"data\":[{\"type\":\"municipality\",\"id\":\"String\",\"attributes\"\
:{\"municipalityNumber\":\"String\",\"name\":\"String\",\"nameNo\"\
:\"String\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/municipalities/{id}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
deprecated: false
/energy-data/v0/municipalities{suffix}:
get:
tags:
- Municipality
summary: Get list of Municipalities and aggregations
operationId: municipalities_export
parameters:
- name: suffix
in: path
description: Suffix to specify type of data returned.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: .csv
- name: dataset
in: query
description: The dataset name.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: ConsumptionPerGroupMunicipalityHour
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"302":
description: CSV export redirect
headers:
Location:
description: Redirect target (download URL)
required: false
deprecated: false
schema:
type: string
title: String
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/municipalities{suffix}"
}
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
deprecated: false
/energy-data/v0/consumption-groups:
get:
tags:
- Consumption group
summary: List all consumption groups
description: Provides a list of all available consumption groups.
operationId: consumption_groups
parameters: []
responses:
"200":
description: Details for the specified consumption group.
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.ConsumptionGroupResponse"
examples:
Valid response:
value: "{\"meta\":{\"created\":\"2024-11-06T08:55:50+01:00\",\"\
lastUpdated\":\"2024-11-06T08:55:50+01:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/consumption-groups\"},\"\
data\":[{\"type\":\"consumption-groups\",\"id\":\"household\"\
,\"attributes\":{\"name\":\"Household\",\"description\":\"Meteringpoints\
\ that either have NACE Code XX (Household) or a combination of\
\ NACE Code 68.201 (House cooperative) and Consumption Code 35\
\ (Households)\"}},{\"type\":\"consumption-groups\",\"id\":\"\
cabin\",\"attributes\":{\"name\":\"Cabins and holiday properties\"\
,\"description\":\"Cabins and vacation homes nace XY\"}},{\"type\"\
:\"consumption-groups\",\"id\":\"primary\",\"attributes\":{\"\
name\":\"Primary Industry\",\"description\":\"All agriculture,\
\ forestry, fishing incl green houses, Division code 1-3 + Y\"\
}},{\"type\":\"consumption-groups\",\"id\":\"secondary\",\"attributes\"\
:{\"name\":\"Secondary Industry\",\"description\":\"All industry\
\ section codes B through F\"}},{\"type\":\"consumption-groups\"\
,\"id\":\"tertiary\",\"attributes\":{\"name\":\"Tertiary Industry\"\
,\"description\":\"All section codes G through U. Also includes\
\ all consumption that has incorrect or missing NACE Code.\"}},{\"\
type\":\"consumption-groups\",\"id\":\"industry\",\"attributes\"\
:{\"name\":\"Industry\",\"description\":\"Combination of Primary\
\ and Secondary Industry\"}},{\"type\":\"consumption-groups\"\
,\"id\":\"private\",\"attributes\":{\"name\":\"Private\",\"description\"\
:\"Combination of Household and Cabin\"}},{\"type\":\"consumption-groups\"\
,\"id\":\"business\",\"attributes\":{\"name\":\"Business\",\"\
description\":\"Same as Tertiary Industry\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
invalidRequest:
value: "{\"errors\":[{\"status\":\"400\",\"title\":\"Invalid request\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/consumption-groups\"}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedServerError:
value: "{\"errors\":[{\"status\":\"500\",\"title\":\"Unexpected\
\ server error. Try again later.\",\"detail\":\"creationTime:\
\ 2026-09-22T12:35:12+02:00\",\"links\":{\"self\":\"https://api.elhub.no/consumption-groups\"\
}}]}"
deprecated: false
/energy-data/v0/consumption-groups/{id}:
get:
tags:
- Consumption group
summary: Get a specific consumption group by ID
description: Provides details for a specific consumption group.
operationId: consumption_groups_id
parameters:
- name: id
in: path
description: A valid consumption group ID.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: household
responses:
"200":
description: Details for the specified consumption group.
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.ConsumptionGroupResponse"
examples:
Valid response:
value: "{\"meta\":{\"created\":\"2024-11-06T08:55:50+01:00\",\"\
lastUpdated\":\"2024-11-06T08:55:50+01:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/consumption-groups\"},\"\
data\":[{\"type\":\"consumption-groups\",\"id\":\"household\"\
,\"attributes\":{\"name\":\"Household\",\"description\":\"Meteringpoints\
\ that either have NACE Code XX (Household) or a combination of\
\ NACE Code 68.201 (House cooperative) and Consumption Code 35\
\ (Households)\"}},{\"type\":\"consumption-groups\",\"id\":\"\
cabin\",\"attributes\":{\"name\":\"Cabins and holiday properties\"\
,\"description\":\"Cabins and vacation homes nace XY\"}},{\"type\"\
:\"consumption-groups\",\"id\":\"primary\",\"attributes\":{\"\
name\":\"Primary Industry\",\"description\":\"All agriculture,\
\ forestry, fishing incl green houses, Division code 1-3 + Y\"\
}},{\"type\":\"consumption-groups\",\"id\":\"secondary\",\"attributes\"\
:{\"name\":\"Secondary Industry\",\"description\":\"All industry\
\ section codes B through F\"}},{\"type\":\"consumption-groups\"\
,\"id\":\"tertiary\",\"attributes\":{\"name\":\"Tertiary Industry\"\
,\"description\":\"All section codes G through U. Also includes\
\ all consumption that has incorrect or missing NACE Code.\"}},{\"\
type\":\"consumption-groups\",\"id\":\"industry\",\"attributes\"\
:{\"name\":\"Industry\",\"description\":\"Combination of Primary\
\ and Secondary Industry\"}},{\"type\":\"consumption-groups\"\
,\"id\":\"private\",\"attributes\":{\"name\":\"Private\",\"description\"\
:\"Combination of Household and Cabin\"}},{\"type\":\"consumption-groups\"\
,\"id\":\"business\",\"attributes\":{\"name\":\"Business\",\"\
description\":\"Same as Tertiary Industry\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
invalidRequest:
value: "{\"errors\":[{\"status\":\"400\",\"title\":\"Invalid request\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/consumption-groups/{id}\"}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedServerError:
value: "{\"errors\":[{\"status\":\"500\",\"title\":\"Unexpected\
\ server error. Try again later.\",\"detail\":\"creationTime:\
\ 2026-09-22T12:35:12+02:00\",\"links\":{\"self\":\"https://api.elhub.no/consumption-groups/{id}\"\
}}]}"
deprecated: false
/energy-data/v0/metering-points:
get:
tags:
- Metering points
summary: Get list of metering points
operationId: metering_points
parameters:
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: METERING_VALUES_HOUR_RESTRICTED
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of the dataset (inclusive). If empty, it will be set to a date\
\ based on the max date range allowed from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of the dataset (inclusive). If empty, it will be set to current date and\
\ startDate will be set to a date based on max date range for the dataset."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: insertDateTime
in: query
description: "Insert date time (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone)."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: usageDate
in: query
description: "Usage date (Format: yyyy-MM-dd) of the dataset. If empty, it\
\ will be set to current date."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2024-01-01
- name: meteringPointType
in: query
description: "Type of metering point. Possible values: E18, E19"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: E18
- name: granularity
in: query
description: "Granularity of the metering values. Possible values: INTERVAL,\
\ DAILY, MONTHLY, YEARLY"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: DAILY
- name: endUserId
in: query
description: End user identifier
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: includeAllMeasurements
in: query
description: Include all measurements (Y/N)
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: productionPlantId
in: query
description: The production plant identifier. Filter param for the PRODUCTION_REVENUE_PER_YEAR_RESTRICTED
dataset
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: productionGroup
in: query
description: "Production group identifier. Filter param for the PRODUCTION_REVENUE_PER_YEAR_RESTRICTED\
\ dataset. Allowed values: wind, hydro"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: includeSubGrid
in: query
description: "Subgrid filter for installed capacity. (Y/N). Defaults to Y.\
\ When Y, subgrids are included and accounting points representing the subgrid\
\ total installed capacity are excluded to avoid double counting."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.MeteringPointResponse"
examples:
Valid request:
value: "{\"meta\":{\"created\":\"2024-11-06T09:03:12+01:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/metering-points/{id}\"\
},\"data\":[{\"type\":\"metering-points\",\"id\":\"String\",\"\
relationships\":{\"grid-area\":{\"data\":{\"type\":\"grid-areas\"\
,\"id\":\"String\"}},\"grid-owner\":{\"data\":{\"type\":\"parties\"\
,\"id\":\"String\"}},\"price-area\":{\"data\":{\"type\":\"price-areas\"\
,\"id\":\"String\"}}},\"attributes\":{\"status\":\"Active\"}}],\"\
included\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"status\":\"Active\",\"eic\":\"String\"\
}},{\"type\":\"parties\",\"id\":\"String\",\"attributes\":{\"\
gln\":\"String\",\"partyTypes\":[\"GridOwner\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"}},{\"type\":\"price-areas\"\
,\"id\":\"String\",\"attributes\":{\"name\":\"String\",\"eic\"\
:\"String\",\"country\":\"NO\"}}]}"
"204":
description: No metering points found
headers: {}
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/metering-points"
}
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/metering-points/{id}:
get:
tags:
- Metering points
summary: Get metering point by ID
operationId: metering_points_id
parameters:
- name: id
in: path
description: |-
Unique identification of Metering point. More info https://gs1.no/malepunkt-id/
Format: String with 18 digits
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: "707057500999999999"
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: METERING_VALUES_HOUR_RESTRICTED
- name: startDate
in: query
description: "Start date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone) of the dataset (inclusive). If empty, it will be set to a date\
\ based on the max date range allowed from endDate."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: endDate
in: query
description: "End date (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo timezone)\
\ of the dataset (inclusive). If empty, it will be set to current date and\
\ startDate will be set to a date based on max date range for the dataset."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: insertDateTime
in: query
description: "Insert date time (Format: yyyy-MM-dd'T'HH:mm:ssXXX at Europe/Oslo\
\ timezone)."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-15T03:00:00+02:00
- name: usageDate
in: query
description: "Usage date (Format: yyyy-MM-dd) of the dataset. If empty, it\
\ will be set to current date."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2024-01-01
- name: meteringPointType
in: query
description: "Type of metering point. Possible values: E18, E19"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: E18
- name: granularity
in: query
description: "Granularity of the metering values. Possible values: INTERVAL,\
\ DAILY, MONTHLY, YEARLY"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: DAILY
- name: endUserId
in: query
description: End user identifier
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: includeAllMeasurements
in: query
description: Include all measurements (Y/N)
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: productionPlantId
in: query
description: The production plant identifier. Filter param for the PRODUCTION_REVENUE_PER_YEAR_RESTRICTED
dataset
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: productionGroup
in: query
description: "Production group identifier. Filter param for the PRODUCTION_REVENUE_PER_YEAR_RESTRICTED\
\ dataset. Allowed values: wind, hydro"
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: includeSubGrid
in: query
description: "Subgrid filter for installed capacity. (Y/N). Defaults to Y.\
\ When Y, subgrids are included and accounting points representing the subgrid\
\ total installed capacity are excluded to avoid double counting."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: 'Bearer '."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the on behalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.MeteringPointResponse"
examples:
Valid request:
value: "{\"meta\":{\"created\":\"2024-11-06T09:03:12+01:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/metering-points/{id}\"\
},\"data\":[{\"type\":\"metering-points\",\"id\":\"String\",\"\
relationships\":{\"grid-area\":{\"data\":{\"type\":\"grid-areas\"\
,\"id\":\"String\"}},\"grid-owner\":{\"data\":{\"type\":\"parties\"\
,\"id\":\"String\"}},\"price-area\":{\"data\":{\"type\":\"price-areas\"\
,\"id\":\"String\"}}},\"attributes\":{\"status\":\"Active\"}}],\"\
included\":[{\"type\":\"grid-areas\",\"id\":\"String\",\"attributes\"\
:{\"name\":\"String\",\"status\":\"Active\",\"eic\":\"String\"\
}},{\"type\":\"parties\",\"id\":\"String\",\"attributes\":{\"\
gln\":\"String\",\"partyTypes\":[\"GridOwner\"],\"name\":\"String\"\
,\"organisationNumber\":\"String\"}},{\"type\":\"price-areas\"\
,\"id\":\"String\",\"attributes\":{\"name\":\"String\",\"eic\"\
:\"String\",\"country\":\"NO\"}}]}"
"204":
description: No metering point found
headers: {}
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/metering-points/{id}"
}
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/metering-points/{id}/address/(Authorize token.validate):
get:
tags:
- Metering points
summary: Get metering point geo data by ID
operationId: metering_points_id_address
parameters:
- name: id
in: path
description: |-
Unique identification of Metering point. More info https://gs1.no/malepunkt-id/
Format: String with 18 digits
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: "707057500999999999"
- name: Authorization
in: header
description: Internal bearer token.
required: true
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.MeteringPointResponse"
examples:
Valid request:
value: |-
{
"meta": {
"created": "2026-05-08T09:29:19+02:00"
},
"links": {
"self": "https://api.elhub.cloud/energy-data/v0/metering-points/301476200000000032/address"
},
"data": [
{
"type": "metering-points",
"id": "707057500999999999",
"attributes": {
"meteringPointCoordinate": [
{
"meteringPointId": "707057500999999999",
"postalCode": "0150",
"cadastreAddressId": 123456,
"cadastreMatchStatusCode": "EXACT",
"positionDerivedFrom": "CADASTRE",
"longitude": 10.7522,
"latitude": 59.9139,
"meteringPointLongitude": 10.7525,
"meteringPointLatitude": 59.9140,
"cadastreLongitude": 10.7520,
"cadastreLatitude": 59.9138,
"postalCodeLongitude": 10.7500,
"postalCodeLatitude": 59.9150,
"distancePosToMp": 5,
"distancePosToCadastre": 10,
"distancePosToPostal": 25,
"distanceMpToCadastre": 8,
"distanceMpToPostal": 30,
"distanceCadastreToPostal": 35,
"insertTime": "2024-10-28T14:15:45+01:00",
"lastUpdateTime": "2024-10-28T14:15:45+01:00"
}
]
}
}
]
}
"204":
description: No metering point geo data found
headers: {}
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Invalid request:
value: |-
{
"errors": [
{
"status": "400",
"title": "String",
"detail": "creationTime: 2024-10-28T14:15:45+01:00",
"links": {
"self": "https://api.elhub.no/energy-data/v0/metering-points/{id}/address"
}
}
]
}
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Missing authentication:
value: |-
{
"errors": [
{
"status": "401",
"title": "String",
"detail": "creationTime: 2024-10-28T14:40:21+01:00"
}
]
}
"403":
description: When the request lacks valid authorization
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unauthorized request:
value: |-
{
"errors": [
{
"status": "403",
"title": "String",
"detail": "creationTime: 2024-10-28T14:41:55+01:00"
}
]
}
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
Unexpected server error:
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/production-groups:
get:
tags:
- Production group
summary: List of production groups
operationId: production_groups
parameters: []
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.ProductionGroupResponse"
examples:
validRequest:
summary: Valid request
value: "{\"meta\":{\"created\":\"2024-11-06T09:12:30+01:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/production-groups\"\
},\"data\":[{\"type\":\"production-groups\",\"id\":\"solar\",\"\
attributes\":{\"name\":\"Solar\",\"description\":\"Unit in which\
\ solar energy is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"hydro\",\"attributes\"\
:{\"name\":\"Hydro\",\"description\":\"Unit in which moving water\
\ energy is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"wind\",\"attributes\"\
:{\"name\":\"Wind\",\"description\":\"Unit in which wind energy\
\ is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"thermal\",\"attributes\"\
:{\"name\":\"Thermal\",\"description\":\"Unit in which heat energy\
\ is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"nuclear\",\"attributes\"\
:{\"name\":\"Nuclear\",\"description\":\"Unit in which the heat\
\ source is a nuclear reactor with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"other\",\"attributes\"\
:{\"name\":\"Other\",\"description\":\"Other unspecified technology.\"\
}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
invalidRequest:
value: "{\"errors\":[{\"status\":\"400\",\"title\":\"Invalid request\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/production-groups\"}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedServerError:
summary: Unexpected server error
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/production-groups/{id}:
get:
tags:
- Production group
summary: Get a specific production group by ID
operationId: production_groups_id
parameters:
- name: id
in: path
description: A valid production group id returned from /production-groups
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: solar
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.ProductionGroupResponse"
examples:
validRequest:
summary: Valid request
value: "{\"meta\":{\"created\":\"2024-11-06T09:12:30+01:00\"},\"\
links\":{\"self\":\"https://api.elhub.no/energy-data/v0/production-groups\"\
},\"data\":[{\"type\":\"production-groups\",\"id\":\"solar\",\"\
attributes\":{\"name\":\"Solar\",\"description\":\"Unit in which\
\ solar energy is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"hydro\",\"attributes\"\
:{\"name\":\"Hydro\",\"description\":\"Unit in which moving water\
\ energy is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"wind\",\"attributes\"\
:{\"name\":\"Wind\",\"description\":\"Unit in which wind energy\
\ is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"thermal\",\"attributes\"\
:{\"name\":\"Thermal\",\"description\":\"Unit in which heat energy\
\ is converted to electricity with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"nuclear\",\"attributes\"\
:{\"name\":\"Nuclear\",\"description\":\"Unit in which the heat\
\ source is a nuclear reactor with unspecified equipment/devices.\"\
}},{\"type\":\"production-groups\",\"id\":\"other\",\"attributes\"\
:{\"name\":\"Other\",\"description\":\"Other unspecified technology.\"\
}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
invalidRequest:
value: "{\"errors\":[{\"status\":\"400\",\"title\":\"Invalid request\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/production-groups/{id}\"}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedServerError:
summary: Unexpected server error
value: |-
{
"errors": [
{
"status": "500",
"title": "String",
"detail": "creationTime: 2024-10-28T14:38:13+01:00"
}
]
}
deprecated: false
/energy-data/v0/updates:
get:
tags:
- Updates
summary: Provides updates about changes in dataset
parameters:
- name: lastUpdated
in: query
description: "Updates that occurred on or after the specified `lastUpdated`\
\ time (Format: `yyyy-MM-dd'T'HH:mm:ssXXX` at Europe/Oslo timezone). If\
\ `lastUpdated` is not provided, it defaults to 24 hours before the current\
\ time."
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: 2023-04-05T03:00:00+02:00
- name: dataset
in: query
description: The dataset name.
required: false
deprecated: false
explode: false
schema:
type: string
title: String
example: consumption_per_group_mba_hour
responses:
"200":
description: When request is valid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.response.UpdatesResponse"
examples:
consumption_per_group_mba_hour:
summary: consumption_per_group_mba_hour
value: "{\"meta\":{\"created\":\"2024-11-06T09:28:20+01:00\",\"\
lastUpdated\":\"2024-11-06T09:28:20+01:00\"},\"links\":{\"self\"\
:\"https://api.elhub.no/energy-data/v0/updates?dataset=consumption_per_group_mba_hour\"\
},\"data\":[{\"type\":\"updates\",\"id\":\"20241030_consumption_per_group_mba_hour\"\
,\"links\":{\"href\":\"https://api.elhub.no/energy-data/v0/price-areas?dataset=consumption_per_group_mba_hour&startDate=2024-10-30&endDate=2024-10-31\"\
},\"attributes\":{\"dataset\":\"consumption_per_group_mba_hour\"\
,\"entity\":\"price-areas\",\"usageDate\":\"2024-10-30\",\"updateTime\"\
:\"2024-11-05T13:41:33+01:00\"}},{\"type\":\"updates\",\"id\"\
:\"20241031_consumption_per_group_mba_hour\",\"links\":{\"href\"\
:\"https://api.elhub.no/energy-data/v0/price-areas?dataset=consumption_per_group_mba_hour&startDate=2024-10-31&endDate=2024-11-01\"\
},\"attributes\":{\"dataset\":\"consumption_per_group_mba_hour\"\
,\"entity\":\"price-areas\",\"usageDate\":\"2024-10-31\",\"updateTime\"\
:\"2024-11-05T13:41:36+01:00\"}}]}"
"400":
description: When the request is invalid
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
invalidRequest:
value: "{\"errors\":[{\"status\":\"400\",\"title\":\"Invalid request\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/updates\"}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedServerError:
value: "{\"errors\":[{\"status\":\"500\",\"title\":\"Unexpected\
\ server error. Try again later.\",\"detail\":\"creationTime:\
\ 2026-09-22T12:35:12+02:00\",\"links\":{\"self\":\"https://api.elhub.no/updates\"\
}}]}"
deprecated: false
/energy-data/v0/secure-ping:
get:
tags:
- Secure ping
summary: Secure ping endpoint
parameters:
- name: Authorization
in: header
description: "Include the bearer token obtained from Maskinporten in the Authorization\
\ header. Format: `Bearer `."
required: true
deprecated: false
explode: false
schema:
type: string
title: String
example: Bearer eyJhbGciOi...
- name: X-Elhub-GLN
in: header
description: Sender (Own) GLN value
required: false
deprecated: false
explode: false
schema:
type: string
title: String
- name: On-Behalf-Of
in: header
description: GLN value of the onbehalf party
required: false
deprecated: false
explode: false
schema:
type: string
title: String
responses:
"200":
description: Successful ping response when the token is valid
headers: {}
content:
application/json:
schema:
type: string
title: String
examples:
pong:
summary: Pong response
value: "{\"message\": \"Pong! Elhoo.\"}"
"401":
description: The request lacks valid authentication credentials
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unauthorized:
value: "{\"errors\":[{\"status\":\"401\",\"title\":\"Unauthorized\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/energy-data/v0/secure-ping\"\
}}]}"
"403":
description: Authenticated but not authorized to access the resource
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
forbidden:
value: "{\"errors\":[{\"status\":\"403\",\"title\":\"Forbidden\"\
,\"detail\":\"creationTime: 2026-09-22T12:35:12+02:00\",\"links\"\
:{\"self\":\"https://api.elhub.no/energy-data/v0/secure-ping\"\
}}]}"
"500":
description: Unexpected server error
headers: {}
content:
application/vnd.api+json:
schema:
$ref: "#/components/schemas/jsonapi.Error"
examples:
unexpectedError:
value: "{\"errors\":[{\"status\":\"500\",\"title\":\"Unexpected\
\ server error. Try again later.\",\"detail\":\"creationTime:\
\ 2026-09-22T12:35:12+02:00\",\"links\":{\"self\":\"https://api.elhub.no/energy-data/v0/secure-ping\"\
}}]}"
deprecated: false
components:
schemas:
no.elhub.ds.energy.data.models.EntityMeta:
type: object
properties:
datasets:
type:
- "null"
- array
description: List of datasets
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.DataSetMeta"
title: List
description:
type:
- "null"
- string
description: Short description for the entity
title: String
id:
type:
- "null"
- string
description: Entity identification string
title: String
noOfDataSets:
type:
- "null"
- integer
format: int32
description: Number of datasets belonging to this entity
title: Int
title: EntityMeta
no.elhub.ds.energy.data.models.DataSetMeta:
type: object
properties:
columns:
type: array
description: List of database columns
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.DatasetAttributes"
title: List
datePolicyWithId:
type:
- "null"
- string
description: Date policy used when request contains an entity id
title: String
datePolicyWithoutId:
type:
- "null"
- string
description: Date policy used when request does not contain an entity id
title: String
description:
type:
- "null"
- string
description: Dataset description
title: String
exportable:
type: boolean
description: Is the dataset exportable
title: Boolean
filters:
type:
- "null"
- array
description: Filters
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.DataSetFilter"
title: List
maxDateRange:
type: string
description: Maximum date range
title: String
name:
type:
- "null"
- string
description: Dataset name
title: String
openDataSet:
type:
- "null"
- boolean
description: Is the dataset open to access
title: Boolean
resolution:
type: string
description: "Dataset resolution: can be daily, hourly, etc."
title: String
routeAvailability:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.RouteAvailability"
description: Route availability
scopes:
type:
- "null"
- array
description: Scopes
items:
type: string
title: String
title: List
required:
- columns
- exportable
- maxDateRange
- resolution
- routeAvailability
title: DataSetMeta
no.elhub.ds.energy.data.models.DatasetAttributes:
type: object
properties:
description:
type: string
title: String
name:
type: string
title: String
type:
type: string
title: String
required:
- description
- name
- type
title: DatasetAttributes
no.elhub.ds.energy.data.models.DataSetFilter:
type: object
properties:
defaultValue:
type:
- "null"
- string
description: Default value for the filter
title: String
name:
type: string
description: Filter parameter name
title: String
values:
type:
- "null"
- string
description: Allowed values for the filter
title: String
required:
- name
title: DataSetFilter
no.elhub.ds.energy.data.models.RouteAvailability:
type: string
enum:
- ALL
- BASE
- ID
title: RouteAvailability
no.elhub.ds.energy.data.models.response.MetaResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
entity:
description: Entity dataset
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.EntityMeta"
lastUpdatedTime:
type: string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
required:
- creationTime
- lastUpdatedTime
title: MetaResponse
jsonapi.Links:
type: object
properties:
members:
type: object
additionalProperties:
$ref: "#/components/schemas/jsonapi.Link"
title: "Map"
required:
- members
title: Links
jsonapi.Link:
anyOf:
- $ref: "#/components/schemas/jsonapi.Link.LinkObject"
- $ref: "#/components/schemas/jsonapi.Link.URI"
title: Link
jsonapi.Link.LinkObject:
type: object
properties:
describedBy:
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Link"
href:
type: string
title: String
hreflang:
type:
- "null"
- array
items:
type: string
title: String
title: List
meta:
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Meta"
rel:
type:
- "null"
- string
title: String
title:
type:
- "null"
- string
title: String
type:
type:
- "null"
- string
title: String
required:
- href
title: Link.LinkObject
jsonapi.Meta:
type: object
properties:
members:
type: object
additionalProperties:
type: object
title: Any
title: "Map"
required:
- members
title: Meta
jsonapi.Link.URI:
type: object
properties:
value:
type: string
title: String
required:
- value
title: Link.URI
jsonapi.Error.Source:
type: object
properties:
header:
type:
- "null"
- string
title: String
parameter:
type:
- "null"
- string
title: String
pointer:
type:
- "null"
- string
title: String
title: Error.Source
jsonapi.Error:
type: object
properties:
code:
type:
- "null"
- string
title: String
detail:
type:
- "null"
- string
title: String
id:
type:
- "null"
- string
title: String
links:
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Links"
meta:
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Meta"
source:
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Error.Source"
status:
type:
- "null"
- string
title: String
title:
type:
- "null"
- string
title: String
title: Error
no.elhub.ds.energy.data.models.Party:
type: object
properties:
gln:
type: string
description: Party GLN number
title: String
gridArea:
type:
- "null"
- array
description: Grid areas
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.GridArea"
title: List
id:
type:
- "null"
- string
description: Party identification string
title: String
links:
description: Links object
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Links"
name:
type: string
description: Party name
title: String
organisationNumber:
type:
- "null"
- string
description: Party organisation number
title: String
partyTypes:
type: array
description: Party types for the party
items:
type: string
title: String
title: List
required:
- gln
- name
- partyTypes
title: Party
no.elhub.ds.energy.data.models.gridarea.GridArea:
type: object
properties:
completenessDailyPerBalanceSupplierMga:
type:
- "null"
- array
description: List of completeness daily per balance supplier MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.CompletenessDailyPerBalanceSupplierMga"
title: List
completenessDailyPerMga:
type:
- "null"
- array
description: List of completeness daily per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.CompletenessDailyPerMga"
title: List
consumptionPerBalanceSupplierMgaHour:
type:
- "null"
- array
description: List of consumption hourly per balance supplier MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.ConsumptionPerBalanceSupplierMgaHour"
title: List
consumptionPerGroupMgaHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per group per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.ConsumptionPerGroupMgaHour"
title: List
consumptionPerHourBalanceSupplierGroupMgaConsumptionTypeCode:
type:
- "null"
- array
description: List of consumption hourly per balance supplier per balance
supplier per consumption group type per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.ConsumptionPerHourBalanceSupplierGroupMgaConsumptionTypeCode"
title: List
costPerMgaMonth:
type:
- "null"
- array
description: List of cost per MGA per month
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.CostPerMgaMonth"
title: List
costPerMgaMunicipalityGroupTypeMonth:
type:
- "null"
- array
description: "List of monthly calculated Norgespris / Strømstøtte cost per\
\ grid area, municipality and group type"
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.CostPerMgaMunicipalityGroupTypeMonth"
title: List
eic:
type:
- "null"
- string
description: Grid area EIC
title: String
endTime:
type:
- "null"
- string
description: Grid area end time
title: String
exchangePerMgaHour:
type:
- "null"
- array
description: List of hourly aggregated exchange per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.ExchangePerMgaHour"
title: List
gridOwner:
description: Grid owner connected to this metering point entity
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.Party"
id:
type:
- "null"
- string
description: Grid area identification string
title: String
links:
description: Links object
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Links"
lossPerMgaHour:
type:
- "null"
- array
description: List of hourly aggregated loss per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.LossPerMgaHour"
title: List
missingReadsPerMeteringPointPerMgaDaily:
type:
- "null"
- array
description: List of missing reads per metering point per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.MeteringPointMissingReadsPerMgaDaily"
title: List
name:
type: string
description: Grid area name
title: String
priceArea:
description: Price area from this metering point entity
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.PriceArea"
productionPerBalanceSupplierMeteringPointTypeMgaHour:
type:
- "null"
- array
description: List of hourly aggregated production per balance supplier per
metering point type per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.ProductionPerBalanceSupplierMeteringPointTypeMgaHour"
title: List
productionPerHourBalanceSupplierGroupMeteringPointTypeMga:
type:
- "null"
- array
description: List of hourly aggregated production per balance supplier per
production group per metering point type per MGA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.ProductionPerHourBalanceSupplierGroupMeteringPointTypeMga"
title: List
startTime:
type:
- "null"
- string
description: Grid area start time
title: String
status:
type:
- "null"
- string
description: Grid area status
title: String
required:
- name
title: GridArea
no.elhub.ds.energy.data.models.gridarea.CompletenessDailyPerBalanceSupplierMga:
type: object
properties:
actualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received
title: Int
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier
title: String
combinedConsumptionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption on combined
metering points (E19)
title: Int
combinedConsumptionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
on combined metering points (E19)
title: Int
combinedProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for production on combined
metering points (E19)
title: Int
combinedProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for production
on combined metering points (E19)
title: Int
consumptionFifteenActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 15 min resolution
title: Int
consumptionFifteenExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 15 min resolution
title: Int
consumptionSixtyActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 60 min resolution
title: Int
consumptionSixtyExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 60 min resolution
title: Int
estimatedAnnualConsumptionAll:
type:
- "null"
- integer
format: int64
description: Sum of estimated annual consumption of all metering point.
E17 and E19 only. Direction Out only.
title: Long
estimatedAnnualConsumptionCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of estimated annual consumption of all completed metering\
\ point, meaning number of received reads are equal to expected. E17 and\
\ E19 only. Direction Out only."
title: Long
estimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
does not have measured quality. (Also included in actual interval count)
title: Int
expectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received
title: Int
finalEstimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has final estimated quality.(Also included in actual interval count)
title: Int
gridArea:
type:
- "null"
- string
description: The grid area
title: String
installedCapacityAll:
type:
- "null"
- integer
format: int64
description: Sum of installed capacity of all metering point. E18 and E19
only. Direction In only.
title: Long
installedCapacityCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of installed capacity of all completed metering point,\
\ meaning number of received reads are equal to expected. E18 and E19\
\ only. Direction In only."
title: Long
largeProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for large production
(E18) metering points
title: Int
largeProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for large production
(E18) metering points
title: Int
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
loadLimitAll:
type:
- "null"
- integer
format: int64
description: Sum of load limit of all metering point. E17 and E19 only.
Direction Out only.
title: Long
loadLimitCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of load limit of all completed metering point, meaning\
\ number of received reads are equal to expected. E17 and E19 only. Direction\
\ Out only."
title: Long
meteredIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has metered(highest) quality.(Also included in actual interval count)
title: Int
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
notCompleteMeteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points where actually received metering
value count is less than expected
title: Int
priceArea:
type:
- "null"
- string
description: The price area
title: String
temporaryIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has temporary quality.(Also included in actual interval count)
title: Int
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: CompletenessDailyPerBalanceSupplierMga
no.elhub.ds.energy.data.models.gridarea.CompletenessDailyPerMga:
type: object
properties:
actualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received. Excluding reads exchange
points in neighbouring grid areas
title: Int
actualWithAdjacentExchangeIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received including reads from
exchange points in neighbouring grid areas
title: Int
adjacentExchangeActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for exchange points (E20)
in adjacent grid areas
title: Int
adjacentExchangeExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for exchange points
(E20) in adjacent grid areas
title: Int
combinedConsumptionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption on combined
metering points (E19)
title: Int
combinedConsumptionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
on combined metering points (E19)
title: Int
combinedProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for production on combined
metering points (E19)
title: Int
combinedProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for production
on combined metering points (E19)
title: Int
consumptionFifteenActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 15 min resolution
title: Int
consumptionFifteenExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 15 min resolution
title: Int
consumptionSixtyActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 60 min resolution
title: Int
consumptionSixtyExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 60 min resolution
title: Int
estimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
does not have measured quality. (Also included in actual interval count)
title: Int
exchangeActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for exchange points (E20)
in grid area. Excluding exchange points in neighbouring grid areas
title: Int
exchangeExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for exchange points
(E20) in grid area. Excluding exchange points in neighbouring grid areas
title: Int
expectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received. Excluding reads
exchange points in neighbouring grid areas
title: Int
expectedWithAdjacentExchangeIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received including reads
from exchange points in neighbouring grid areas
title: Int
finalEstimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has final estimated quality.(Also included in actual interval count)
title: Int
gridArea:
type:
- "null"
- string
description: The grid area
title: String
installedCapacityAll:
type:
- "null"
- integer
format: int64
description: Sum of installed capacity of all metering point. E18 and E19
only. Direction In only.
title: Long
installedCapacityCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of installed capacity of all completed metering point,\
\ meaning number of received reads are equal to expected. E18 and E19\
\ only. Direction In only."
title: Long
largeProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for large production
(E18) metering points
title: Int
largeProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for large production
(E18) metering points
title: Int
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
loadLimitAll:
type:
- "null"
- integer
format: int64
description: Sum of load limit of all metering point. E17 and E19 only.
Direction Out only.
title: Long
loadLimitCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of load limit of all completed metering point, meaning\
\ number of received reads are equal to expected. E17 and E19 only. Direction\
\ Out only."
title: Long
meteredIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has metered(highest) quality.(Also included in actual interval count)
title: Int
meteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points. Excluding exchange points in
neighbouring grid areas
title: Int
notCompleteAdjacentExchangePointCount:
type:
- "null"
- integer
format: int32
description: The number of exchange points reported from neighbouring grid
where actually received metering value count is less than expected
title: Int
notCompleteMeteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points where actually received metering
value count is less than expected
title: Int
priceArea:
type:
- "null"
- string
description: The price area
title: String
temporaryIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has temporary quality.(Also included in actual interval count)
title: Int
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: CompletenessDailyPerMga
no.elhub.ds.energy.data.models.gridarea.ConsumptionPerBalanceSupplierMgaHour:
type: object
properties:
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
gridArea:
type:
- "null"
- string
description: The grid area.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate.
title: Int
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
title: ConsumptionPerBalanceSupplierMgaHour
no.elhub.ds.energy.data.models.gridarea.ConsumptionPerGroupMgaHour:
type: object
properties:
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
gridArea:
type:
- "null"
- string
description: The grid area.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ConsumptionPerGroupMgaHour
no.elhub.ds.energy.data.models.gridarea.ConsumptionPerHourBalanceSupplierGroupMgaConsumptionTypeCode:
type: object
properties:
balanceSupplier:
type:
- "null"
- string
description: The balance supplier
title: String
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
consumptionTypeCode:
type:
- "null"
- string
description: The consumption type code
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval
title: String
gridArea:
type:
- "null"
- string
description: The grid area
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
priceArea:
type:
- "null"
- string
description: Price area of the aggregate.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval
title: String
title: ConsumptionPerHourBalanceSupplierGroupMgaConsumptionTypeCode
no.elhub.ds.energy.data.models.gridarea.CostPerMgaMonth:
type: object
properties:
consumptionKwh:
description: Sum of consumption
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
consumptionKwhNorwayPrice:
description: Sum of consumption for metering points when on Norway price
and below threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
consumptionKwhSpotPrice:
description: Sum of consumption for metering points when on spot price
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
consumptionKwhSupportPrice:
description: Sum of consumption for metering points when on support price
and below threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
costNorwayPrice:
description: Cost of consumption in NOK/kWh when on Norway price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
costSpotPrice:
description: Cost of consumption in NOK/kWh when on spot price
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
costSupportPrice:
description: Cost of consumption in NOK/kWh when on support price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
countEligibleForNorwayPrice:
type:
- "null"
- integer
format: int32
description: Number of metering points eligible for Norway price at end
of month
title: Int
countEligibleForSupportPrice:
type:
- "null"
- integer
format: int32
description: Number of metering points eligible for support price at end
of month
title: Int
countNorwayPriceContract:
type:
- "null"
- integer
format: int32
description: Number of metering points with Norway price at least one day
in month
title: Int
countNorwayPriceContractEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points with Norway price last day of month
title: Int
countSupportPriceContract:
type:
- "null"
- integer
format: int32
description: Number of metering points with support price at least one day
in month
title: Int
countSupportPriceContractEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points with support price last day of month
title: Int
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
supportNorwayPrice:
description: Support amount for consumption when on Norway price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
supportSupportPrice:
description: Support amount for consumption when on support price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
totalCost:
description: Total cost of consumption in NOK
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
yearMonth:
type:
- "null"
- integer
format: int32
description: Year and month of the aggregate in YYYYMM format
title: Int
title: CostPerMgaMonth
java.math.BigDecimal:
type: object
properties: {}
title: BigDecimal
no.elhub.ds.energy.data.models.gridarea.CostPerMgaMunicipalityGroupTypeMonth:
type: object
properties:
consumptionKwh:
description: Sum of consumption
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
consumptionKwhNorwayPrice:
description: Sum of consumption for metering points when on Norway price
and below threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
consumptionKwhSpotPrice:
description: Sum of consumption for metering points when on spot price
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
consumptionKwhSupportPrice:
description: Sum of consumption for metering points when on support price
and below threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
costNorwayPrice:
description: Cost of consumption in NOK when on Norway price and below threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
costSpotPrice:
description: Cost of consumption in NOK when on spot price
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
costSupportPrice:
description: Cost of consumption in NOK when on support price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
countEligibleForNorwayPriceEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points eligible for Norway price at end
of month
title: Int
countEligibleForSupportPriceEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points eligible for support price at end
of month
title: Int
countNorwayPriceContract:
type:
- "null"
- integer
format: int32
description: Number of metering points with Norway price at least one day
in month
title: Int
countNorwayPriceContractEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points with Norway price last day of month
title: Int
countSupportPriceContract:
type:
- "null"
- integer
format: int32
description: Number of metering points with support price at least one day
in month
title: Int
countSupportPriceContractEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points with support price last day of month
title: Int
diffCompSpotMinusSupportPrice:
description: Difference in compensation between spot price and support price
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
diffCompSupportMinusNorwayPrice:
description: Difference in compensation between support price and Norway
price
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
groupType:
type:
- "null"
- string
description: "Group type. Borettslag, Grendalag, Household, Cabin, or Other"
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points in this group
title: Int
meteringPointCountEndOfMonth:
type:
- "null"
- integer
format: int32
description: Number of metering points in the group at end of month
title: Int
municipalityId:
type:
- "null"
- string
description: Municipality identification string
title: String
municipalityName:
type:
- "null"
- string
description: Municipality name
title: String
naceCode:
type:
- "null"
- string
description: The NACE code for the aggregate.
title: String
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
supportNorwayPrice:
description: Support amount for consumption when on Norway price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
supportSupportPrice:
description: Support amount for consumption when on support price and below
threshold
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
totalCost:
description: Total cost of consumption in NOK
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
yearMonth:
type:
- "null"
- integer
format: int32
description: Year and month of the aggregate in YYYYMM format
title: Int
title: CostPerMgaMunicipalityGroupTypeMonth
no.elhub.ds.energy.data.models.gridarea.ExchangePerMgaHour:
type: object
properties:
adjacentGridArea:
type:
- "null"
- string
description: The adjacent grid area.
title: String
adjacentPriceArea:
type:
- "null"
- string
description: The adjacent price area
title: String
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
exchangeInQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the IN direction
title: Float
exchangeOutQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the OUT direction
title: Float
gridArea:
type:
- "null"
- string
description: The grid area.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
priceArea:
type:
- "null"
- string
description: The price area
title: String
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ExchangePerMgaHour
no.elhub.ds.energy.data.models.gridarea.LossPerMgaHour:
type: object
properties:
calculatedLossFraction:
type: number
format: float
description: calculatedLossQuantityKwh divided by netInfeedQuantityKwh.
Multiply with 100 to get percentage. Will be 0 if net infeed is 0.
title: Float
calculatedLossQuantityKwh:
type:
- "null"
- number
format: float
description: The loss in kwh. Includes no balance supplier loss. Calculated
as production + exchange in - exchange out - consumption.
title: Float
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
gridArea:
type:
- "null"
- string
description: The grid area.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
netInfeedQuantityKwh:
type:
- "null"
- number
format: float
description: The net infeed in kwh. Calculated as production + exchange
in - exchange out
title: Float
priceArea:
type:
- "null"
- string
description: The price area
title: String
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
required:
- calculatedLossFraction
title: LossPerMgaHour
no.elhub.ds.energy.data.models.gridarea.MeteringPointMissingReadsPerMgaDaily:
type: object
properties:
actualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received
title: Int
adjacentGridArea:
type:
- "null"
- string
description: The adjacent grid area
title: String
direction:
type: string
description: 'The direction. In(production) or Out(consumption). '
title: String
estimatedAnnualConsumption:
type:
- "null"
- integer
format: int32
description: Estimated annual consumption
title: Int
estimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of estimated intervals
title: Int
expectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received
title: Int
finalEstimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of final estimated intervals
title: Int
gridArea:
type: string
description: The grid area
title: String
installedCapacity:
type:
- "null"
- integer
format: int32
description: Installed capacity
title: Int
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time
title: String
loadLimit:
type:
- "null"
- integer
format: int32
description: Load limit
title: Int
meteredIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of metered intervals
title: Int
meteringPointId:
type: string
description: The metering point
title: String
meteringPointTypeCode:
type: string
description: The code of the MeteringPointType. E.g. E17
title: String
resolution:
type:
- "null"
- string
description: The resolution of the measurement. PT60M(60 min) or PT15M(15
min) resolution
title: String
temporaryIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of temporary intervals
title: Int
usageDateId:
type: integer
format: int32
description: The usage date
title: Int
required:
- direction
- gridArea
- meteringPointId
- meteringPointTypeCode
- usageDateId
title: MeteringPointMissingReadsPerMgaDaily
no.elhub.ds.energy.data.models.pricearea.PriceArea:
type: object
properties:
completenessDailyPerBalanceSupplierMba:
type:
- "null"
- array
description: List of completeness daily per balance supplier MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.CompletenessDailyPerBalanceSupplierMba"
title: List
completenessDailyPerMba:
type:
- "null"
- array
description: List of completeness daily per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.CompletenessDailyPerMba"
title: List
consumptionPerBalanceResponsibleMbaHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per balance responsible
per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ConsumptionPerBalanceResponsibleMbaHour"
title: List
consumptionPerBalanceSupplierMbaHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per balance supplier
per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ConsumptionPerBalanceSupplierMbaHour"
title: List
consumptionPerGroupMbaHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per group per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ConsumptionPerGroupMbaHour"
title: List
country:
type:
- "null"
- string
description: Price area country
title: String
eic:
type:
- "null"
- string
description: Price area EIC
title: String
exchangePerMba15Min:
type:
- "null"
- array
description: List of 15 minute aggregated exchange per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ExchangePerMba15Min"
title: List
exchangePerMbaHour:
type:
- "null"
- array
description: List of hourly aggregated exchange per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ExchangePerMbaHour"
title: List
id:
type:
- "null"
- string
description: Price area ID
title: String
installedCapacityPerMeteringPointTypeGroupMbaDaily:
type:
- "null"
- array
description: List of installed capacity per metering point type group per
MBA daily
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.InstalledCapacityPerMeteringPointTypeGroupMbaDaily"
title: List
links:
description: Links object
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Links"
lossPerMbaHour:
type:
- "null"
- array
description: List of hourly aggregated loss per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.LossPerMbaHour"
title: List
meteringValueComparisonEacPerMonth:
type:
- "null"
- array
description: List of metering value comparison EAC per month
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.MeteringValueComparisonEacPerMonth"
title: List
name:
type:
- "null"
- string
description: Price area name
title: String
norgesprisConsumptionPerGroupEacMba:
type:
- "null"
- array
description: List of Norgespris consumption per group EAC MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.NorgesprisConsumptionPerGroupEacMba"
title: List
productionPerBalanceResponsibleMeteringPointTypeCodeMbaHour:
type:
- "null"
- array
description: List of hourly aggregated production per balance responsible
per metering point type per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ProductionPerBalanceResponsibleMeteringPointTypeCodeMbaHour"
title: List
productionPerBalanceSupplierMeteringPointTypeCodeMbaHour:
type:
- "null"
- array
description: List of hourly aggregated production per balance supplier per
metering point type per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ProductionPerBalanceSupplierMeteringPointTypeCodeMbaHour"
title: List
productionPerGroupMba15Min:
type:
- "null"
- array
description: List of 15 minute aggregated production per group per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ProductionPerGroupMba15Min"
title: List
productionPerGroupMbaHour:
type:
- "null"
- array
description: List of hourly aggregated production per group per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ProductionPerGroupMbaHour"
title: List
productionPerMba15Min:
type:
- "null"
- array
description: List of 15 minute aggregated production per MBA
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.ProductionPerMba15Min"
title: List
title: PriceArea
no.elhub.ds.energy.data.models.pricearea.CompletenessDailyPerBalanceSupplierMba:
type: object
properties:
actualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received
title: Int
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier
title: String
combinedConsumptionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption on combined
metering points (E19)
title: Int
combinedConsumptionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
on combined metering points (E19)
title: Int
combinedProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for production on combined
metering points (E19)
title: Int
combinedProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for production
on combined metering points (E19)
title: Int
consumptionFifteenActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 15 min resolution
title: Int
consumptionFifteenExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 15 min resolution
title: Int
consumptionSixtyActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 60 min resolution
title: Int
consumptionSixtyExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 60 min resolution
title: Int
estimatedAnnualConsumptionAll:
type:
- "null"
- integer
format: int64
description: Sum of estimated annual consumption of all metering point.
E17 and E19 only. Direction Out only.
title: Long
estimatedAnnualConsumptionCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of estimated annual consumption of all completed metering\
\ point, meaning number of received reads are equal to expected. E17 and\
\ E19 only. Direction Out only."
title: Long
estimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
does not have measured quality. (Also included in actual interval count)
title: Int
expectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received
title: Int
finalEstimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has final estimated quality.(Also included in actual interval count)
title: Int
installedCapacityAll:
type:
- "null"
- integer
format: int64
description: Sum of installed capacity of all metering point. E18 and E19
only. Direction In only.
title: Long
installedCapacityCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of installed capacity of all completed metering point,\
\ meaning number of received reads are equal to expected. E18 and E19\
\ only. Direction In only."
title: Long
largeProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for large production
(E18) metering points
title: Int
largeProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for large production
(E18) metering points
title: Int
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
loadLimitAll:
type:
- "null"
- integer
format: int64
description: Sum of load limit of all metering point. E17 and E19 only.
Direction Out only.
title: Long
loadLimitCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of load limit of all completed metering point, meaning\
\ number of received reads are equal to expected. E17 and E19 only. Direction\
\ Out only."
title: Long
meteredIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has metered(highest) quality.(Also included in actual interval count)
title: Int
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
notCompleteMeteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points where actually received metering
value count is less than expected
title: Int
priceArea:
type:
- "null"
- string
description: The price area
title: String
temporaryIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has temporary quality.(Also included in actual interval count)
title: Int
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: CompletenessDailyPerBalanceSupplierMba
no.elhub.ds.energy.data.models.pricearea.CompletenessDailyPerMba:
type: object
properties:
actualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received. Excluding reads exchange
points in neighbouring grid areas
title: Int
combinedConsumptionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption on combined
metering points (E19)
title: Int
combinedConsumptionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
on combined metering points (E19)
title: Int
combinedProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for production on combined
metering points (E19)
title: Int
combinedProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for production
on combined metering points (E19)
title: Int
consumptionFifteenActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 15 min resolution
title: Int
consumptionFifteenExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 15 min resolution
title: Int
consumptionSixtyActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for consumption (E17)
on 60 min resolution
title: Int
consumptionSixtyExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for consumption
(E17) on 60 min resolution
title: Int
estimatedAnnualConsumptionAll:
type:
- "null"
- integer
format: int64
description: Sum of estimated annual consumption of all metering point.
E17 and E19 only. Direction Out only.
title: Long
estimatedAnnualConsumptionCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of estimated annual consumption of all completed metering\
\ point, meaning number of received reads are equal to expected. E17 and\
\ E19 only. Direction Out only."
title: Long
estimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
does not have measured quality. (Also included in actual interval count)
title: Int
exchangeActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for exchange points (E20)
in grid area. Excluding exchange points in neighbouring grid areas
title: Int
exchangeExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for exchange points
(E20) in grid area. Excluding exchange points in neighbouring grid areas
title: Int
expectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received. Excluding reads
exchange points in neighbouring grid areas
title: Int
finalEstimatedIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has final estimated quality.(Also included in actual interval count)
title: Int
installedCapacityAll:
type:
- "null"
- integer
format: int64
description: Sum of installed capacity of all metering point. E18 and E19
only. Direction In only.
title: Long
installedCapacityCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of installed capacity of all completed metering point,\
\ meaning number of received reads are equal to expected. E18 and E19\
\ only. Direction In only."
title: Long
largeProductionActualIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads actually received for large production
(E18) metering points
title: Int
largeProductionExpectedIntervalCount:
type:
- "null"
- integer
format: int32
description: The number of reads expected to be received for large production
(E18) metering points
title: Int
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
loadLimitAll:
type:
- "null"
- integer
format: int64
description: Sum of load limit of all metering point. E17 and E19 only.
Direction Out only.
title: Long
loadLimitCompleted:
type:
- "null"
- integer
format: int64
description: "Sum of load limit of all completed metering point, meaning\
\ number of received reads are equal to expected. E17 and E19 only. Direction\
\ Out only."
title: Long
meteredIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has metered(highest) quality.(Also included in actual interval count)
title: Int
meteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points. Excluding exchange points in
neighbouring grid areas
title: Int
notCompleteMeteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points where actually received metering
value count is less than expected
title: Int
priceArea:
type:
- "null"
- string
description: The price area
title: String
temporaryIntervalCount:
type:
- "null"
- integer
format: int32
description: Count of how many reads are received for the usage date which
has temporary quality.(Also included in actual interval count)
title: Int
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: CompletenessDailyPerMba
no.elhub.ds.energy.data.models.pricearea.ConsumptionPerBalanceResponsibleMbaHour:
type: object
properties:
balanceResponsible:
type:
- "null"
- string
description: The GLN of the balance responsible
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate.
title: Int
priceArea:
type:
- "null"
- string
description: The price area.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
title: ConsumptionPerBalanceResponsibleMbaHour
no.elhub.ds.energy.data.models.pricearea.ConsumptionPerBalanceSupplierMbaHour:
type: object
properties:
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate.
title: Int
priceArea:
type:
- "null"
- string
description: The price area.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
title: ConsumptionPerBalanceSupplierMbaHour
no.elhub.ds.energy.data.models.pricearea.ConsumptionPerGroupMbaHour:
type: object
properties:
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
priceArea:
type:
- "null"
- string
description: The price area
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ConsumptionPerGroupMbaHour
no.elhub.ds.energy.data.models.pricearea.ExchangePerMba15Min:
type: object
properties:
adjacentPriceArea:
type:
- "null"
- string
description: The adjacent price area
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval
title: String
exchangeInQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the IN direction
title: Float
exchangeOutQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the OUT direction
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
priceArea:
type:
- "null"
- string
description: The price area
title: String
startTime:
type:
- "null"
- string
description: The start time of the interval
title: String
title: ExchangePerMba15Min
no.elhub.ds.energy.data.models.pricearea.ExchangePerMbaHour:
type: object
properties:
adjacentPriceArea:
type:
- "null"
- string
description: The adjacent price area
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval
title: String
exchangeInQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the IN direction
title: Float
exchangeOutQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the OUT direction
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
priceArea:
type:
- "null"
- string
description: The price area
title: String
startTime:
type:
- "null"
- string
description: The start time of the interval
title: String
title: ExchangePerMbaHour
no.elhub.ds.energy.data.models.pricearea.InstalledCapacityPerMeteringPointTypeGroupMbaDaily:
type: object
properties:
installedCapacity:
type:
- "null"
- number
format: float
description: "Sum of installed capacity of all metering point. E18(production)\
\ and E19(combined/prosumers) only. Direction In only(production), meaning\
\ consumption is ignored."
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointTypeCode:
type:
- "null"
- string
description: "The code of the MeteringPointType. E.g. E18(production), E19(combined/prosumers)"
title: String
priceAreaId:
type:
- "null"
- string
description: Price area ID
title: String
productionGroup:
type:
- "null"
- string
description: "Production group: solar, hydro, wind, thermal, other"
title: String
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: InstalledCapacityPerMeteringPointTypeGroupMbaDaily
no.elhub.ds.energy.data.models.pricearea.LossPerMbaHour:
type: object
properties:
calculateLossFraction:
type: number
format: float
description: calculatedLossQuantityKwh divided by netInfeedQuantityKwh.
Multiply with 100 to get percentage. Will be 0 if net infeed is 0.
title: Float
calculatedLossQuantityKwh:
type:
- "null"
- number
format: float
description: The loss in kwh. Includes no balance supplier loss. Calculated
as production + exchange in - exchange out - consumption.
title: Float
consumptionQuantityKwh:
type:
- "null"
- number
format: float
description: Consumption quantity in kwh. Includes interval consumption(including
consumption from combined metering points) and profile consumption
title: Float
endTime:
type:
- "null"
- string
description: The end time of the interval
title: String
exchangeInQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the IN direction
title: Float
exchangeOutQuantityKwh:
type:
- "null"
- number
format: float
description: The exchange quantity in kWh for the OUT direction
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
netInfeedQuantityKwh:
type:
- "null"
- number
format: float
description: The net infeed in kwh. Calculated as production + exchange
in - exchange out
title: Float
priceArea:
type:
- "null"
- string
description: The price area
title: String
productionQuantityKwh:
type:
- "null"
- number
format: float
description: Production quantity in kwh
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval
title: String
required:
- calculateLossFraction
title: LossPerMbaHour
no.elhub.ds.energy.data.models.pricearea.MeteringValueComparisonEacPerMonth:
type: object
properties:
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
costNorwayPrice:
type:
- "null"
- number
format: float
description: The cost based on the Norway price in NOK/kWh
title: Float
costSpotPrice:
type:
- "null"
- number
format: float
description: The cost based on the spot price in NOK/kWh
title: Float
costSupportPrice:
type:
- "null"
- number
format: float
description: The cost based on the support price in NOK/kWh
title: Float
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
estimatedAnnualConsumption:
type:
- "null"
- integer
format: int32
description: Sum of estimated annual consumption of all metering points
title: Int
priceArea:
type:
- "null"
- string
description: The price area
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: MeteringValueComparisonEacPerMonth
no.elhub.ds.energy.data.models.pricearea.NorgesprisConsumptionPerGroupEacMba:
type: object
properties:
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
estimatedAnnualConsumptionFrom:
type:
- "null"
- integer
format: int64
description: Estimated annual consumption from (kWh)
title: Long
estimatedAnnualConsumptionTo:
type:
- "null"
- integer
format: int64
description: Estimated annual consumption to (kWh)
title: Long
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time for the row.
title: String
meteringPointCountNorwayPrice:
type:
- "null"
- integer
format: int32
description: Metering point count for Norway price
title: Int
meteringPointCountNotNorwayPrice:
type:
- "null"
- integer
format: int32
description: Metering point count not for Norway price
title: Int
quantityKwhNorwayPrice:
type:
- "null"
- number
format: float
description: Quantity in kWh for Norway price
title: Float
quantityKwhNotNorwayPrice:
type:
- "null"
- number
format: float
description: Quantity in kWh not for Norway price
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
totalMeteringPointCount:
type:
- "null"
- integer
format: int32
description: Total metering point count
title: Int
totalQuantityKwh:
type:
- "null"
- number
format: float
description: Total aggregated consumption in kWh
title: Float
title: NorgesprisConsumptionPerGroupEacMba
no.elhub.ds.energy.data.models.pricearea.ProductionPerBalanceResponsibleMeteringPointTypeCodeMbaHour:
type: object
properties:
balanceResponsible:
type:
- "null"
- string
description: The GLN of the balance responsible
title: String
endTime:
type:
- "null"
- string
description: End time of the interval.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points in the aggregate.
title: Int
meteringPointTypeCode:
type:
- "null"
- string
description: The code of the MeteringPointType. E.g. E18. metering point type
title: String
priceArea:
type:
- "null"
- string
description: The Price Area
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval.
title: String
title: ProductionPerBalanceResponsibleMeteringPointTypeCodeMbaHour
no.elhub.ds.energy.data.models.pricearea.ProductionPerBalanceSupplierMeteringPointTypeCodeMbaHour:
type: object
properties:
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier
title: String
endTime:
type:
- "null"
- string
description: End time of the interval.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points in the aggregate.
title: Int
meteringPointTypeCode:
type:
- "null"
- string
description: The code of the MeteringPointType. E.g. E18. metering point type
title: String
priceArea:
type:
- "null"
- string
description: The Price Area
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval.
title: String
title: ProductionPerBalanceSupplierMeteringPointTypeCodeMbaHour
no.elhub.ds.energy.data.models.pricearea.ProductionPerGroupMba15Min:
type: object
properties:
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
priceArea:
type:
- "null"
- string
description: The price area
title: String
productionGroup:
type:
- "null"
- string
description: "Production group: solar, hydro, wind, thermal, other"
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ProductionPerGroupMba15Min
no.elhub.ds.energy.data.models.pricearea.ProductionPerGroupMbaHour:
type: object
properties:
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
priceArea:
type:
- "null"
- string
description: The price area
title: String
productionGroup:
type:
- "null"
- string
description: "Production group: solar, hydro, wind, thermal, other"
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ProductionPerGroupMbaHour
no.elhub.ds.energy.data.models.pricearea.ProductionPerMba15Min:
type: object
properties:
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
priceArea:
type:
- "null"
- string
description: The price area
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ProductionPerMba15Min
no.elhub.ds.energy.data.models.gridarea.ProductionPerBalanceSupplierMeteringPointTypeMgaHour:
type: object
properties:
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier.
title: String
endTime:
type:
- "null"
- string
description: End time of the interval.
title: String
gridArea:
type:
- "null"
- string
description: Grid area of the aggregate.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering points in the aggregate.
title: Int
meteringPointTypeCode:
type:
- "null"
- string
description: The code of the MeteringPointType. E.g. E18.
title: String
priceArea:
type:
- "null"
- string
description: Price area of the aggregate.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval.
title: String
title: ProductionPerBalanceSupplierMeteringPointTypeMgaHour
no.elhub.ds.energy.data.models.gridarea.ProductionPerHourBalanceSupplierGroupMeteringPointTypeMga:
type: object
properties:
balanceSupplier:
type:
- "null"
- string
description: The GLN of the balance supplier.
title: String
endTime:
type:
- "null"
- string
description: End time of the interval.
title: String
gridArea:
type:
- "null"
- string
description: Grid area of the aggregate.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the aggregate was last updated.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate.
title: Int
meteringPointTypeCode:
type:
- "null"
- string
description: The code of the MeteringPointType. E.g. E18.
title: String
priceArea:
type:
- "null"
- string
description: Price area of the aggregate.
title: String
productionGroup:
type:
- "null"
- string
description: The Production Group.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval.
title: String
title: ProductionPerHourBalanceSupplierGroupMeteringPointTypeMga
no.elhub.ds.energy.data.models.response.PartyResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
parties:
type: array
description: data grouped by a list of parties
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.Party"
title: List
required:
- creationTime
- parties
title: PartyResponse
no.elhub.ds.energy.data.models.response.PriceAreaResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
priceAreas:
type:
- "null"
- array
description: data grouped by a list of price areas
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.PriceArea"
title: List
required:
- creationTime
title: PriceAreaResponse
no.elhub.ds.energy.data.models.response.GridAreaResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
gridAreas:
type: array
description: data grouped by a list of grid areas
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.GridArea"
title: List
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
required:
- creationTime
- gridAreas
title: GridAreaResponse
no.elhub.ds.energy.data.models.municipality.Municipality:
type: object
properties:
consumptionPerBalanceSupplierMunicipalityHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per balance supplier
per municipality
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ConsumptionPerGroupMunicipalityHour"
title: List
consumptionPerGroupMunicipalityBasicStatisticalUnitHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per group per basic statistical
unit
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ConsumptionPerGroupMunicipalityBasicStatisticalUnitHour"
title: List
consumptionPerGroupMunicipalityHour:
type:
- "null"
- array
description: List of hourly aggregated consumption per group per municipality
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ConsumptionPerGroupMunicipalityHour"
title: List
consumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour:
type:
- "null"
- array
description: "List of hourly aggregated consumption per mba, mga, municipality,\
\ nace code, consumption code"
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ConsumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour"
title: List
consumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour:
type:
- "null"
- array
description: "List of hourly aggregated consumption per mba, municipality,\
\ nace code, consumption code"
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ConsumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour"
title: List
id:
type:
- "null"
- string
description: Municipality identification string
title: String
installedCapacityPerMeteringPointTypeGroupMunicipalityBasicStatisticalUnitDaily:
type:
- "null"
- array
description: List of daily aggregated installed capacity per metering point
type group per basic statistical unit
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.InstalledCapacityPerMeteringPointTypeGroupMunicipalityBasicStatisticalUnitDaily"
title: List
installedCapacityPerMeteringPointTypeGroupMunicipalityDaily:
type:
- "null"
- array
description: List of daily aggregated installed capacity per metering point
type group per municipality
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.InstalledCapacityPerMeteringPointTypeGroupMunicipalityDaily"
title: List
links:
description: Links object
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Links"
maxConsumptionPerEACMunicipalityBasicStatisticalUnitMonth:
type:
- "null"
- array
description: List of monthly max consumption per EAC per basic statistical
unit
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.MaxConsumptionPerEACMunicipalityBasicStatisticalUnitMonth"
title: List
meteringPointCountPerMonthGridOwnerNaceCodeAdjustedMunicipality:
type:
- "null"
- array
description: "Number of metering points at the last day of month per grid\
\ owner, nace code and municipality."
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.MeteringPointCountPerMonthGridOwnerNaceCodeAdjustedMunicipality"
title: List
municipalityNumber:
type: string
description: Municipality number
title: String
name:
type: string
description: Municipality name
title: String
nameNo:
type: string
description: Municipality name in Norwegian
title: String
productionPerBalanceSupplierMeteringPointTypeCodeMunicipalityHour:
type:
- "null"
- array
description: "List of hourly aggregated production per balance supplier,\
\ metering point type code per municipality"
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ProductionPerMeteringPointTypeMunicipalityHour"
title: List
productionPerMeteringPointTypeMunicipalityHour:
type:
- "null"
- array
description: List of hourly aggregated production per metering point type
per municipality
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.ProductionPerMeteringPointTypeMunicipalityHour"
title: List
required:
- municipalityNumber
- name
- nameNo
title: Municipality
no.elhub.ds.energy.data.models.municipality.ConsumptionPerGroupMunicipalityHour:
type: object
properties:
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ConsumptionPerGroupMunicipalityHour
no.elhub.ds.energy.data.models.municipality.ConsumptionPerGroupMunicipalityBasicStatisticalUnitHour:
type: object
properties:
basicStatisticalUnit:
type:
- "null"
- string
description: Basic statistical unit (Grunnkrets)
title: String
consumptionGroup:
type:
- "null"
- string
description: The consumption group
title: String
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ConsumptionPerGroupMunicipalityBasicStatisticalUnitHour
no.elhub.ds.energy.data.models.municipality.ConsumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour:
type: object
properties:
consumptionCode:
type:
- "null"
- string
description: Consumption code for the aggregate.
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
gridArea:
type:
- "null"
- string
description: Grid area for the aggregate.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the aggregate was last updated.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate.
title: Int
naceCode:
type:
- "null"
- string
description: NACE code for the aggregate.
title: String
priceArea:
type:
- "null"
- string
description: Price area for the aggregate.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
title: ConsumptionPerMbaMgaMunicipalityNaceCodeConsumptionCodeHour
no.elhub.ds.energy.data.models.municipality.ConsumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour:
type: object
properties:
consumptionCode:
type:
- "null"
- string
description: Consumption code for the aggregate.
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the aggregate was last updated.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate.
title: Int
naceCode:
type:
- "null"
- string
description: NACE code for the aggregate.
title: String
priceArea:
type:
- "null"
- string
description: Price area for the aggregate.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate.
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
title: ConsumptionPerMbaMunicipalityNaceCodeConsumptionCodeHour
no.elhub.ds.energy.data.models.municipality.InstalledCapacityPerMeteringPointTypeGroupMunicipalityBasicStatisticalUnitDaily:
type: object
properties:
basicStatisticalUnit:
type:
- "null"
- string
description: Basic Statistical Unit
title: String
installedCapacity:
type:
- "null"
- number
format: float
description: "Sum of installed capacity of all metering point. E18(production)\
\ and E19(combined/prosumers) only. Direction In only(production), meaning\
\ consumption is ignored."
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointTypeCode:
type:
- "null"
- string
description: "The code of the MeteringPointType. E.g. E18(production), E19(combined/prosumers)"
title: String
municipalityId:
type:
- "null"
- string
description: Municipality ID
title: String
productionGroup:
type:
- "null"
- string
description: "Production group: solar, hydro, wind, thermal, other"
title: String
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: InstalledCapacityPerMeteringPointTypeGroupMunicipalityBasicStatisticalUnitDaily
no.elhub.ds.energy.data.models.municipality.InstalledCapacityPerMeteringPointTypeGroupMunicipalityDaily:
type: object
properties:
installedCapacity:
type:
- "null"
- number
format: float
description: "Sum of installed capacity of all metering point. E18 and E19\
\ only. Direction In only(production), meaning consumption is ignored."
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointTypeCode:
type:
- "null"
- string
description: "The code of the MeteringPointType. E.g. E18(production), E19(combined/prosumers)"
title: String
municipalityId:
type:
- "null"
- string
description: Municipality ID
title: String
productionGroup:
type:
- "null"
- string
description: "Production group: solar, hydro, wind, thermal, other"
title: String
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date
title: Int
title: InstalledCapacityPerMeteringPointTypeGroupMunicipalityDaily
no.elhub.ds.energy.data.models.municipality.MaxConsumptionPerEACMunicipalityBasicStatisticalUnitMonth:
type: object
properties:
basicStatisticalUnit:
type:
- "null"
- string
description: Basic Statistical Unit Name (Grunnkrets)
title: String
basicStatisticalUnitId:
type:
- "null"
- integer
format: int32
description: Basic Statistical Unit ID (Grunnkrets)
title: Int
dailyConsumption:
type:
- "null"
- number
format: float
description: The total consumption for the day with the highest hourly consumption
in kWh
title: Float
estimatedAnnualConsumption:
type:
- "null"
- number
format: float
description: Sum of estimated annual consumption in kWh of all metering
points included in the basic statistical unit(Grunnkrets).
title: Float
highestHourlyConsumption:
type:
- "null"
- number
format: float
description: The highest hourly consumption for the month in kWh
title: Float
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
usageDateId:
type:
- "null"
- integer
format: int32
description: The usage date with the highest hourly consumption
title: Int
yearMonth:
type:
- "null"
- string
description: The month and year of the max consumption
title: String
title: MaxConsumptionPerEACMunicipalityBasicStatisticalUnitMonth
no.elhub.ds.energy.data.models.municipality.MeteringPointCountPerMonthGridOwnerNaceCodeAdjustedMunicipality:
type: object
description: "Number of metering points at the last day of month per grid owner,\
\ NACE code and municipality."
properties:
gridOwnerGln:
type:
- "null"
- string
description: The grid owner GLN.
title: String
gridOwnerOrgName:
type:
- "null"
- string
description: Organization name of the grid owner
title: String
gridOwnerOrgNumber:
type:
- "null"
- string
description: The organization number of the grid owner
title: String
lastDayOfMonth:
type: string
description: Date of last day of month. The date used to determine the counts.
title: String
lastUpdateTime:
type: string
description: Time in UTC the row was last updated.
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: The number of metering point in this group at the end of the
month
title: Int
naceCode:
type:
- "null"
- string
description: "The NACE code. Note that for metering points where nace code\
\ is XX or consumption code 35, then this is set to XX. If nace code XY\
\ or consumption code 36, then it is set to XY."
title: String
yearMonth:
type:
- "null"
- integer
format: int32
description: YYYYMM
title: Int
required:
- lastDayOfMonth
- lastUpdateTime
title: MeteringPointCountPerMonthGridOwnerNaceCodeAdjustedMunicipality
no.elhub.ds.energy.data.models.municipality.ProductionPerMeteringPointTypeMunicipalityHour:
type: object
properties:
endTime:
type:
- "null"
- string
description: End time of the interval
title: String
lastUpdatedTime:
type:
- "null"
- string
description: When the row was last updated
title: String
meteringPointCount:
type:
- "null"
- integer
format: int32
description: Number of metering points that are part of the aggregate
title: Int
meteringPointTypeCode:
type:
- "null"
- string
description: The code of the MeteringPointType. E.g. E18.
title: String
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the aggregate
title: Float
startTime:
type:
- "null"
- string
description: Start time of the interval
title: String
title: ProductionPerMeteringPointTypeMunicipalityHour
no.elhub.ds.energy.data.models.response.MunicipalityResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
municipalities:
type: array
description: data grouped by a list of municipalities
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.municipality.Municipality"
title: List
required:
- creationTime
- municipalities
title: MunicipalityResponse
no.elhub.ds.energy.data.models.ConsumptionGroup:
type: object
properties:
description:
type:
- "null"
- string
description: Consumption group description
title: String
id:
type: string
description: Consumption group id
title: String
name:
type:
- "null"
- string
description: Consumption group name
title: String
required:
- id
title: ConsumptionGroup
no.elhub.ds.energy.data.models.response.ConsumptionGroupResponse:
type: object
properties:
consumptionGroups:
type:
- "null"
- array
description: data grouped by a list of consumption groups
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.ConsumptionGroup"
title: List
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
required:
- creationTime
title: ConsumptionGroupResponse
no.elhub.ds.energy.data.models.meteringpoints.MeteringPointEntity:
type: object
properties:
comparisionNorgespris:
type:
- "null"
- array
description: List of comparison Norgespris
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.ComparisonNorgespris"
title: List
gridArea:
description: Grid area connected to this metering point entity
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.gridarea.GridArea"
gridOwner:
description: Grid owner connected to this metering point entity
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.Party"
id:
type:
- "null"
- string
description: Metering point entity identification string
title: String
installedCapacityPerMeteringPointDaily:
type:
- "null"
- array
description: List of installed capacity per metering point daily
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.InstalledCapacityPerMeteringPointDaily"
title: List
meteringPointCoordinate:
description: List of metering point coordinates
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.MeteringPointCoordinate"
meteringValuesHour:
type:
- "null"
- array
description: List of hourly metering values from this metering point entity
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesHour"
title: List
meteringValuesPerDirectionDay:
type:
- "null"
- array
description: List of daily metering values per direction for this metering
point
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesPerDirectionDay"
title: List
meteringValuesPerDirectionMonth:
type:
- "null"
- array
description: List of monthly metering values per direction for this metering
point
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesPerDirectionMonth"
title: List
meteringValuesPerDirectionYear:
type:
- "null"
- array
description: List of yearly metering values per direction for this metering
point
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesPerDirectionYear"
title: List
priceArea:
description: Price area from this metering point entity
oneOf:
- type: "null"
- $ref: "#/components/schemas/no.elhub.ds.energy.data.models.pricearea.PriceArea"
productionRevenuePerYear:
type:
- "null"
- array
description: List of production revenue per year
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.meteringpoints.ProductionRevenuePerYear"
title: List
status:
type:
- "null"
- string
description: Status for this metering point entity
title: String
title: MeteringPointEntity
no.elhub.ds.energy.data.models.ComparisonNorgespris:
type: object
properties:
costNorwayPrice:
type:
- "null"
- number
format: float
description: "The cost using Norway price in NOK. quantityKwh*norwayPrice.\
\ VAT is included except for metering Points located in Troms, Finnmark\
\ and Nordland."
title: Float
costSpotPrice:
type:
- "null"
- number
format: float
description: "The cost using Spot price in NOK. quantityKwh*spotPrice. VAT\
\ is included except for metering Points located in Troms, Finnmark and\
\ Nordland."
title: Float
costSupportPrice:
type:
- "null"
- number
format: float
description: "The cost of the Support price in NOK. quantityKwh*supportPrice.\
\ VAT is included except for metering Points located in Troms, Finnmark\
\ and Nordland."
title: Float
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
hasExceededMonthlyNorwayThreshold:
type:
- "null"
- boolean
description: "If the interval has crossed the monthly threshold for Norway\
\ price. The first interval that crosses the threshold will have FALSE,\
\ the following will have TRUE."
title: Boolean
hasExceededMonthlySupportThreshold:
type:
- "null"
- boolean
description: "If the interval has crossed the monthly threshold for Support\
\ price. The first interval that crosses the threshold will have FALSE,\
\ the following will have TRUE."
title: Boolean
norwayPrice:
type:
- "null"
- number
format: float
description: "Norway price in NOK/kWh. VAT is included except for metering\
\ Points located in Troms, Finnmark and Nordland. After monthly treshold\
\ is crossed, Norway price = Spot Price."
title: Float
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the metering value.
title: Float
spotPrice:
type:
- "null"
- number
format: float
description: "Spot price in NOK/kWh. VAT is included except for metering\
\ Points located in Troms, Finnmark and Nordland."
title: Float
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
supportPrice:
type:
- "null"
- number
format: float
description: "Support price in NOK/kWh. VAT is included except for metering\
\ Points located in Troms, Finnmark and Nordland. After monthly treshold\
\ is crossed OR price is lower than the support price upper bound, Support\
\ price = Spot Price."
title: Float
title: ComparisonNorgespris
no.elhub.ds.energy.data.models.InstalledCapacityPerMeteringPointDaily:
type: object
properties:
consumptionCode:
type:
- "null"
- string
description: Consumption code. See Elhub documentation..
title: String
gridAreaId:
type:
- "null"
- string
description: Grid area ID
title: String
gridAreaName:
type:
- "null"
- string
description: Grid area name
title: String
gridOwnerId:
type:
- "null"
- string
description: Grid owner ID
title: String
gridOwnerName:
type:
- "null"
- string
description: Grid owner name
title: String
installedCapacity:
type:
- "null"
- number
format: float
description: "Sum of installed capacity of all metering point. E18(production)\
\ and E19(combined/prosumers) only. Direction In only(production), meaning\
\ consumption is ignored."
title: Float
latitude:
description: Latitude coordinate of the metering point
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
longitude:
description: Longitude coordinate of the metering point
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
meteringPointTypeCode:
type:
- "null"
- string
description: Metering point type code
title: String
municipalityNumber:
type:
- "null"
- string
description: Municipality number
title: String
naceCode:
type:
- "null"
- string
description: NACE code
title: String
postalCode:
type:
- "null"
- string
description: Postal code of the metering point
title: String
priceAreaId:
type:
- "null"
- string
description: Price area ID
title: String
productionGroup:
type:
- "null"
- string
description: Production group
title: String
productionStartDate:
type:
- "null"
- string
description: Production start date
title: String
usageDate:
type:
- "null"
- string
description: Usage date
title: String
title: InstalledCapacityPerMeteringPointDaily
no.elhub.ds.energy.data.models.MeteringPointCoordinate:
type: object
properties:
cadastreAddressId:
type:
- "null"
- integer
format: int64
description: The cadastre address id found by matching metering point address
against address in cadastre
title: Long
cadastreLatitude:
type:
- "null"
- number
format: double
description: The latitude from the cadastre for the cadastre_address_id
title: Double
cadastreLongitude:
type:
- "null"
- number
format: double
description: The longitude from the cadastre for the cadastre_address_id
title: Double
cadastreMatchStatusCode:
type:
- "null"
- string
description: The status code describing how accurate the match that resulted
in the cadastre_addres_id was. From ted.cadastre_match_status_code
title: String
distanceCadastreToPostal:
type:
- "null"
- integer
format: int64
description: The distance in meter from the cadastre position to the postal
code position
title: Long
distanceMpToCadastre:
type:
- "null"
- integer
format: int64
description: The distance in meter from the metering point position to the
cadastre position
title: Long
distanceMpToPostal:
type:
- "null"
- integer
format: int64
description: The distance in meter from the metering point position to the
postal code position
title: Long
distancePosToCadastre:
type:
- "null"
- integer
format: int64
description: The distance in meter from the derived position to the cadastre
position
title: Long
distancePosToMp:
type:
- "null"
- integer
format: int64
description: The distance in meter from the derived position to the metering
point position
title: Long
distancePosToPostal:
type:
- "null"
- integer
format: int64
description: The distance in meter from the derived position to the postal
code position
title: Long
insertTime:
type: string
description: When the row was inserted.
title: String
lastUpdateTime:
type: string
description: When the row was last updated.
title: String
latitude:
type:
- "null"
- number
format: double
description: The derived latitude
title: Double
longitude:
type:
- "null"
- number
format: double
description: The derived longitude
title: Double
meteringPointId:
type: string
description: The metering point id
title: String
meteringPointLatitude:
type:
- "null"
- number
format: double
description: The latitude registered on the metering point by the grid owner
title: Double
meteringPointLongitude:
type:
- "null"
- number
format: double
description: The longitude registered on the metering point by the grid
owner
title: Double
positionDerivedFrom:
type:
- "null"
- string
description: "The source of values in column longitude and latitude. GRID_OWNER,\
\ CADASTRE or POSTAL_CODE."
title: String
postalCode:
type:
- "null"
- string
description: The postal code for the metering point
title: String
postalCodeLatitude:
type:
- "null"
- number
format: double
description: The latitude for the postal code
title: Double
postalCodeLongitude:
type:
- "null"
- number
format: double
description: The longitude for the postal code
title: Double
required:
- insertTime
- lastUpdateTime
- meteringPointId
title: MeteringPointCoordinate
no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesHour:
type: object
properties:
direction:
type:
- "null"
- string
description: Direction of the metering value.
title: String
endTime:
type:
- "null"
- string
description: The end time of the interval.
title: String
endUserId:
type:
- "null"
- string
description: End user ID for the metering value.
title: String
insertDateTime:
type:
- "null"
- string
description: Insert date time for the metering value.
title: String
measurementName:
type:
- "null"
- string
description: Measurement name of the metering value.
title: String
productCode:
type:
- "null"
- integer
format: int64
description: Product code of the metering value. product identifier
title: Long
quantityKwh:
type:
- "null"
- number
format: float
description: The quantity in kWh for the metering value.
title: Float
resolution:
type:
- "null"
- string
description: Resolution of channel. PT60M(60 min intervals) or PT15M(15
min intervals). resolution
title: String
startTime:
type:
- "null"
- string
description: The start time of the interval.
title: String
title: MeteringValuesHour
no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesPerDirectionDay:
type: object
properties:
direction:
type: string
description: Direction of the energy measured.
title: String
endUserId:
type:
- "null"
- string
description: "If Company end user, this is the organization number for the\
\ end user. Not set for non-company end users."
title: String
lastUpdateTime:
type: string
description: Last update time for the metering value.
title: String
maxInsertTime:
type: string
description: Max insert time for the metering value.
title: String
measurementName:
type: string
description: Name of the measurement.
title: String
meteringPointId:
type: string
description: Unique identifier for the metering point.
title: String
productCode:
type: integer
format: int64
description: Product code of the metering value.
title: Long
quantityKwh:
type:
- "null"
- number
format: float
description: Quantity in kWh for the metering value.
title: Float
resolution:
type: string
description: Resolution of the metering value.
title: String
thirdParty:
type: string
description: Identifier for the third party associated with the metering
values.
title: String
thirdPartyOrgNumber:
type: string
description: Organization number of the third party.
title: String
usageDateId:
type: integer
format: int32
description: Usage date ID for the metering value.
title: Int
required:
- direction
- lastUpdateTime
- maxInsertTime
- measurementName
- meteringPointId
- productCode
- resolution
- thirdParty
- thirdPartyOrgNumber
- usageDateId
title: MeteringValuesPerDirectionDay
no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesPerDirectionMonth:
type: object
properties:
direction:
type: string
description: Direction of the energy measured. In(production) or Out(consumption).
title: String
endUserId:
type:
- "null"
- string
description: "If Company end user, this is the organization number for the\
\ end user. Not set for non-company end users."
title: String
lastUpdateTime:
type: string
description: Last update time for the metering value.
title: String
maxInsertTime:
type: string
description: Max insert time for the metering value.
title: String
maxUsageDateId:
type:
- "null"
- integer
format: int32
description: Maximum usage date ID for the metering value.
title: Int
meteringPointId:
type: string
description: Unique identifier for the metering point.
title: String
minUsageDateId:
type:
- "null"
- integer
format: int32
description: Minimum usage date ID for the metering value.
title: Int
numberOfDays:
type:
- "null"
- integer
format: int32
description: Number of days in the month for the metering value.
title: Int
quantityKwh:
type:
- "null"
- number
format: float
description: Quantity in kWh for the metering value.
title: Float
thirdParty:
type: string
description: Identifier for the third party associated with the metering
values.
title: String
thirdPartyOrgNumber:
type: string
description: Organization number of the third party.
title: String
yearMonth:
type:
- "null"
- integer
format: int32
description: Year and month for the metering value.
title: Int
required:
- direction
- lastUpdateTime
- maxInsertTime
- meteringPointId
- thirdParty
- thirdPartyOrgNumber
title: MeteringValuesPerDirectionMonth
no.elhub.ds.energy.data.models.meteringpoints.MeteringValuesPerDirectionYear:
type: object
properties:
direction:
type: string
description: Direction of the energy measured. In(production) or Out(consumption).
title: String
endUserId:
type:
- "null"
- string
description: Identifier for the end user associated with the metering values.
title: String
lastUpdateTime:
type: string
description: Timestamp when this aggregate was last updated.
title: String
maxInsertTime:
type: string
description: Timestamp of the latest insertion of the metering values received
in Elhub.
title: String
maxUsageDateId:
type:
- "null"
- integer
format: int32
description: 'Last day in month with meter reads. YYYYMMDD format. '
title: Int
meteringPointId:
type: string
description: Unique identifier for the metering point.
title: String
minUsageDateId:
type:
- "null"
- integer
format: int32
description: 'First day in year with meter reads. YYYYMMDD format. '
title: Int
numberOfDays:
type:
- "null"
- integer
format: int32
description: Number of days in the year for the metering values.
title: Int
quantityKwh:
type:
- "null"
- number
format: float
description: Quantity of energy in kilowatt-hours (kWh).
title: Float
thirdParty:
type: string
description: Identifier for the third party associated with the metering
values.
title: String
thirdPartyOrgNumber:
type: string
description: Organization number of the third party.
title: String
year:
type:
- "null"
- integer
format: int32
description: Year for the metering values. YYYY format
title: Int
required:
- direction
- lastUpdateTime
- maxInsertTime
- meteringPointId
- thirdParty
- thirdPartyOrgNumber
title: MeteringValuesPerDirectionYear
no.elhub.ds.energy.data.models.meteringpoints.ProductionRevenuePerYear:
type: object
properties:
endTime:
type:
- "null"
- string
description: The end time of the aggregated interval.
title: String
lastUpdatedTime:
type:
- "null"
- string
description: Last updated time of the aggregates.
title: String
meteringPointId:
type:
- "null"
- string
description: Metering point identifier.
title: String
productionGroup:
type:
- "null"
- string
description: Production Group identifier.
title: String
productionPlantId:
type:
- "null"
- integer
format: int64
description: The production plant identifier.
title: Long
productionTypeCode:
type:
- "null"
- string
description: Code identifying the primary production type for the metering
point. See production type.
title: String
quantityKwh:
description: The aggregated quantity in kWh for the metering point during
the interval.
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
revenueNok:
description: The aggregated revenue (quantity_per_interval (kWh) * spot_price_per_interval
(NOK/kWh from Nordpool)) in NOK for the metering point during the interval.
oneOf:
- type: "null"
- $ref: "#/components/schemas/java.math.BigDecimal"
startTime:
type:
- "null"
- string
description: The start time of the aggregated interval.
title: String
title: ProductionRevenuePerYear
no.elhub.ds.energy.data.models.response.MeteringPointResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
meteringPoints:
type: array
description: List of metering points
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.meteringpoints.MeteringPointEntity"
title: List
required:
- creationTime
- meteringPoints
title: MeteringPointResponse
no.elhub.ds.energy.data.models.ProductionGroup:
type: object
properties:
description:
type:
- "null"
- string
description: Production group description
title: String
id:
type:
- "null"
- string
description: Production group identification string
title: String
name:
type:
- "null"
- string
description: Production group name
title: String
title: ProductionGroup
no.elhub.ds.energy.data.models.response.ProductionGroupResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
productionGroups:
type:
- "null"
- array
description: data grouped by a list of production groups
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.ProductionGroup"
title: List
required:
- creationTime
title: ProductionGroupResponse
no.elhub.ds.energy.data.models.Update:
type: object
properties:
dataset:
type:
- "null"
- string
description: Dataset name
title: String
endDateTime:
type:
- "null"
- string
description: "End time of the interval, Used in hourly updates"
title: String
entity:
type:
- "null"
- string
description: Entity the dataset belongs to
title: String
id:
type:
- "null"
- string
description: Update id
title: String
links:
description: Links object
oneOf:
- type: "null"
- $ref: "#/components/schemas/jsonapi.Links"
startDateTime:
type:
- "null"
- string
description: "Start time of the interval, Used in hourly updates"
title: String
updateTime:
type:
- "null"
- string
description: Update time
title: String
usageDate:
type:
- "null"
- string
description: Usage date the update happened
title: String
title: Update
no.elhub.ds.energy.data.models.response.UpdatesResponse:
type: object
properties:
creationTime:
type: string
description: "timestamp of this response creation, in yyyy-MM-dd'T'HH:mm:ssXXX\
\ format"
title: String
currentLink:
type:
- "null"
- string
description: link to the current resource
title: String
lastUpdatedTime:
type:
- "null"
- string
description: "timestamp for the last update time of this response's content,\
\ in yyyy-MM-dd'T'HH:mm:ssXXX format"
title: String
updates:
type:
- "null"
- array
description: list of updates
items:
$ref: "#/components/schemas/no.elhub.ds.energy.data.models.Update"
title: List
required:
- creationTime
title: UpdatesResponse
examples: {}
webhooks: {}