{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:corrently/easee-sessions":{"get":{"operationId":"open_data_corrently_easee_sessions","summary":"Returns lastSession info for all easee wallboxes (chargers) given user has access to.","description":"GET /alternative/easee/lastSessions","tags":["open-data"],"parameters":[{"name":"username","in":"query","required":false,"description":"Username as used on easy.cloud","schema":{"type":"string","description":"Username as used on easy.cloud"}},{"name":"password","in":"query","required":false,"description":"Password as used on easy.cloud","schema":{"type":"string","description":"Password as used on easy.cloud"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/ocpp-sessions":{"get":{"operationId":"open_data_corrently_ocpp_sessions","summary":"Last Session Info","description":"GET /alternative/ocpp/lastSessions","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/om-activities":{"get":{"operationId":"open_data_corrently_om_activities","summary":"Public shared smart meters installed in Germany and available for subservices and exploration.","description":"GET /alternative/openmeter/activities","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/om-meters":{"get":{"operationId":"open_data_corrently_om_meters","summary":"Public shared smart meters installed in Germany and available for subservices and exploration.","description":"GET /alternative/openmeter/meters","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/om-readings":{"get":{"operationId":"open_data_corrently_om_readings","summary":"Public shared smart meters installed in Germany and available for subservices and exploration.","description":"GET /alternative/openmeter/readings","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/gsi-besthour":{"get":{"operationId":"open_data_corrently_gsi_besthour","summary":"Get best hour (with most regional green energy) in a given timeframe.","description":"GET /gsi/bestHour","tags":["open-data"],"parameters":[{"name":"zip","in":"query","required":false,"description":"Zipcode (Postleitzahl) of a city in Germany.","schema":{"type":"string","description":"Zipcode (Postleitzahl) of a city in Germany."}},{"name":"key","in":"query","required":false,"description":"Any valid Stromkonto account (address).","schema":{"type":"string","description":"Any valid Stromkonto account (address)."}},{"name":"timeframe","in":"query","required":false,"description":"Number of hours to check (default 24 hours from now).","schema":{"type":"integer","description":"Number of hours to check (default 24 hours from now)."}},{"name":"hours","in":"query","required":false,"description":"How many hours in row do you need the device turned on?","schema":{"type":"integer","description":"How many hours in row do you need the device turned on?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/gsi-dispatch":{"get":{"operationId":"open_data_corrently_gsi_dispatch","summary":"Dispatch (Green Energy Distribution Schedule)","description":"GET /gsi/dispatch","tags":["open-data"],"parameters":[{"name":"zip","in":"query","required":false,"description":"Zipcode (Postleitzahl) of a city in Germany.","schema":{"type":"string","description":"Zipcode (Postleitzahl) of a city in Germany."}},{"name":"key","in":"query","required":false,"description":"Any valid Stromkonto account (address).","schema":{"type":"string","description":"Any valid Stromkonto account (address)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/gsi-marketdata":{"get":{"operationId":"open_data_corrently_gsi_marketdata","summary":"Marketdata","description":"GET /gsi/marketdata","tags":["open-data"],"parameters":[{"name":"zip","in":"query","required":false,"description":"Zipcode (Postleitzahl) of a city in Germany.","schema":{"type":"string","description":"Zipcode (Postleitzahl) of a city in Germany."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/gsi-prediction":{"get":{"operationId":"open_data_corrently_gsi_prediction","summary":"Prediction","description":"GET /gsi/prediction","tags":["open-data"],"parameters":[{"name":"zip","in":"query","required":false,"description":"Zipcode (Postleitzahl) of a city in Germany.","schema":{"type":"string","description":"Zipcode (Postleitzahl) of a city in Germany."}},{"name":"key","in":"query","required":false,"description":"Any valid Stromkonto account (address).","schema":{"type":"string","description":"Any valid Stromkonto account (address)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/metering-get":{"get":{"operationId":"open_data_corrently_metering_get","summary":"Meter Reading","description":"GET /metering/reading","tags":["open-data"],"parameters":[{"name":"account","in":"query","required":false,"description":"Account/Address (Stromkonto) to retrieve reading for.","schema":{"type":"string","description":"Account/Address (Stromkonto) to retrieve reading for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/metering-post":{"post":{"operationId":"open_data_corrently_metering_post","summary":"Meter Reading","description":"POST /metering/reading","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-comit":{"post":{"operationId":"open_data_corrently_quittung_comit","summary":"Finishs a collection of data and finalizes receipt. Use this method after collecting all data via…","description":"POST /quittung/commit","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-create":{"post":{"operationId":"open_data_corrently_quittung_create","summary":"Create a receipt for an energy delivery (only valid in Germany).","description":"POST /quittung/create","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-prepare":{"post":{"operationId":"open_data_corrently_quittung_prepare","summary":"Allows to collect data with several requests (or a single) for a receipt.","description":"POST /quittung/prepare","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-tse":{"post":{"operationId":"open_data_corrently_quittung_tse","summary":"Retrieve TSE (Technische Sicherheitseinrichtung) Data for a given receipt (Strom-Quittung).","description":"POST /quittung/tse","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account":{"type":"string","description":"Quittung Identifier (serialnumber generated during receipt generation process)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-tsedata":{"post":{"operationId":"open_data_corrently_quittung_tsedata","summary":"Retrieve TSE (Technische Sicherheitseinrichtung) raw data only for a given receipt (Strom-Quittung).","description":"POST /quittung/tsedata","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account":{"type":"string","description":"Quittung Identifier (serialnumber generated during receipt generation process)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-tsesignature":{"post":{"operationId":"open_data_corrently_quittung_tsesignature","summary":"Retrieve TSE (Technische Sicherheitseinrichtung) Signature only for a given receipt (Strom-Quittung).","description":"POST /quittung/tsesignature","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"account":{"type":"string","description":"Quittung Identifier (serialnumber generated during receipt generation process)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/quittung-zugferd":{"get":{"operationId":"open_data_corrently_quittung_zugferd","summary":"Retrieve Zugferd XML for a given receipt (Strom-Quittung).","description":"GET /quittung/zugferd","tags":["open-data"],"parameters":[{"name":"account","in":"query","required":false,"description":"Quittung Identifier (serialnumber generated during receipt generation process)","schema":{"type":"string","description":"Quittung Identifier (serialnumber generated during receipt generation process)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/stromkonto-balances":{"get":{"operationId":"open_data_corrently_stromkonto_balances","summary":"Balances","description":"GET /stromkonto/balances","tags":["open-data"],"parameters":[{"name":"account","in":"query","required":false,"description":"Ethereum style address referencing a valid account (AKA Stromkonto).","schema":{"type":"string","description":"Ethereum style address referencing a valid account (AKA Stromkonto)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/stromkonto-choices":{"get":{"operationId":"open_data_corrently_stromkonto_choices","summary":"Selectable Choices for customer","description":"GET /stromkonto/choices","tags":["open-data"],"parameters":[{"name":"account","in":"query","required":false,"description":"Ethereum style address referencing a valid account alias (never use Stromkonto directly!).","schema":{"type":"string","description":"Ethereum style address referencing a valid account alias (never use Stromkonto directly!)."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/stromkonto-login":{"post":{"operationId":"open_data_corrently_stromkonto_login","summary":"Login (via Mail)","description":"POST /stromkonto/login","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/prepare-transaction":{"post":{"operationId":"open_data_corrently_prepare_transaction","summary":"Prepare Transaction","description":"POST /stromkonto/prepareTransaction","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/stromkonto-register":{"post":{"operationId":"open_data_corrently_stromkonto_register","summary":"Register (new Stromkonto)","description":"POST /stromkonto/register","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:corrently/tariffcomponents":{"get":{"operationId":"open_data_corrently_tariffcomponents","summary":"Energy Tariff price components","description":"GET /tariff/components","tags":["open-data"],"parameters":[{"name":"zipcode","in":"query","required":false,"description":"Zipcode (Postzleitzahl) of a city in Germany.","schema":{"type":"string","description":"Zipcode (Postzleitzahl) of a city in Germany."}},{"name":"email","in":"query","required":false,"description":"Valid email address to assign request to (pre offer generation). Ensure GDPR (DSGVO) at any time","schema":{"type":"string","description":"Valid email address to assign request to (pre offer generation). Ensure GDPR (DSGVO) at any time"}},{"name":"kwha","in":"query","required":false,"description":"Total amount of energy in kilo-watt-hours per year. (sample 2100)","schema":{"type":"integer","description":"Total amount of energy in kilo-watt-hours per year. (sample 2100)"}},{"name":"milliseconds","in":"query","required":false,"description":"If provided all results will be scaled to this timeframe","schema":{"type":"integer","description":"If provided all results will be scaled to this timeframe"}},{"name":"wh","in":"query","required":false,"description":"If provided together with milliseconds, a cost component stament for a particular event (like charging a car) will be created.","schema":{"type":"integer","description":"If provided together with milliseconds, a cost component stament for a particular event (like charging a car) will be created."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/tariff-slph0":{"get":{"operationId":"open_data_corrently_tariff_slph0","summary":"Energy Tariff information","description":"GET /tariff/slph0","tags":["open-data"],"parameters":[{"name":"zipcode","in":"query","required":false,"description":"Zipcode (Postzleitzahl) of a city in Germany.","schema":{"type":"string","description":"Zipcode (Postzleitzahl) of a city in Germany."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:corrently/wimstatus":{"get":{"operationId":"open_data_corrently_wimstatus","summary":"WiM Proess Informtion","description":"GET /wim/status","tags":["open-data"],"parameters":[{"name":"vid","in":"query","required":false,"description":"VID key of the process.","schema":{"type":"string","description":"VID key of the process."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}