-
Notifications
You must be signed in to change notification settings - Fork 0
/
tankerkoenig.yaml
688 lines (688 loc) · 19.2 KB
/
tankerkoenig.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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
openapi: "3.0.3"
servers:
- url: 'https://creativecommons.tankerkoenig.de/api/v4'
info:
version: 4.0.6
title: Tankerkönig API
description:
API for getting real time gas prices from
https:\/\/creativecommons.tankerkoenig.de. Real time gas price data is
available under open data/open source license even for commercial use.
Currently only prices for Germany are available.
contact:
name: Tankerkoenig API Support
url: 'https://creativecommons.tankerkoenig.de/'
email: [email protected]
paths:
/stations/search:
get:
tags:
- search
description: Aktuelle Kraftstoffpreise an Tankstellen im Umkreis
parameters:
- name: apikey
in: query
required: true
description: Gültiger API-key / Valid API key.
schema:
type: string
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
example: cffa4fb8-7a16-cd85-7946-263722530f15
- name: lat
in: query
required: true
description: Latitude
schema:
type: number
example: 48.8
- name: lng
in: query
required: true
description: Longitude
schema:
type: number
example: 9.24
- name: rad
in: query
description: Radius in km (max 25)
schema:
type: number
minimum: 0
maximum: 25
example: 10
responses:
'200':
description: Tankstellenliste mit aktuellen Kraftstoffpreisen
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-200'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-400'
'401':
description: Unauthorized - invalid API key
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-401'
'404':
description: Not Found
'500':
description: Internal Server Error
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-500'
'503':
description: Service Unavailable - rate limit exceeded
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-503'
/stations/ids:
get:
tags:
- search
description: Aktuelle Kraftstoffpreise an Tankstellen nach IDs
parameters:
- name: apikey
in: query
required: true
description: Gültiger API-key / Valid API key.
schema:
type: string
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
example: cffa4fb8-7a16-cd85-7946-263722530f15
- name: ids
in: query
required: true
description:
Liste von Land, Tankstellen-IDs (komma-separiert) / List of country
/ station ids (comma separated).
schema:
type: string
example: 92f703e8-0b3c-46da-9948-25cb1a6a1514,83d5ac80-4f23-4106-b054-7c7704bfcb95
- name: lat
in: query
required: false
description: Latitude. If latitude and longitude are given, dist to this coordinates is shown in the output
schema:
type: number
example: 48.8
- name: lng
in: query
required: false
description: Longitude. If latitude and longitude are given, dist to this coordinates is shown in the output
schema:
type: number
example: 9.24
responses:
'200':
description: Liste von Tankstellen.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-200'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-400'
'401':
description: Unauthorized - invalid API key
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-401'
'404':
description: Not Found
'500':
description: Internal Server Error
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-500'
'503':
description: Service Unavailable - rate limit exceeded
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-503'
/stations/postalcode:
get:
tags:
- search
description: Aktuelle Kraftstoffpreise an Tankstellen nach Postleitzahl
parameters:
- name: apikey
in: query
required: true
description: Gültiger API-key / Valid API key.
schema:
type: string
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
example: cffa4fb8-7a16-cd85-7946-263722530f15
- name: postalcode
in: query
required: true
description: 'Land:Postleitzahl / county:postalcode'
schema:
type: string
example: '70372'
responses:
'200':
description: Liste von Tankstellen.
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-200'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-400'
'401':
description: Unauthorized - invalid API key
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-401'
'404':
description: Not Found
'500':
description: Internal Server Error
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-500'
'503':
description: Service Unavailable - rate limit exceeded
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-503'
/stats:
get:
tags:
- statistics
summary: ''
description: ''
parameters:
- name: apikey
in: query
required: true
description: Gültiger API-key / Valid API key.
schema:
type: string
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
example: cffa4fb8-7a16-cd85-7946-263722530f15
responses:
'200':
description: Statistik / Statistics
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-stats-200'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-400'
'401':
description: Unauthorized - invalid API key
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-401'
'500':
description: Internal Server Error
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-500'
'503':
description: Service Unavailable - rate limit exceeded
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-500'
/complaint:
post:
tags:
- complaint
summary: Send a complaint with correction
description: There are several complaint types allowed, see complaint model. Correction depends on complaint type -- wrongPrice - the correct price as float. wrongPetrolLocation - correct location as LAT,LON (2 floats). Omitted for wrongStatus. For all others - corrected value
requestBody:
description: Content of complaint with corrrection
content:
application/json:
schema:
$ref: '#/components/schemas/complaint'
responses:
'200':
description: OK
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-stats-200'
'400':
description: Bad Request
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-400'
'401':
description: Unauthorized - invalid API key
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-401'
'500':
description: Internal Server Error
content:
application/json; charset=utf-8:
schema:
$ref: '#/components/schemas/response-500'
components:
schemas:
response-200:
type: object
required:
- stations
- apiVersion
- timestamp
properties:
apiVersion:
type: string
example: 4.0.6
timestamp:
type: string
format: date-time
example: '2020-01-04T22:14:06+01:00'
stations:
$ref: '#/components/schemas/stations'
fuelstat:
type: object
properties:
count:
type: number
format: integer
example: 12345
mean:
type: number
format: float
example: 1.11
median:
type: number
format: float
example: 1.12
station:
type: object
required:
- id
- coords
- fuels
- postalCode
properties:
country:
type: string
example: de
id:
type: string
example: 83d5ac80-4f23-4106-b054-7c7704bfcb95
name:
type: string
example: Aral Tankstelle
brand:
type: string
example: ARAL
street:
type: string
example: Cannstatter Straße 3
postalCode:
type: string
example: "70190"
place:
type: string
example: Stuttgart
coords:
type: object
required:
- lat
- lng
properties:
lat:
type: number
format: float
example: 48.78922
lng:
type: number
format: float
example: 9.192324
isOpen:
type: boolean
example: true
closesAt:
type: string
format: date-time
example: '2020-01-05T06:00:00+01:00'
opensAt:
type: string
format: date-time
example: '2020-01-05T06:00:00+01:00'
openingTimes:
type: array
items:
type: object
properties:
days:
type: array
items:
type: string
enum:
- mon
- tue
- wed
- thu
- fri
- sat
- sun
- hol
times:
type: array
items:
type: object
properties:
open:
type: string
pattern: '^\d{2}:\d{2}$'
example: '06:00'
close:
type: string
pattern: '^\d{2}:\d{2}$'
example: '20:00'
dist:
type: number
format: float
example: 2.5
fuels:
type: array
items:
type: object
required:
- name
- category
- price
properties:
category:
type: string
enum:
- diesel
- lpg
- gasoline
- cng
example: gasoline
name:
type: string
example: Super E5
price:
type: number
format: float
example: 1.399
lastChange:
type: object
required:
- timestamp
- amount
properties:
timestamp:
type: string
format: date-time
example: '2020-01-04T22:05:06+01'
amount:
type: number
format: float
example: -0.07
stations:
type: array
items:
$ref: '#/components/schemas/station'
openingTimes:
type: array
items:
type: object
properties:
days:
type: array
items:
type: string
enum:
- mon
- tue
- wed
- thu
- fri
- sat
- sun
- hol
times:
type: array
items:
type: object
properties:
open:
type: string
pattern: '^\d{2}:\d{2}$'
example: '06:00'
close:
type: string
pattern: '^\d{2}:\d{2}$'
example: '20:00'
days:
type: array
items:
type: string
enum:
- mon
- tue
- wed
- thu
- fri
- sat
- sun
- hol
times:
type: array
items:
type: object
properties:
open:
type: string
pattern: '^\d{2}:\d{2}$'
example: '06:00'
close:
type: string
pattern: '^\d{2}:\d{2}$'
example: '20:00'
openingTimesEntry:
type: object
properties:
days:
type: array
items:
type: string
enum:
- mon
- tue
- wed
- thu
- fri
- sat
- sun
- hol
times:
type: array
items:
type: object
properties:
open:
type: string
pattern: '^\d{2}:\d{2}$'
example: '06:00'
close:
type: string
pattern: '^\d{2}:\d{2}$'
example: '20:00'
fuel:
type: object
required:
- name
- category
- price
properties:
category:
type: string
enum:
- diesel
- lpg
- gasoline
- cng
example: gasoline
name:
type: string
example: Super E5
price:
type: number
format: float
example: 1.399
lastChange:
type: object
required:
- timestamp
- amount
properties:
timestamp:
type: string
format: date-time
example: '2020-01-04T22:05:06+01'
amount:
type: number
format: float
example: -0.07
complaint:
description: Complaint entry, used to give feedback for incorrect data.
type: object
required:
- apikey
- id
- type
properties:
apikey:
description: API key of the submitter
type: string
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
example: cffa4fb8-7a16-cd85-7946-263722530f15
id:
description: UUID of station for which a complaint is sent
type: string
pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$'
example: cb1f0588-d517-40f0-8ce3-3edadebea40d
type:
description: Type of complaint
type: string
enum:
- wrongPetrolStationName
- wrongStatusOpen
- wrongStatusClosed
- wrongPriceE5
- wrongPriceE10
- wrongPriceDiesel
- wrongPetrolStationBrand
- wrongPetrolStationStreet
- wrongPetrolStationHouseNumber
- wrongPetrolStationPostcode
- wrongPetrolStationPlace
- wrongPetrolStationLocation
example: wrongStatusOpen
correction:
description: wrongPrice - the correct price as float. wrongPetrolLocation - correct location as LAT,LON (2 floats). Omitted for wrongStatus. For all others - corrected value
type: string
example: ""
response-400:
type: object
required:
- code
- message
properties:
code:
type: number
example: 400
message:
type: string
example: Bad request
response-stats-200:
type: object
required:
- license
- apiVersion
- timestamp
properties:
apiVersion:
type: string
example: 4.0.6
timestamp:
type: string
format: date-time
example: '2020-01-04T22:14:06+01:00'
license:
type: string
example: CC BY NC http://www.tankerkoenig.de
Diesel:
$ref: '#/components/schemas/fuelstat'
E5:
$ref: '#/components/schemas/fuelstat'
E10:
$ref: '#/components/schemas/fuelstat'
response-401:
type: object
required:
- code
- message
properties:
code:
type: number
example: 401
message:
type: string
example: Unauthorized - invalid API key
response-500:
type: object
required:
- code
- message
properties:
code:
type: number
example: 500
message:
type: string
example: Internal Server Error
response-503:
type: object
required:
- code
- message
properties:
code:
type: number
example: 503
message:
type: string
example: Service Unavailable - rate limit exceeded