-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtvdb-openapi.yml
More file actions
9237 lines (9206 loc) · 301 KB
/
Copy pathtvdb-openapi.yml
File metadata and controls
9237 lines (9206 loc) · 301 KB
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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
description: |
Documentation of [TheTVDB](https://thetvdb.com/) API V4. All related information is linked from our [Github repo](https://github.com/thetvdb/v4-api). You might also want to use our [Postman collection] (https://www.getpostman.com/collections/7a9397ce69ff246f74d0)
## Authentication
1. Use the /login endpoint and provide your API key as "apikey". If you have a user-supported key, also provide your subscriber PIN as "pin". Otherwise completely remove "pin" from your call.
2. Executing this call will provide you with a bearer token, which is valid for 1 month.
3. Provide your bearer token for subsequent API calls by clicking Authorize below or including in the header of all direct API calls: `Authorization: Bearer [your-token]`
## Notes
1. "score" is a field across almost all entities. We generate scores for different types of entities in various ways, so no assumptions should be made about the meaning of this value. It is simply used to hint at relative popularity for sorting purposes.
title: TVDB API V4
version: 4.7.10
x-last-validated: '2026-05-30'
x-spec-source: https://github.com/thetvdb/v4-api/blob/main/docs/swagger.yml
servers:
- url: 'https://api4.thetvdb.com/v4'
description: TheTVDB v4 API production
security:
- bearerAuth: []
paths:
/login:
post:
summary: TheTVDB Create an Auth Token. the Token Has One Month Validation Length.
operationId: login
tags:
- Login
requestBody:
content:
application/json:
schema:
type: object
required:
- apikey
properties:
apikey:
type: string
pin:
type: string
examples:
LoginRequestExample:
summary: Default login request
x-microcks-default: true
value:
apikey: YOUR_API_KEY
pin: A1B2C3D4
required: true
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
properties:
token:
type: string
type: object
status:
type: string
type: object
examples:
Login200Example:
summary: Default login 200 response
x-microcks-default: true
value:
data:
token: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.payload.signature
status: Continuing
'401':
description: invalid credentials
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/artwork/{id}':
get:
description: Returns a single artwork base record.
operationId: getArtworkBase
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/ArtworkBaseRecord'
status:
type: string
type: object
examples:
GetArtworkBase200Example:
summary: Default getArtworkBase 200 response
x-microcks-default: true
value:
data:
height: 12345
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
includesText: true
language: eng
score: 100
thumbnail: example
type: 12345
width: 12345
status: Continuing
'400':
description: Invalid artwork id
'401':
description: Unauthorized
'404':
description: Artwork not found
tags:
- Artwork
summary: TheTVDB Get Artwork Base
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/artwork/{id}/extended':
get:
description: Returns a single artwork extended record.
operationId: getArtworkExtended
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/ArtworkExtendedRecord'
status:
type: string
type: object
examples:
GetArtworkExtended200Example:
summary: Default getArtworkExtended 200 response
x-microcks-default: true
value:
data:
episodeId: 12345
height: 12345
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
includesText: true
language: eng
movieId: 12345
networkId: 12345
peopleId: 12345
score: 100
seasonId: 12345
seriesId: 12345
seriesPeopleId: 12345
status:
id: 12345
name: Example Name
tagOptions:
- helpText: example
id: 12345
name: Example Name
tag: 12345
tagName: example
thumbnail: example
thumbnailHeight: 12345
thumbnailWidth: 12345
type: 12345
updatedAt: '2024-01-15'
width: 12345
status: Continuing
'400':
description: Invalid artwork id
'401':
description: Unauthorized
'404':
description: Artwork not found
tags:
- Artwork
summary: TheTVDB Get Artwork Extended
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/artwork/statuses':
get:
description: Returns list of artwork status records.
operationId: getAllArtworkStatuses
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/ArtworkStatus'
type: array
status:
type: string
type: object
examples:
GetAllArtworkStatuses200Example:
summary: Default getAllArtworkStatuses 200 response
x-microcks-default: true
value:
data:
- id: 12345
name: Example Name
status: Continuing
'401':
description: Unauthorized
tags:
- Artwork Statuses
summary: TheTVDB Get All Artwork Statuses
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/artwork/types':
get:
description: Returns a list of artworkType records
operationId: getAllArtworkTypes
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/ArtworkType'
type: array
status:
type: string
type: object
examples:
GetAllArtworkTypes200Example:
summary: Default getAllArtworkTypes 200 response
x-microcks-default: true
value:
data:
- height: 12345
id: 12345
imageFormat: example
name: Example Name
recordType: example
slug: example-slug
thumbHeight: 12345
thumbWidth: 12345
width: 12345
status: Continuing
'401':
description: Unauthorized
tags:
- Artwork Types
summary: TheTVDB Get All Artwork Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/awards:
get:
description: Returns a list of award base records
operationId: getAllAwards
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/AwardBaseRecord'
type: array
status:
type: string
type: object
examples:
GetAllAwards200Example:
summary: Default getAllAwards 200 response
x-microcks-default: true
value:
data:
- id: 12345
name: Example Name
status: Continuing
'401':
description: Unauthorized
tags:
- Awards
summary: TheTVDB Get All Awards
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/awards/{id}':
get:
description: Returns a single award base record
operationId: getAward
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/AwardBaseRecord'
status:
type: string
type: object
examples:
GetAward200Example:
summary: Default getAward 200 response
x-microcks-default: true
value:
data:
id: 12345
name: Example Name
status: Continuing
'400':
description: Invalid awards id
'401':
description: Unauthorized
'404':
description: Awards not found
tags:
- Awards
summary: TheTVDB Get Award
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/awards/{id}/extended':
get:
description: Returns a single award extended record
operationId: getAwardExtended
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/AwardExtendedRecord'
status:
type: string
type: object
examples:
GetAwardExtended200Example:
summary: Default getAwardExtended 200 response
x-microcks-default: true
value:
data:
categories:
- allowCoNominees: true
award:
id: 12345
name: Example Name
forMovies: true
forSeries: true
id: 12345
name: Example Name
id: 12345
name: Example Name
score: 100
status: Continuing
'400':
description: Invalid awards id
'401':
description: Unauthorized
'404':
description: Awards not found
tags:
- Awards
summary: TheTVDB Get Award Extended
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/awards/categories/{id}':
get:
description: Returns a single award category base record
operationId: getAwardCategory
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/AwardCategoryBaseRecord'
status:
type: string
type: object
examples:
GetAwardCategory200Example:
summary: Default getAwardCategory 200 response
x-microcks-default: true
value:
data:
allowCoNominees: true
award:
id: 12345
name: Example Name
forMovies: true
forSeries: true
id: 12345
name: Example Name
status: Continuing
'400':
description: Invalid category id
'401':
description: Unauthorized
'404':
description: Category not found
tags:
- Award Categories
summary: TheTVDB Get Award Category
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/awards/categories/{id}/extended':
get:
description: Returns a single award category extended record
operationId: getAwardCategoryExtended
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/AwardCategoryExtendedRecord'
status:
type: string
type: object
examples:
GetAwardCategoryExtended200Example:
summary: Default getAwardCategoryExtended 200 response
x-microcks-default: true
value:
data:
allowCoNominees: true
award:
id: 12345
name: Example Name
forMovies: true
forSeries: true
id: 12345
name: Example Name
nominees:
- character:
aliases:
- language:
name:
episode:
image:
name:
year:
episodeId: 12345
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
isFeatured: true
movieId: 12345
movie:
image:
name:
year:
name: Example Name
nameTranslations: &id001
- example
overviewTranslations: &id002
- example
peopleId: 12345
personImgURL: https://artworks.thetvdb.com/banners/example.jpg
peopleType: example
seriesId: 12345
series:
image:
name:
year:
sort: 12345
tagOptions:
- helpText:
id:
name:
tag:
tagName:
type: 12345
url: https://artworks.thetvdb.com/banners/example.jpg
personName: example
details: example
episode:
absoluteNumber: 1
aired: example
airsAfterSeason: 1
airsBeforeEpisode: 1
airsBeforeSeason: 1
finaleType: example
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
imageType: 1
isMovie: 12345
lastUpdated: '2024-01-15'
linkedMovie: 1
name: Example Name
nameTranslations: &id005
- example
number: 1
overview: A descriptive paragraph of text.
overviewTranslations: &id006
- example
runtime: 1
seasonNumber: 1
seasons:
- id:
image:
imageType:
lastUpdated:
name:
nameTranslations:
number:
overviewTranslations:
companies: {}
seriesId:
type: {}
year:
seriesId: 12345
seasonName: example
year: '2024'
id: 12345
isWinner: true
movie:
aliases:
- language:
name:
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
lastUpdated: '2024-01-15'
name: Example Name
nameTranslations: &id009
- example
overviewTranslations: &id010
- example
score: 100
slug: example-slug
status:
id:
keepUpdated:
name:
recordType:
runtime: 1
year: '2024'
series:
aliases:
- language:
name:
averageRuntime: 1
country: usa
defaultSeasonType: 12345
episodes:
- absoluteNumber:
aired:
airsAfterSeason:
airsBeforeEpisode:
airsBeforeSeason:
finaleType:
id:
image:
imageType:
isMovie:
lastUpdated:
linkedMovie:
name:
nameTranslations:
number:
overview:
overviewTranslations:
runtime:
seasonNumber:
seasons:
- {}
seriesId:
seasonName:
year:
firstAired: example
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
isOrderRandomized: true
lastAired: example
lastUpdated: '2024-01-15'
name: Example Name
nameTranslations: &id011
- example
nextAired: example
originalCountry: example
originalLanguage: example
overviewTranslations: &id012
- example
score: 100
slug: example-slug
status:
id:
keepUpdated:
name:
recordType:
year: '2024'
year: '2024'
category: example
name: Example Name
status: Continuing
'400':
description: Invalid category id
'401':
description: Unauthorized
'404':
description: Category not found
tags:
- Award Categories
summary: TheTVDB Get Award Category Extended
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/characters/{id}':
get:
description: Returns character base record
operationId: getCharacterBase
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/Character'
status:
type: string
type: object
examples:
GetCharacterBase200Example:
summary: Default getCharacterBase 200 response
x-microcks-default: true
value:
data:
aliases:
- language: eng
name: Example Name
episode:
image: https://artworks.thetvdb.com/banners/example.jpg
name: Example Name
year: '2024'
episodeId: 12345
id: 12345
image: https://artworks.thetvdb.com/banners/example.jpg
isFeatured: true
movieId: 12345
movie:
image: https://artworks.thetvdb.com/banners/example.jpg
name: Example Name
year: '2024'
name: Example Name
nameTranslations: *id001
overviewTranslations: *id002
peopleId: 12345
personImgURL: https://artworks.thetvdb.com/banners/example.jpg
peopleType: example
seriesId: 12345
series:
image: https://artworks.thetvdb.com/banners/example.jpg
name: Example Name
year: '2024'
sort: 12345
tagOptions:
- helpText: example
id: 12345
name: Example Name
tag: 12345
tagName: example
type: 12345
url: https://artworks.thetvdb.com/banners/example.jpg
personName: example
status: Continuing
'400':
description: Invalid character id
'401':
description: Unauthorized
'404':
description: Character not found
tags:
- Characters
summary: TheTVDB Get Character Base
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/companies:
get:
description: returns a paginated list of company records
operationId: getAllCompanies
parameters:
- description: name
in: query
name: page
schema:
type: number
example: 1.0
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/Company'
type: array
status:
type: string
links:
$ref: '#/components/schemas/Links'
type: object
examples:
GetAllCompanies200Example:
summary: Default getAllCompanies 200 response
x-microcks-default: true
value:
data:
- activeDate: '2024-01-15'
aliases:
- language: eng
name: Example Name
country: usa
id: 12345
inactiveDate: '2024-01-15'
name: Example Name
nameTranslations: &id003
- example
overviewTranslations: &id004
- example
primaryCompanyType: 12345
slug: example-slug
parentCompany:
id: 12345
name: Example Name
relation:
id: 12345
typeName: example
tagOptions:
- helpText: example
id: 12345
name: Example Name
tag: 12345
tagName: example
status: Continuing
links:
prev: example
self: example
next: example
total_items: 1
page_size: 1
'401':
description: Unauthorized
tags:
- Companies
summary: TheTVDB Get All Companies
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/companies/types':
get:
description: returns all company type records
operationId: getCompanyTypes
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyType'
status:
type: string
type: object
examples:
GetCompanyTypes200Example:
summary: Default getCompanyTypes 200 response
x-microcks-default: true
value:
data:
- companyTypeId: 12345
companyTypeName: example
status: Continuing
'401':
description: Unauthorized
tags:
- Companies
summary: TheTVDB Get Company Types
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
'/companies/{id}':
get:
description: returns a company record
operationId: getCompany
parameters:
- description: id
in: path
name: id
required: true
schema:
type: number
example: 12345
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
$ref: '#/components/schemas/Company'
status:
type: string
type: object
examples:
GetCompany200Example:
summary: Default getCompany 200 response
x-microcks-default: true
value:
data:
activeDate: '2024-01-15'
aliases:
- language: eng
name: Example Name
country: usa
id: 12345
inactiveDate: '2024-01-15'
name: Example Name
nameTranslations: *id003
overviewTranslations: *id004
primaryCompanyType: 12345
slug: example-slug
parentCompany:
id: 12345
name: Example Name
relation:
id: 12345
typeName: example
tagOptions:
- helpText: example
id: 12345
name: Example Name
tag: 12345
tagName: example
status: Continuing
'400':
description: Invalid company id
'401':
description: Unauthorized
'404':
description: Company not found
tags:
- Companies
summary: TheTVDB Get Company
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/content/ratings:
get:
description: returns list content rating records
operationId: getAllContentRatings
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/ContentRating'
type: array
status:
type: string
type: object
examples:
GetAllContentRatings200Example:
summary: Default getAllContentRatings 200 response
x-microcks-default: true
value:
data:
- id: 12345
name: Example Name
description: A descriptive paragraph of text.
country: usa
contentType: example
order: 1
fullName: example
status: Continuing
'401':
description: Unauthorized
tags:
- Content Ratings
summary: TheTVDB Get All Content Ratings
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/countries:
get:
description: returns list of country records
operationId: getAllCountries
responses:
'200':
description: response
content:
application/json:
schema:
properties:
data:
items:
$ref: '#/components/schemas/Country'
type: array
status:
type: string
type: object
examples:
GetAllCountries200Example:
summary: Default getAllCountries 200 response
x-microcks-default: true
value: