{"openapi":"3.1.0","info":{"title":"Voltaris Energy Data API","description":"Referenzdaten für den deutschen Strommarkt: Regelzonen und Netzbetreiber, Netzlast und Erzeugungsmix, Day-Ahead- und Ausgleichsenergiepreise, CO2-Intensität sowie Prüfung von MaLo-ID, Zählpunktbezeichnung, IBAN und USt-IdNr.","contact":{"name":"API Support","email":"support@example.com"},"license":{"name":""},"version":"1.0.0"},"paths":{"/v1/auth/token":{"post":{"tags":["auth"],"operationId":"token","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenReq"}}},"required":true},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResp"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/carbon/intensity":{"get":{"tags":["environment"],"operationId":"carbon","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"50hertz"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarbonResp"}}}}}}},"/v1/fx":{"get":{"tags":["billing"],"operationId":"fx","parameters":[{"name":"base","in":"query","required":false,"schema":{"type":"string"},"example":"EUR"},{"name":"symbols","in":"query","required":false,"schema":{"type":"string"},"example":"USD,CHF,PLN"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxResp"}}}}}}},"/v1/grid/generation":{"get":{"tags":["grid"],"operationId":"generation","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerationResp"}}}}}}},"/v1/grid/load":{"get":{"tags":["grid"],"operationId":"grid_load","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"},{"name":"hours","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":24}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoadResp"}}}}}}},"/v1/grid/operators":{"get":{"tags":["grid"],"operationId":"operators","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Operator"}}}}}}}},"/v1/grid/zones":{"get":{"tags":["grid"],"operationId":"zones","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ControlZone"}}}}}}}},"/v1/health":{"get":{"tags":["system"],"operationId":"health","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}}}},"/v1/holidays":{"get":{"tags":["billing"],"operationId":"holidays","parameters":[{"name":"state","in":"query","required":false,"schema":{"type":"string"},"example":"BY"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Holiday"}}}}}}}},"/v1/market/day-ahead":{"get":{"tags":["market"],"operationId":"day_ahead","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DayAheadResp"}}}}}}},"/v1/market/imbalance":{"get":{"tags":["market"],"operationId":"imbalance","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"},{"name":"hours","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0},"example":4}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImbalanceResp"}}}}}}},"/v1/meters/{malo}":{"get":{"tags":["grid"],"operationId":"meter","parameters":[{"name":"malo","in":"path","required":true,"schema":{"type":"string"},"example":"51238696788"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meter"}}}},"401":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"bearer_auth":[]}]}},"/v1/postcode/lookup":{"get":{"tags":["validation"],"operationId":"plz_lookup","parameters":[{"name":"plz","in":"query","required":true,"schema":{"type":"string"},"example":"60313"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlzResp"}}}}}}},"/v1/pricing":{"get":{"tags":["billing"],"operationId":"pricing","parameters":[{"name":"kwh","in":"query","required":false,"schema":{"type":"number","format":"double"},"example":3500.0},{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"},{"name":"segment","in":"query","required":false,"schema":{"type":"string"},"example":"household"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricingResp"}}}}}}},"/v1/status":{"get":{"tags":["system"],"operationId":"status","responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusResp"}}}}}}},"/v1/tariffs":{"get":{"tags":["billing"],"operationId":"tariffs","parameters":[{"name":"zone","in":"query","required":false,"schema":{"type":"string"},"example":"amprion"},{"name":"voltage","in":"query","required":false,"schema":{"type":"string"},"example":"nsp"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tariff"}}}}}}}},"/v1/validate/iban":{"get":{"tags":["validation"],"operationId":"iban_validate","parameters":[{"name":"iban","in":"query","required":true,"schema":{"type":"string"},"example":"DE89370400440532013000"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IbanResp"}}}}}}},"/v1/validate/malo":{"get":{"tags":["validation"],"operationId":"malo_validate","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"51238696788"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaloResp"}}}}}}},"/v1/validate/ustid":{"get":{"tags":["validation"],"operationId":"ustid_validate","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"},"example":"DE136695976"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UstIdResp"}}}}}}},"/v1/validate/zaehlpunkt":{"get":{"tags":["validation"],"operationId":"zaehlpunkt_validate","parameters":[{"name":"code","in":"query","required":true,"schema":{"type":"string"},"example":"DE0001234567800000000000000123456"}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZaehlpunktResp"}}}}}}},"/v1/vat/rates":{"get":{"tags":["billing"],"operationId":"vat_rates","responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/VatRate"}}}}}}}}},"components":{"schemas":{"ApiError":{"type":"object","required":["type","title","status","detail","request_id"],"properties":{"detail":{"type":"string"},"request_id":{"type":"string"},"status":{"type":"integer","format":"int32","minimum":0},"title":{"type":"string"},"type":{"type":"string"}}},"CarbonResp":{"type":"object","required":["zone","timestamp","intensity_g_co2_kwh","renewable_share_pct","rating","method"],"properties":{"intensity_g_co2_kwh":{"type":"integer","format":"int32","minimum":0},"method":{"type":"string"},"rating":{"type":"string"},"renewable_share_pct":{"type":"number","format":"double"},"timestamp":{"type":"string","format":"date-time"},"zone":{"type":"string"}}},"ControlZone":{"type":"object","required":["code","tso","eic","states","peak_load_mw","status"],"properties":{"code":{"type":"string"},"eic":{"type":"string"},"peak_load_mw":{"type":"integer","format":"int32","minimum":0},"states":{"type":"array","items":{"type":"string"}},"status":{"type":"string"},"tso":{"type":"string"}}},"DayAheadResp":{"type":"object","required":["zone","delivery_date","currency","base_eur_mwh","peak_eur_mwh","min_eur_mwh","max_eur_mwh","negative_hours","hours"],"properties":{"base_eur_mwh":{"type":"number","format":"double"},"currency":{"type":"string"},"delivery_date":{"type":"string"},"hours":{"type":"array","items":{"$ref":"#/components/schemas/PricePoint"}},"max_eur_mwh":{"type":"number","format":"double"},"min_eur_mwh":{"type":"number","format":"double"},"negative_hours":{"type":"integer","minimum":0},"peak_eur_mwh":{"type":"number","format":"double"},"zone":{"type":"string"}}},"FxResp":{"type":"object","required":["base","date","rates","source"],"properties":{"base":{"type":"string"},"date":{"type":"string"},"rates":{"type":"object","additionalProperties":{"type":"number","format":"double"},"propertyNames":{"type":"string"}},"source":{"type":"string"}}},"GenerationResp":{"type":"object","required":["zone","timestamp","total_mw","renewable_share_pct","sources"],"properties":{"renewable_share_pct":{"type":"number","format":"double"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/GenerationSlice"}},"timestamp":{"type":"string","format":"date-time"},"total_mw":{"type":"integer","format":"int32","minimum":0},"zone":{"type":"string"}}},"GenerationSlice":{"type":"object","required":["source","output_mw","share_pct","renewable"],"properties":{"output_mw":{"type":"integer","format":"int32","minimum":0},"renewable":{"type":"boolean"},"share_pct":{"type":"number","format":"double"},"source":{"type":"string"}}},"Health":{"type":"object","required":["status","service","version","timestamp"],"properties":{"service":{"type":"string"},"status":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"version":{"type":"string"}}},"Holiday":{"type":"object","required":["date","name","scope","nationwide"],"properties":{"date":{"type":"string"},"name":{"type":"string"},"nationwide":{"type":"boolean"},"scope":{"type":"string"}}},"IbanResp":{"type":"object","required":["iban","formatted","valid","country","length_ok","checksum_ok","bank_code","account","reason"],"properties":{"account":{"type":"string"},"bank_code":{"type":"string"},"checksum_ok":{"type":"boolean"},"country":{"type":"string"},"formatted":{"type":"string"},"iban":{"type":"string"},"length_ok":{"type":"boolean"},"reason":{"type":"string"},"valid":{"type":"boolean"}}},"ImbalancePoint":{"type":"object","required":["quarter_hour","rebap_eur_mwh","system_state","nrv_mw"],"properties":{"nrv_mw":{"type":"integer","format":"int32"},"quarter_hour":{"type":"string","format":"date-time"},"rebap_eur_mwh":{"type":"number","format":"double"},"system_state":{"type":"string"}}},"ImbalanceResp":{"type":"object","required":["zone","window_hours","average_rebap_eur_mwh","points"],"properties":{"average_rebap_eur_mwh":{"type":"number","format":"double"},"points":{"type":"array","items":{"$ref":"#/components/schemas/ImbalancePoint"}},"window_hours":{"type":"integer","format":"int32","minimum":0},"zone":{"type":"string"}}},"LoadPoint":{"type":"object","required":["hour","load_mw","forecast_mw","deviation_pct"],"properties":{"deviation_pct":{"type":"number","format":"double"},"forecast_mw":{"type":"integer","format":"int32","minimum":0},"hour":{"type":"string","format":"date-time"},"load_mw":{"type":"integer","format":"int32","minimum":0}}},"LoadResp":{"type":"object","required":["zone","window_hours","peak_mw","trough_mw","average_mw","points"],"properties":{"average_mw":{"type":"integer","format":"int32","minimum":0},"peak_mw":{"type":"integer","format":"int32","minimum":0},"points":{"type":"array","items":{"$ref":"#/components/schemas/LoadPoint"}},"trough_mw":{"type":"integer","format":"int32","minimum":0},"window_hours":{"type":"integer","format":"int32","minimum":0},"zone":{"type":"string"}}},"MaloResp":{"type":"object","required":["id","valid","length_ok","checksum_ok","reason"],"properties":{"checksum_ok":{"type":"boolean"},"expected_check_digit":{"type":["integer","null"],"format":"int32","minimum":0},"id":{"type":"string"},"length_ok":{"type":"boolean"},"reason":{"type":"string"},"valid":{"type":"boolean"}}},"Meter":{"type":"object","required":["malo_id","zaehlpunkt","meter_type","zone","grid_operator","voltage_level","annual_kwh","smart_meter","last_reading_at"],"properties":{"annual_kwh":{"type":"number","format":"double"},"grid_operator":{"type":"string"},"last_reading_at":{"type":"string","format":"date-time"},"malo_id":{"type":"string"},"meter_type":{"type":"string"},"smart_meter":{"type":"boolean"},"voltage_level":{"type":"string"},"zaehlpunkt":{"type":"string"},"zone":{"type":"string"}}},"Operator":{"type":"object","required":["id","name","role","zone","bdew_code","voltage_levels"],"properties":{"bdew_code":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"role":{"type":"string"},"voltage_levels":{"type":"array","items":{"type":"string"}},"zone":{"type":"string"}}},"PlzResp":{"type":"object","required":["plz","valid","state","state_code","control_zone","tso","grid_operator"],"properties":{"control_zone":{"type":"string"},"grid_operator":{"type":"string"},"plz":{"type":"string"},"state":{"type":"string"},"state_code":{"type":"string"},"tso":{"type":"string"},"valid":{"type":"boolean"}}},"PriceComponent":{"type":"object","required":["name","ct_per_kwh","amount_eur"],"properties":{"amount_eur":{"type":"number","format":"double"},"ct_per_kwh":{"type":"number","format":"double"},"name":{"type":"string"}}},"PricePoint":{"type":"object","required":["hour","price_eur_mwh","volume_mwh"],"properties":{"hour":{"type":"string","format":"date-time"},"price_eur_mwh":{"type":"number","format":"double"},"volume_mwh":{"type":"integer","format":"int32","minimum":0}}},"PricingResp":{"type":"object","required":["zone","segment","kwh","base_fee_eur_year","components","energy_net_eur","total_net_eur","vat_pct","total_gross_eur","effective_ct_kwh","currency"],"properties":{"base_fee_eur_year":{"type":"number","format":"double"},"components":{"type":"array","items":{"$ref":"#/components/schemas/PriceComponent"}},"currency":{"type":"string"},"effective_ct_kwh":{"type":"number","format":"double"},"energy_net_eur":{"type":"number","format":"double"},"kwh":{"type":"number","format":"double"},"segment":{"type":"string"},"total_gross_eur":{"type":"number","format":"double"},"total_net_eur":{"type":"number","format":"double"},"vat_pct":{"type":"number","format":"double"},"zone":{"type":"string"}}},"StatusResp":{"type":"object","required":["status","service","version","region","data_sources","uptime_seconds","timestamp"],"properties":{"data_sources":{"type":"array","items":{"type":"string"}},"region":{"type":"string"},"service":{"type":"string"},"status":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"uptime_seconds":{"type":"integer","format":"int64","minimum":0},"version":{"type":"string"}}},"Tariff":{"type":"object","required":["zone","voltage_level","grid_fee_ct_kwh","metering_eur_year","capacity_eur_kw_year","valid_from"],"properties":{"capacity_eur_kw_year":{"type":"number","format":"double"},"grid_fee_ct_kwh":{"type":"number","format":"double"},"metering_eur_year":{"type":"number","format":"double"},"valid_from":{"type":"string"},"voltage_level":{"type":"string"},"zone":{"type":"string"}}},"TokenReq":{"type":"object","required":["grant_type","client_id","client_secret"],"properties":{"client_id":{"type":"string"},"client_secret":{"type":"string"},"grant_type":{"type":"string"}}},"TokenResp":{"type":"object","required":["access_token","token_type","expires_in","scope"],"properties":{"access_token":{"type":"string"},"expires_in":{"type":"integer","format":"int64","minimum":0},"scope":{"type":"string"},"token_type":{"type":"string"}}},"UstIdResp":{"type":"object","required":["id","normalized","valid","country","length_ok","checksum_ok","reason"],"properties":{"checksum_ok":{"type":"boolean"},"country":{"type":"string"},"id":{"type":"string"},"length_ok":{"type":"boolean"},"normalized":{"type":"string"},"reason":{"type":"string"},"valid":{"type":"boolean"}}},"VatRate":{"type":"object","required":["country","standard_pct","reduced_pct","currency","effective_from"],"properties":{"country":{"type":"string"},"currency":{"type":"string"},"effective_from":{"type":"string"},"reduced_pct":{"type":"array","items":{"type":"number","format":"double"}},"standard_pct":{"type":"number","format":"double"}}},"ZaehlpunktResp":{"type":"object","required":["code","normalized","valid","country","operator_code","serial","length","reason"],"properties":{"code":{"type":"string"},"country":{"type":"string"},"length":{"type":"integer","minimum":0},"normalized":{"type":"string"},"operator_code":{"type":"string"},"reason":{"type":"string"},"serial":{"type":"string"},"valid":{"type":"boolean"}}}}},"tags":[{"name":"system","description":"Health & Status"},{"name":"grid","description":"Regelzonen, Netzbetreiber, Last und Erzeugung"},{"name":"market","description":"Day-Ahead, Ausgleichsenergie"},{"name":"environment","description":"CO2-Intensität"},{"name":"validation","description":"MaLo-ID, Zählpunkt, IBAN, USt-IdNr, PLZ"},{"name":"billing","description":"Netzentgelte, Preisberechnung, MwSt, Devisen, Feiertage"},{"name":"auth","description":"Authentifizierung"}]}