{ "openapi": "3.1.1", "info": { "title": "SpotWave.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "https://spotwave.eu/api" } ], "paths": { "/calendar/{market}.ics": { "get": { "tags": [ "Calendar" ], "parameters": [ { "name": "market", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "hours", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 2 } }, { "name": "lang", "in": "query", "schema": { "type": "string", "default": "en" } } ], "responses": { "200": { "description": "OK" } } } }, "/health": { "get": { "tags": [ "Health" ], "responses": { "200": { "description": "OK" } } } }, "/history": { "get": { "tags": [ "History" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HistoryResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HistoryResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HistoryResponse" } } } } } } }, "/history/month": { "get": { "tags": [ "History" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "month", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/HistoryMonthResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/HistoryMonthResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HistoryMonthResponse" } } } } } } }, "/meta/markets": { "get": { "tags": [ "Meta" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketResponse" } } } } } } } }, "/meta/status": { "get": { "tags": [ "Meta" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MetaStatusResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MetaStatusResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MetaStatusResponse" } } } } } } }, "/seo/summary": { "get": { "tags": [ "SeoSummary" ], "parameters": [ { "name": "market", "in": "query", "schema": { "type": "string" } }, { "name": "lang", "in": "query", "schema": { "type": "string", "default": "en" } }, { "name": "kind", "in": "query", "schema": { "type": "string", "default": "today" } }, { "name": "place", "in": "query", "schema": { "type": "string" } }, { "name": "part", "in": "query", "schema": { "type": "string", "default": "body" } }, { "name": "period", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/forecast": { "get": { "tags": [ "SpotPrice" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailPricebreakdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailPricebreakdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailPricebreakdown" } } } } } } } }, "/SpotPrice": { "get": { "tags": [ "SpotPrice" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailPricebreakdown" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailPricebreakdown" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RetailPricebreakdown" } } } } } } } }, "/SpotPrice/current": { "get": { "tags": [ "SpotPrice" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SpotPrice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SpotPrice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SpotPrice" } } } } } } }, "/SpotPrice/stats": { "get": { "tags": [ "SpotPrice" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PriceBaselineResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PriceBaselineResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PriceBaselineResponse" } } } } } } }, "/SpotPrice/context": { "get": { "tags": [ "SpotPrice" ], "parameters": [ { "name": "country", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PriceContextResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PriceContextResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PriceContextResponse" } } } } } } }, "/compare": { "get": { "tags": [ "SpotPrice" ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CompareResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CompareResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CompareResponse" } } } } } } } }, "components": { "schemas": { "CompareResponse": { "type": "object", "properties": { "asOf": { "type": "string", "format": "date-time" }, "euAvgSpot": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/CompareZone" } } } }, "CompareZone": { "type": "object", "properties": { "country": { "type": "string" }, "name": { "type": "string" }, "currentAllIn": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spot": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxShare": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatRate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "todayMin": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "todayMax": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isNegative": { "type": "boolean" }, "sparkline": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } }, "native": { "$ref": "#/components/schemas/NativeCompareFigures" } } }, "DayPoint": { "required": [ "date", "price" ], "type": "object", "properties": { "date": { "type": "string" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "FixedCostBreakdown": { "type": "object", "properties": { "gridFixedPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "energyTaxCreditPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "netPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "native": { "$ref": "#/components/schemas/NativeFixedCostBreakdown" } } }, "HistoryDay": { "type": "object", "properties": { "date": { "type": "string" }, "avg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "min": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "max": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "negativeHours": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "HistoryMonth": { "type": "object", "properties": { "month": { "type": "string" }, "avg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "min": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "max": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "negativeHours": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "HistoryMonthResponse": { "type": "object", "properties": { "country": { "type": "string" }, "currency": { "type": "string" }, "month": { "type": "string" }, "avg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "negativeHours": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "days": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryDay" } }, "cheapestDay": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DayPoint" } ] }, "priciestDay": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DayPoint" } ] }, "previousMonthAvg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "sameMonthLastYearAvg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "HistoryRecords": { "type": "object", "properties": { "cheapestDay": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DayPoint" } ] }, "priciestDay": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DayPoint" } ] }, "cheapestHour": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/HourPoint" } ] }, "priciestHour": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/HourPoint" } ] } } }, "HistoryResponse": { "type": "object", "properties": { "country": { "type": "string" }, "currency": { "type": "string" }, "months": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryMonth" } }, "years": { "type": "array", "items": { "$ref": "#/components/schemas/HistoryYear" } }, "records": { "$ref": "#/components/schemas/HistoryRecords" }, "hourProfile": { "type": "array", "items": { "$ref": "#/components/schemas/HourAverage" } } } }, "HistoryYear": { "type": "object", "properties": { "year": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "avg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "negativeHours": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hours": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "HourAverage": { "required": [ "hour", "price" ], "type": "object", "properties": { "hour": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "HourPoint": { "required": [ "hourUtc", "price" ], "type": "object", "properties": { "hourUtc": { "type": "string", "format": "date-time" }, "price": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "MarketResponse": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "currency": { "type": "string" }, "fees": { "$ref": "#/components/schemas/FixedCostBreakdown" } } }, "MetaStatusResponse": { "type": "object", "properties": { "lastUpdated": { "type": [ "null", "string" ], "format": "date-time" }, "tomorrowDate": { "type": "string" }, "tomorrowPublished": { "type": "object", "additionalProperties": { "type": "boolean" } } } }, "NativeCompareFigures": { "type": "object", "properties": { "currency": { "type": "string" }, "currentAllIn": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "spot": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "todayMin": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "todayMax": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sparkline": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } } }, "NativeFixedCostBreakdown": { "type": "object", "properties": { "currency": { "type": "string" }, "gridFixedPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "energyTaxCreditPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "netPerMonth": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "NativePriceBaseline": { "type": "object", "properties": { "currency": { "type": "string" }, "p25": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "median": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "p75": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "avg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "NativePriceBreakdown": { "type": "object", "properties": { "currency": { "type": "string" }, "spotPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "energyTaxPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "gridFeePerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "NativePriceContext": { "type": "object", "properties": { "currency": { "type": "string" }, "yearAvg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lastYearAvg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "typical": { "type": "array", "items": { "$ref": "#/components/schemas/NativePriceContextTypical" } } } }, "NativePriceContextTypical": { "type": "object", "properties": { "i": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "low": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "mid": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "high": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PriceBaselineResponse": { "type": "object", "properties": { "p25": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "median": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "p75": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "avg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "native": { "$ref": "#/components/schemas/NativePriceBaseline" } } }, "PriceContextResponse": { "type": "object", "properties": { "yearAvg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lastYearAvg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "typical": { "type": "array", "items": { "$ref": "#/components/schemas/PriceContextTypical" } }, "native": { "$ref": "#/components/schemas/NativePriceContext" } } }, "PriceContextTypical": { "type": "object", "properties": { "i": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "low": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "mid": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "high": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "RetailPricebreakdown": { "type": "object", "properties": { "periodUtc": { "type": "string", "format": "date-time" }, "country": { "type": "string" }, "spotEurPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "energyTaxEurPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "gridFeeEurPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vatEurPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalEurPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "native": { "$ref": "#/components/schemas/NativePriceBreakdown" } } }, "SpotPrice": { "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "country": { "type": "string" }, "hourUtc": { "type": "string", "format": "date-time" }, "eurPerKwh": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } } } }, "tags": [ { "name": "Calendar" }, { "name": "Health" }, { "name": "History" }, { "name": "Meta" }, { "name": "SeoSummary" }, { "name": "SpotPrice" } ] }