😅API

This API can be used to query energy data from an EEG. The query interface delivers the raw data of a queried period.

The interface consists of two endpoints. Over a defined period, the raw data of a metering point is delivered in fifteen-minute intervals. With an aggregate function, this data can be summarized into hourly/daily/weekly or monthly intervals.

The second interface deliver a meta object of all stored metering points.

Query Interface

POST https://eegfaktura.at/energystore/query/rawdata

Query Parameters

Name	Type	Description
f=agg(1h)	String	Interval for Aggregation

Headers

Name	Type	Description
X-Tenant*	String	RC-ID
Authorization*	String	BASIC Schema (user:passw) BASE64 encoded

Request Body

Name	Type	Description
start*	int	starting point of energy (ms)
end*	int	end point of energy (ms)
cps	Array	counterpoint list
ecId	string	community id

200: OK Response

Json Object:

{ 
  { <meteringpoint> : {
    "data": [{
      ts: int,      // timestamp
      value: int[], // Consumer comprise of 3 values [total consumption, production proportion, proportion]
                    // Producer comprise of 2 values [total generation, Rest Power feed (Line In)]
      qov: int[]    // quality of value 0..no value, 1..ok, 2..nok, 3..nok
    }],
    "direction": string // "CONSUMPTION" | "GENERATION"
  }
}

Example:

curl -X POST --user "user:password" -H "X-Tenant: RC000000" "https://eegfaktura.at/energystore/query/rawdata" -d '{"ecId": "<communityId>", "cps": [{"meteringPoint":"AT0030000000000000000000000000001"}, {"meteringPoint":"AT0030000000000000000000000000002"}], "start": 1702837920000, "end": 1702837920000}'

Example:

curl -X POST --user "user:password" -H "X-Tenant: RC000000" "https://eegfaktura.at/energystore/query/rawdata?f=agg(2h)" -d '{"ecId": "<communityId>", "start": 1702837920000, "end": 1702837920000}'

{
    "AT0030000000000000000000000000001": {
        "data": [
            {"ts": 1702767600000, "value": [0.05, 0.00832, 0.00832], "qov": [1, 1, 1]},
            {"ts": 1702768500000, "value": [0.056, 0.009898, 0.009898], "qov": [1, 1, 1]},
            ...
        ],
        "direction": "CONSUMPTION"
    },
    "AT0030000000000000000000000000002": {...}
}

POST https://eegfaktura.at/energystore/query/<ecId>/metadata

Headers

Name	Type	Description
Authorization	BASIC	BASIC Schema (user:passw) BASE64 encoded
X-Tenant	String	RC-ID

Url Parameters

Name	Type	Description
<ecId>	string	community id

200: OK

Json Object:

{ 
  <meteringpoint> : {
    "periodBegin": int, // timestamp
    "periodEnd": int    // timestamp
  }
}

Example:

{
    "AT0030000000000000000000000000001": {
        "periodBegin": 1672527600000,
        "periodEnd": 1705791600000
    },
    "AT0030000000000000000000000000002": {
        "periodBegin": 1673391600000,
        "periodEnd": 1705791600000
    },
}

UI Interface

POST https://eegfaktura.at/energystore/eeg/report

Query an energy report for a dedicated period.

Body is expected to be a JSON Objekt:

{"year": <period year: String>, "type": <peroid type>: String, "segment": <period segment>: Integer }

type: Defines a period type. Values: Y: Annual, YH: Biannual, YQ: Quarter, YM: Monthly

segment: specify the segment of a peroid (e.g 1..12 for YM, 1..4 for YQ, 1..2 fro YH, 0 for Y)

Headers

Name	Type	Description
Authorization	BASIC	BASIC Schema (user:passw) BASE64 encoded
X-Tenant	String	RC-ID

200: OK

Json Object:

{ 
  <meteringpoint> : {
    "periodBegin": int, // timestamp
    "periodEnd": int    // timestamp
  }
}

Example:

{
    "AT0030000000000000000000000000001": {
        "periodBegin": 1672527600000,
        "periodEnd": 1705791600000
    },
    "AT0030000000000000000000000000002": {
        "periodBegin": 1673391600000,
        "periodEnd": 1705791600000
    },
}

Update PartFact

POST /api/master/updatepartfact

Enhance the API interface to allow programmatic adaptation of the participant factor. The request must be authorized. For a BEG, a specified Net-Operator is required.

Headers

Name	Value
Content-Type	application/json
Authorization	BASIC Schema (user:passw) BASE64 encoded
X-Tenant	RC-ID

Body

JSON

{"meteringPoints":[
    {
        "meter": <string>, 
        "direction":<"CONSUMPTION" | "GENERATION">, 
        "activation":"<date: 'yyyy-mm-dd'>", 
        "gridOperatorId": "<string: optional>",
        "partFact": <int: 0..100>
    }
]}

Response

200

{}

400

{
    "error":"failed to request metering point PRTFACT"
}

Example

curl -X POST --user "<user>:<password>" \ 
    -H "X-Tenant:TE100100" https://eegfaktura.at/api/master/updatepartfact \
    -d '{"meteringPoints":[{"meter":"AT002000000000000000000000000001", "direction":"CONSUMPTION", "gridOperatorId": "AT002000", "activation":"2025-03-01", "partFact": 100}]}'