forked from bundesAPI/smard-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
308 lines (297 loc) · 8.83 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
openapi: "3.0.0"
info:
description: "Bundesnetzagentur Strommarktdaten"
version: "0.0.1"
title: "Bundesnetzagentur Strommarktdaten"
servers:
- url: "https://www.smard.de/app"
paths:
/chart_data/{filter}/{region}/index_{resolution}.json:
get:
parameters:
- $ref: "#/components/parameters/filterParameter"
- $ref: "#/components/parameters/regionParameter"
- $ref: "#/components/parameters/resolutionParameter"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Indices"
example:
timestamps: [1627855200000, 1628460000000, 1629064800000]
"404":
description: No data for combination of filter region and resolution
description: "Verfügbare Timestamps für Filter, Region und Auflösung"
summary: "Indizes"
/chart_data/{filter}/{region}/{filterCopy}_{regionCopy}_{resolution}_{timestamp}.json:
get:
parameters:
- $ref: "#/components/parameters/filterParameter"
- $ref: "#/components/parameters/filterCopyParameter"
- $ref: "#/components/parameters/regionParameter"
- $ref: "#/components/parameters/regionCopyParameter"
- $ref: "#/components/parameters/resolutionParameter"
- in: path
name: timestamp
schema:
type: integer
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/TimeSeries"
example:
meta_data: { "version": 1, "created": 1627858357549 }
series: [[1627250400000, 7866.0], [1627254000000, 7881.0]]
"404":
description: No data for combination of filter region and resolution or mismatch between *copy parameters
description: "Zeitreihendaten nach Filter, Region und Auflösung ab Timestamp"
summary: "Zeitreihendaten"
/table_data/{filter}/{region}/{filterCopy}_{regionCopy}_quarterhour_{timestamp}.json:
get:
parameters:
- $ref: "#/components/parameters/filterParameter"
- $ref: "#/components/parameters/filterCopyParameter"
- $ref: "#/components/parameters/regionParameter"
- $ref: "#/components/parameters/regionCopyParameter"
- in: path
name: timestamp
schema:
type: integer
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/TimeSeries2"
example:
meta_data: { "version": 1, "created": 1627858357549 }
series: ["values": [{ "timestamp": 1647817200000, "versions": [{ "value": 1225, "name": null }] }]]
"404":
description: No data for combination of filter region and resolution or mismatch between *copy parameters
description: "Zeitreihendaten nach Filter, Region und Auflösung ab Timestamp"
summary: "Zeitreihendaten"
components:
schemas:
Indices:
type: object
properties:
timestamps:
type: array
items:
type: integer
TimeSeries:
type: object
properties:
meta_data:
type: object
properties:
version:
type: integer
created:
type: integer
series:
type: array
items:
type: array
items:
type: number
TimeSeries2:
type: object
properties:
meta_data:
type: object
properties:
version:
type: integer
created:
type: integer
series:
type: array
items:
type: object
properties:
values:
type: array
items:
type: object
properties:
timestamp:
type: number
versions:
type: array
items:
type: object
properties:
value:
type: number
name: {}
parameters:
resolutionParameter:
in: path
name: resolution
schema:
type: string
enum: [hour, quarterhour, day, week, month, year]
default: hour
required: true
description: >
Auflösung der Daten:
* `hour` - Stündlich
* `quarterhour` - Viertelstündlich
* `day` - Täglich
* `week` - Wöchentlich
* `month` - Monatlich
* `year` - Jährlich
filterParameter:
in: path
name: filter
schema:
type: integer
enum:
[
1223,
1224,
1225,
1226,
1227,
1228,
4066,
4067,
4068,
4069,
4070,
4071,
410,
4359,
4387,
4169,
5078,
4996,
4997,
4170,
252,
253,
254,
255,
256,
257,
258,
259,
260,
261,
262,
]
required: true
description: >
Mögliche Filter:
* `1223` - Stromerzeugung: Braunkohle
* `1224` - Stromerzeugung: Kernenergie
* `1225` - Stromerzeugung: Wind Offshore
* `1226` - Stromerzeugung: Wasserkraft
* `1227` - Stromerzeugung: Sonstige Konventionelle
* `1228` - Stromerzeugung: Sonstige Erneuerbare
* `4066` - Stromerzeugung: Biomasse
* `4067` - Stromerzeugung: Wind Onshore
* `4068` - Stromerzeugung: Photovoltaik
* `4069` - Stromerzeugung: Steinkohle
* `4070` - Stromerzeugung: Pumpspeicher
* `4071` - Stromerzeugung: Erdgas
* `410` - Stromverbrauch: Gesamt (Netzlast)
* `4359` - Stromverbrauch: Residuallast
* `4387` - Stromverbrauch: Pumpspeicher
* `4169` - Marktpreis: Deutschland/Luxemburg
* `5078` - Marktpreis: Anrainer DE/LU
* `4996` - Marktpreis: Belgien
* `4997` - Marktpreis: Norwegen 2
* `4170` - Marktpreis: Österreich
* `252` - Marktpreis: Dänemark 1
* `253` - Marktpreis: Dänemark 2
* `254` - Marktpreis: Frankreich
* `255` - Marktpreis: Italien (Nord)
* `256` - Marktpreis: Niederlande
* `257` - Marktpreis: Polen
* `258` - Marktpreis: Polen
* `259` - Marktpreis: Schweiz
* `260` - Marktpreis: Slowenien
* `261` - Marktpreis: Tschechien
* `262` - Marktpreis: Ungarn
filterCopyParameter:
in: path
name: filterCopy
schema:
type: integer
enum:
[
1223,
1224,
1225,
1226,
1227,
1228,
4066,
4067,
4068,
4069,
4070,
4071,
410,
4359,
4387,
4169,
5078,
4996,
4997,
4170,
252,
253,
254,
255,
256,
257,
258,
259,
260,
261,
262,
]
required: true
description: >
Muss dem Wert von "filter" entsprechen. (Kaputtes API-Design)
regionCopyParameter:
in: path
name: regionCopy
schema:
type: string
enum: [DE, AT, LU, DE-LU, DE-AT-LU, 50Hertz, Amprion, TenneT, TransnetBW, APG, Creos]
required: true
description: >
Muss dem Wert von "region" entsprechen. (Kaputtes API-Design)
regionParameter:
in: path
name: region
schema:
type: string
enum: [DE, AT, LU, DE-LU, DE-AT-LU, 50Hertz, Amprion, TenneT, TransnetBW, APG, Creos]
default: DE
required: true
description: >
Land / Regelzone / Marktgebiet:
* `DE` - Land: Deutschland
* `AT` - Land: Österreich
* `LU` - Land: Luxemburg
* `DE-LU` - Marktgebiet: DE/LU (ab 01.10.2018)
* `DE-AT-LU` - Marktgebiet: DE/AT/LU (bis 30.09.2018)
* `50Hertz` - Regelzone (DE): 50Hertz
* `Amprion`- Regelzone (DE): Amprion
* `TenneT` - Regelzone (DE): TenneT
* `TransnetBW` - Regelzone (DE): TransnetBW
* `APG` - Regelzone (AT): APG
* `Creos` - Regelzone (LU): Creos