forked from AndreasFischer1985/tagesschau-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi_en.yaml
565 lines (548 loc) · 15.6 KB
/
openapi_en.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
openapi: "3.0.0"
info:
description: "The Tagesschau is a news program of the ARD (abbreviation for 'Arbeitsgemeinschaft der öffentlich-rechtlichen Rundfunkanstalten der Bundesrepublik Deutschland’), which is produced by ARD-aktuell in Hamburg and broadcast several times a day. ARD-aktuell has been the central television news department of ARD since 1977, which in turn is a broadcasting association consisting of the state broadcasting corporations and Deutsche Welle.
<br><br>
Current news and media articles are available in JSON format on [www.tagesschau.de](https://www.tagesschau.de) via the API documented here.
<br><br>
**Attention:** The use of the content for private, non-commercial use is permitted, but publication is not - with the exception of content that is explicitly under the CC license (https://tagesschau.de/creativecommons). It is not permitted to make more than 60 requests per hour."
version: "2.0.1"
title: "Tagesschau API"
contact:
name: "AndreasFischer1985"
email: "[email protected]"
url: "https://github.com/AndreasFischer1985/tagesschau-api"
servers:
- url: "https://www.tagesschau.de"
paths:
/api2u/homepage:
get:
summary: "Selected news and breaking news"
description: "Selected news and breaking news that are shown on the homepage of the Tagesschau app."
operationId: "homepage"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HomepageResponse'
/api2u/news:
get:
summary: "Current news and breaking news"
description: "Current news and breaking news"
operationId: "news"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/NewsResponse'
parameters:
- in: query
name: regions
schema:
type: integer
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
description: State - 1=Baden-Württemberg, 2=Bayern, 3=Berlin, 4=Brandenburg, 5=Bremen, 6=Hamburg, 7=Hessen, 8=Mecklenburg-Vorpommern, 9=Niedersachsen, 10=Nordrhein-Westfalen, 11=Rheinland-Pfalz, 12=Saarland, 13=Sachsen, 14=Sachsen-Anhalt, 15=Schleswig-Holstein, 16=Thüringen. Multiple comma-separated specifications possible (e.g. regions=1,2).
example: 1
required: false
- in: query
name: ressort
schema:
type: string
enum:
- inland
- ausland
- wirtschaft
- sport
- video
- investigativ
- wissen
example: ausland
description: Department/subject area
required: false
/api2u/channels:
get:
summary: "Current channels"
description: "Current channels (im Livestream: tagesschau24, tagesschau in 100 Sekunden, tagesschau, tagesschau 20 Uhr, tagesthemen, nachtmagazin, Bericht aus Berlin, tagesschau vor 20 Jahren, tagesschau mit Gebärdensprache)"
operationId: "channels"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ChannelsResponse'
/api2u/search:
get:
summary: "Search"
description: "Search"
operationId: "search"
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SearchResponse'
parameters:
- in: query
name: searchText
schema:
type: string
description: search text
example: Ukraine
required: false
- in: query
name: pageSize
schema:
type: integer
description: page
example: 0
required: false
- in: query
name: resultPage
schema:
type: integer
description: Search results per page (1-30)
example: 2
required: false
components:
schemas:
HomepageResponse:
type: object
properties:
news:
type: array
required: [date,title,content,topline,details,detailsweb,tracking,shareURL,images,teaserImage]
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
regionId:
type: string
updateCheckUrl:
type: string
images:
type: array
items:
type: object
streams:
type: object
copyright:
type: string
example: ""
details:
type: string
detailsweb:
type: string
shareURL:
type: string
topline:
type: string
firstSentence:
type: string
geotags:
type: string
crop:
type: object
ressort:
type: string
example: ausland
type:
type: string
breakingNews:
type: boolean
firstFrame:
type: object
regional:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
regionId:
type: string
images:
type: array
items:
type: object
details:
type: string
detailsweb:
type: string
shareURL:
type: string
topline:
type: string
firstSentence:
type: string
geotags:
type: string
brandingImage:
type: object
type:
type: string
example: story
breakingNews:
type: boolean
newStoriesCountLink:
type: string
example: "https://www.tagesschau.de/api2/indexfeedcount-101.json?state=YdphL1CNXIsJ33egKMFCo7yZ9%2FBgxRy3VBMYH%2B4gXtyYxqph5eBf433P%2BmTx36pT3TNwNBsqS9LGyGTm%2BFNP6Ykcuvx4dwpECIpSHNwOVMzasdtSPFocAe%2FlGxV597w39uXLjqQTyImeeJiLS6fxvQ%3D%3D"
type:
type: string
example: news
NewsResponse:
type: object
properties:
news:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
date:
type: string
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
regionId:
type: integer
details:
type: string
detailsweb:
type: string
shareURL:
type: string
topline:
type: string
firstSentence:
type: string
geotags:
type: array
items:
type: object
regional:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
regionId:
type: string
images:
type: array
items:
type: object
details:
type: string
detailsweb:
type: string
shareURL:
type: string
topline:
type: string
firstSentence:
type: string
geotags:
type: string
brandingImage:
type: object
type:
type: string
example: story
breakingNews:
type: boolean
newStoriesCountLink:
type: array
items:
type: object
type:
type: string
example: "news page"
nextPage:
type: string
example: "https://www.tagesschau.de/api2/newsfeed-101~_date-220227.json"
SearchResponse:
type: object
properties:
type:
type: string
example: search
sophoraId:
type: string
trackingPixels:
type: array
items:
type: object
details:
type: string
detailsWeb:
type: string
date:
type: string
searchText:
type: string
example: Ukraine
query:
type: string
example: "searchField_t:Ukraine"
totalItemCount:
type: integer
example: 1501
SolrQuery:
type: string
example: "dateTime_dt:[NOW-30DAY TO NOW] AND (primaryType_s:\"sophora-content-nt:story\" OR primaryType_s:\"sophora-content-nt:video\" OR primaryType_s:\"sophora-content-nt:broadcast\") AND -(primaryType_s:\"sophora-content-nt:video\" AND (headline_s:\"Ganze Sendung\" OR sophora-content_contentType_s:sendung))"
searchResults:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
date:
type: string
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
streams:
type: object
copyright:
type: string
example: ""
type:
type: string
example: "video"
alttext:
type: string
example: "Sendungsbild"
ChannelsResponse:
type: object
properties:
channels:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
streams:
type: object
copyright:
type: string
example: ""
type:
type: string
example: "video"
alttext:
type: string
example: "tagesschau24"
type:
type: string
example: "channels"
MultimediaResponse:
type: object
properties:
news:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
date:
type: string
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
regionId:
type: integer
details:
type: string
detailsweb:
type: string
shareURL:
type: string
topline:
type: string
firstSentence:
type: string
geotags:
type: array
items:
type: object
regional:
type: array
items:
type: object
properties:
sophoraId:
type: string
externalId:
type: string
title:
type: string
teaserImage:
type: object
tracking:
type: array
items:
type: object
tags:
type: array
items:
type: object
updateCheckUrl:
type: string
regionId:
type: string
images:
type: array
items:
type: object
details:
type: string
detailsweb:
type: string
shareURL:
type: string
topline:
type: string
firstSentence:
type: string
geotags:
type: string
brandingImage:
type: object
type:
type: string
example: story
breakingNews:
type: boolean
newStoriesCountLink:
type: string
type:
type: string
example: news