Skip to main content
GET
List Volume Reports

Authorizations

Authorization
string
header
required

API key generated in Settings > API Keys. Include as Authorization: Bearer <key>.

Query Parameters

periodYear
integer
Required range: 2000 <= x <= 2100
market
string

ISO alpha-2 (case-insensitive).

Pattern: ^[A-Za-z]{2}$
status
enum<string>

Exactly one report per (periodYear, market, format) is generated — that is the one to download.

Available options:
generated,
superseded
limit
integer
Required range: x >= 1
offset
integer
Required range: x >= 0

Response

Reports, newest first

id
string<uuid>
periodYear
integer
market
string

ISO alpha-2 market code.

format
enum<string>

Register format. Each accepts exactly one market: lucid_deDE, verpact_nlNL, ara_atAT, bdo_plPL, miteco_esES, conai_itIT.

Available options:
lucid_de,
verpact_nl,
ara_at,
bdo_pl,
miteco_es,
conai_it
reportType
enum<string>

The LUCID Meldungsart for lucid_de; worksheet registers always report ANNUAL.

Available options:
HPM1,
HMM1,
HJM1,
HNM1,
HAM1,
ANNUAL
systemOperatorId
string

The dual system's LUCID number. Empty string for worksheet registers, which have no system operator.

xsdVersion
string

The ZSVR schema version the file was built against; worksheet-1 for worksheet registers, which have no XSD.

status
enum<string>

Exactly one report per (periodYear, market, format) is generated — that is the one to download.

Available options:
generated,
superseded
version
integer
supersedesId
string<uuid> | null

The report this one replaced, or null.

snapshotHash
string

SHA-256 of the frozen snapshot.

generatedAt
string<date-time>