-
Notifications
You must be signed in to change notification settings - Fork 5
/
ListenNotesTestServer.yml
1190 lines (1190 loc) · 44.8 KB
/
ListenNotesTestServer.yml
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.1
servers:
- description: Test Server
url: https://listen-api-test.listennotes.com/api/v2
info:
contact:
email: [email protected]
name: Listen Notes
url: https://www.listennotes.com/api/
x-twitter: listennotes
description: Search all podcasts and episodes by people, places, or topics.
termsOfService: https://www.listennotes.com/api/terms/
title: "Listen API: Podcast Search & Directory API"
version: "2.0"
x-apisguru-categories:
- entertainment
x-logo:
url: https://twitter.com/listennotes/profile_image?size=original
x-origin:
- converter:
url: https://github.com/mermade/oas-kit
version: 7.0.4
format: openapi
url: https://listen-api.listennotes.com/api/v2/openapi.yaml
version: "3.0"
x-providerName: listennotes.com
tags:
- description: Endpoints to search podcasts
name: Search API
- description: Endpoints to fetch podcasts data
name: Directory API
paths:
/best_podcasts:
get:
description: |
Get a list of curated best podcasts by genre,
You can get the genre ids from `GET /genres` endpoint.
operationId: getBestPodcasts
parameters:
- description: If not specified, it'll be the overall best podcasts, which can be considered as a special genre.
explode: true
in: query
name: genre_id
required: false
schema:
example: "93"
type: string
style: form
- description: Page number of those podcasts in this genre.
explode: true
in: query
name: page
required: false
schema:
example: 2
type: integer
style: form
- description: If not specified, you'll get "best podcasts" in United States.
explode: true
in: query
name: region
required: false
schema:
default: us
example: us
type: string
style: form
- description: If not specified, you'll get "best podcasts" produced in any country/region.
explode: true
in: query
name: publisher_region
required: false
schema:
type: string
style: form
- description: If not specified, you'll get "best podcasts" in any language.
explode: true
in: query
name: language
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/BestPodcastsResponse"
description: OK
headers:
X-ListenAPI-FreeQuota:
$ref: "#/components/headers/X-ListenAPI-FreeQuota"
X-ListenAPI-NextBillingDate:
$ref: "#/components/headers/X-ListenAPI-NextBillingDate"
X-ListenAPI-Usage:
$ref: "#/components/headers/X-ListenAPI-Usage"
X-listenAPI-Latency-Seconds:
$ref: "#/components/headers/X-listenAPI-Latency-Seconds"
links:
paginate:
description: Pagination through podcasts.
operationId: getBestPodcasts
parameters:
page: $response.body#/next_page_number
"404":
description: Endpoint not exist, or podcast / episode not exist.
5XX:
description: Something wrong on our end (Unexpected server errors).
summary: Fetch a list of best podcasts by genre
tags:
- Directory API
/genres:
get:
description: |
Get a list of podcast genres that are supported in Listen Notes.
operationId: getGenres
parameters:
- description: |
Just show top level genres?
explode: true
in: query
name: top_level_only
required: false
schema:
default: 0
enum:
- 0
- 1
example: 1
type: integer
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GetGenresResponse"
description: OK
headers:
X-ListenAPI-FreeQuota:
$ref: "#/components/headers/X-ListenAPI-FreeQuota"
X-ListenAPI-NextBillingDate:
$ref: "#/components/headers/X-ListenAPI-NextBillingDate"
X-ListenAPI-Usage:
$ref: "#/components/headers/X-ListenAPI-Usage"
X-listenAPI-Latency-Seconds:
$ref: "#/components/headers/X-listenAPI-Latency-Seconds"
5XX:
description: Something wrong on our end (Unexpected server errors).
summary: Fetch a list of podcast genres
tags:
- Directory API
/just_listen:
get:
description: Returns a random podcast episode. Recently published episodes are more likely to be fetched.
operationId: justListen
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/EpisodeSimple"
description: OK
headers:
X-ListenAPI-FreeQuota:
$ref: "#/components/headers/X-ListenAPI-FreeQuota"
X-ListenAPI-NextBillingDate:
$ref: "#/components/headers/X-ListenAPI-NextBillingDate"
X-ListenAPI-Usage:
$ref: "#/components/headers/X-ListenAPI-Usage"
X-listenAPI-Latency-Seconds:
$ref: "#/components/headers/X-listenAPI-Latency-Seconds"
5XX:
description: Something wrong on our end (Unexpected server errors).
summary: Fetch a random podcast episode
tags:
- Directory API
/languages:
get:
description: |
Get a list of languages that are supported in Listen Notes database.
operationId: getLanguages
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GetLanguagesResponse"
description: OK
headers:
X-ListenAPI-FreeQuota:
$ref: "#/components/headers/X-ListenAPI-FreeQuota"
X-ListenAPI-NextBillingDate:
$ref: "#/components/headers/X-ListenAPI-NextBillingDate"
X-ListenAPI-Usage:
$ref: "#/components/headers/X-ListenAPI-Usage"
X-listenAPI-Latency-Seconds:
$ref: "#/components/headers/X-listenAPI-Latency-Seconds"
5XX:
description: Something wrong on our end (Unexpected server errors).
summary: Fetch a list of supported languages for podcasts
tags:
- Directory API
/regions:
get:
description: |
Returns a dictionary of country codes (e.g., us, gb...) & country names (United States, United Kingdom...).
operationId: getRegions
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GetRegionsResponse"
description: OK
headers:
X-ListenAPI-FreeQuota:
$ref: "#/components/headers/X-ListenAPI-FreeQuota"
X-ListenAPI-NextBillingDate:
$ref: "#/components/headers/X-ListenAPI-NextBillingDate"
X-ListenAPI-Usage:
$ref: "#/components/headers/X-ListenAPI-Usage"
X-listenAPI-Latency-Seconds:
$ref: "#/components/headers/X-listenAPI-Latency-Seconds"
5XX:
description: Something wrong on our end (Unexpected server errors).
summary: Fetch a list of supported countries/regions for best podcasts
tags:
- Directory API
/search:
get:
description: |
Full-text search on episodes, podcasts, or curated lists of podcasts.
operationId: search
parameters:
- description: Search term, e.g., person, place, topic... You can use double quotes to do verbatim match, e.g., "game of thrones". Otherwise, it's fuzzy search.
explode: true
in: query
name: q
required: true
schema:
example: star wars
type: string
style: form
- description: Sort by date or not? If 0, then sort by relevance. If 1, then sort by date.
explode: true
in: query
name: sort_by_date
required: false
schema:
default: 0
enum:
- 0
- 1
example: 0
type: integer
style: form
- description: What type of contents do you want to search for?
explode: true
in: query
name: type
required: false
schema:
default: episode
enum:
- episode
- podcast
- curated
example: episode
type: string
style: form
- description: Offset for search results, for pagination. You'll use **next_offset** from response for this parameter.
explode: true
in: query
name: offset
required: false
schema:
default: 0
example: 0
type: integer
style: form
- description: A comma-delimited string of a list of genre ids. If not specified, then all genres are included. It works only when **type** is *episode* or *podcast*.
explode: true
in: query
name: genre_ids
required: false
schema:
example: 68,82
type: string
style: form
- description: A comma-delimited string. Possible values title, description, author, and audio. If not specified, then search every fields.
explode: true
in: query
name: only_in
required: false
schema:
default: title,description,author,audio
example: title,description
type: string
style: form
- description: |
Limit search results to a specific language. If not specified, it'll be any language. It works only when **type** is *episode* or *podcast*.
explode: true
in: query
name: language
required: false
schema:
example: English
type: string
style: form
- description: |
Limit search results to a specific region (e.g., us, gb, in...). If not specified, it'll be any region. It works only when **type** is *episode* or *podcast*.
explode: true
in: query
name: region
required: false
schema:
example: ""
type: string
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/SearchResponse"
description: OK
headers:
X-ListenAPI-FreeQuota:
$ref: "#/components/headers/X-ListenAPI-FreeQuota"
X-ListenAPI-NextBillingDate:
$ref: "#/components/headers/X-ListenAPI-NextBillingDate"
X-ListenAPI-Usage:
$ref: "#/components/headers/X-ListenAPI-Usage"
X-listenAPI-Latency-Seconds:
$ref: "#/components/headers/X-listenAPI-Latency-Seconds"
links:
paginate:
description: Pagination through search results.
operationId: search
parameters:
offset: $response.body#/next_offset
"400":
description: Something wrong on your end (Client side errors), e.g., missing required parameters.
5XX:
description: Something wrong on our end (Unexpected server errors).
summary: Full-text search
tags:
- Search API
components:
headers:
X-ListenAPI-FreeQuota:
description: Free quotas of API requests included in your api plan.
explode: false
schema:
example: 25000
type: integer
style: simple
X-ListenAPI-NextBillingDate:
description: The timestamp for the start of next billing cycle. In ISO 8601 format.
explode: false
schema:
example: 2020-04-26T17:27:33.110641Z
format: date-time
type: string
style: simple
X-ListenAPI-Usage:
description: The number of API requests that you've used in current billing cycle.
explode: false
schema:
example: 19231
type: integer
style: simple
X-listenAPI-Latency-Seconds:
description: Latency for this api call, in seconds.
explode: false
schema:
example: 0.056
type: number
style: simple
parameters:
apiKeyParam:
description: Get API Key on listennotes.com/api
explode: false
in: header
name: X-ListenAPI-Key
required: true
schema:
type: string
style: simple
genreIdParam:
description: You can get the id from `GET /genres`. If not specified, it'll be the overall best podcasts, which can be considered as a special genre.
explode: true
in: query
name: genre_id
required: false
schema:
example: "93"
type: string
style: form
queryParam:
description: |
Search term, e.g., person, place, topic... You can use double quotes to do verbatim match, e.g., "game of thrones". Otherwise, it's fuzzy search.
explode: true
in: query
name: q
required: true
schema:
example: star wars
type: string
style: form
safeModeParam:
description: Whether or not to exclude podcasts with explicit language. 1 is yes, and 0 is no.
explode: true
in: query
name: safe_mode
required: false
schema:
default: 0
enum:
- 0
- 1
example: 0
type: integer
style: form
responses:
BadRequest:
description: Something wrong on your end (Client side errors), e.g., missing required parameters.
NotFound:
description: Endpoint not exist, or podcast / episode not exist.
ServerError:
description: Something wrong on our end (Unexpected server errors).
TooManyRequests:
description: You are using FREE plan and you exceed the quota limit.
Unauthorized:
description: Wrong api key or your account is suspended.
schemas:
AudioField:
description: Audio url of this episode, which can be played directly.
example: https://www.listennotes.com/e/p/11b34041e804491b9704d11f283c74de/
type: string
AudioLengthSecField:
description: Audio length of this episode. In seconds.
example: 567
type: integer
BestPodcastsLNUrlField:
description: Url of the list of best podcasts on [ListenNotes.com](https://www.ListenNotes.com).
example: https://www.listennotes.com/best-business-news-podcasts-95/
type: string
BestPodcastsResponse:
properties:
has_next:
example: true
type: boolean
has_previous:
type: boolean
id:
description: The id of this genre
example: 95
type: integer
listennotes_url:
$ref: "#/components/schemas/BestPodcastsLNUrlField"
name:
description: This genre's name.
example: Business News
type: string
next_page_number:
example: 3
type: integer
page_number:
example: 2
type: integer
parent_id:
description: The id of parent genre.
example: 93
type: integer
podcasts:
items:
$ref: "#/components/schemas/PodcastSimple"
type: array
previous_page_number:
example: 1
type: integer
total:
example: 325
type: integer
required:
- has_next
- has_previous
- id
- listennotes_url
- name
- next_page_number
- page_number
- parent_id
- podcasts
- previous_page_number
- total
type: object
CountryField:
description: The country where this podcast is produced.
example: United States
type: string
CuratedIdField:
description: Curated list id.
example: Vb017Sx3l8F
type: string
CuratedLNUrlField:
description: The url of this curated list on [ListenNotes.com](https://www.ListenNotes.com).
example: https://www.listennotes.com/curated-podcasts/7-bookish-podcasts-for-avid-readers-on-H2r-TCWai8K/
type: string
CuratedListSearchResult:
description: When **type** is *curated*.
properties:
description_highlighted:
description: Highlighted segment of this curated list's description
example: ...<span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> fans in Reddit shared their favorite podcasts.
type: string
description_original:
description: Plain text of this curated list's description
example: Star Wars fans in Reddit shared their favorite podcasts.
type: string
id:
$ref: "#/components/schemas/CuratedIdField"
listennotes_url:
$ref: "#/components/schemas/CuratedLNUrlField"
podcasts:
description: Up to 5 podcasts in this curated list.
items:
$ref: "#/components/schemas/PodcastMinimum"
type: array
pub_date_ms:
$ref: "#/components/schemas/CuratedPubDateMsField"
source_domain:
$ref: "#/components/schemas/CuratedSourceDomainField"
source_url:
$ref: "#/components/schemas/CuratedSourceUrlField"
title_highlighted:
description: Highlighted segment of this curated list's title
example: |
What are some good <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> Podcast to listen to?
type: string
title_original:
description: Plain text of this curated list's title
example: What are some good Star Wars Podcast to listen to?
type: string
total:
$ref: "#/components/schemas/CuratedTotalPodcastsField"
type: object
CuratedPubDateMsField:
description: Published date of this curated list. In milliseconds.
example: 1556843484301
type: integer
CuratedSourceDomainField:
description: The domain name of the source of this curated list.
example: parade.com
type: string
CuratedSourceUrlField:
description: Url of the source of this curated list.
example: https://parade.com/718913/ashley_johnson/7-bookish-podcasts-for-avid-readers-on-the-go/
type: string
CuratedTotalPodcastsField:
description: The total number of podcasts in this curated list.
example: 25
type: integer
EarliestPubDateMsField:
description: The published date of the oldest episode of this podcast. In milliseconds
example: 1470667902000
type: integer
EmailField:
description: The email of this podcast's producer. This field is available only in the PRO/ENTERPRISE plan.
example: [email protected]
type: string
EpisodeDescriptionField:
description: Html of this episode's full description
example: |
<p>Disney chief Bob Iger shared news about Star Wars movies in 2020 and beyond, but some media outlets gave conflicting reports about it. Here's the real scoop. Punch it!</p> <p>***We’re listener supported! Go to http://Patreon.com/sw7x7 to donate to the Star Wars 7x7 podcast, and you’ll get some fabulous rewards for your pledge.*** </p> <p>Check out SW7x7.com for full Star Wars 7x7 show notes and links, and to comment on any of the content of this episode! If you like what you've heard, please leave us a rating or review on iTunes or Stitcher, which will also help more people discover this Star Wars podcast.</p> <p>Don't forget to join the Star Wars 7x7 fun on Facebook at Facebook.com/SW7x7, and follow the breaking news Twitter feed at Twitter.com/SW7x7Podcast. We're also on Pinterest and Instagram as "SW7x7" too, and we'd love to connect with you there!</p>
type: string
EpisodeIdField:
description: Episode id.
example: 4d82e50314174754a3b603912448e812
type: string
EpisodeImageField:
description: |
Image url for this episode.
If an episode doesn't have its own image, then this field would be the url of the podcast artwork image.
If you are using PRO/ENTERPRISE plan, then it's
a high resolution image (1400x1400). If you are using FREE plan, then it's the same as **thumbnail**,
low resolution image (300x300).
example: https://cdn-images-1.listennotes.com/podcasts/exponent-ben-thompson-james-allworth-OaJSjb4xQv3.1400x1400.jpg
type: string
EpisodeLNEditUrlField:
description: Edit url of this episode where you can update the audio url if you find the audio is broken.
example: https://www.listennotes.com/e/11b34041e804491b9704d11f283c74de/#edit
type: string
EpisodeLNUrlField:
description: The url of this episode on [ListenNotes.com](https://www.ListenNotes.com).
example: https://www.listennotes.com/e/4d82e50314174754a3b603912448e812/
type: string
EpisodeNameField:
description: Episode name.
example: "Celebration Recap, Jason Fry and Christian Blauvelt Interviews – SWBW #101"
type: string
EpisodePubDateMsField:
description: Published date for this episode. In millisecond.
example: 1474873200000
type: integer
EpisodeSearchResult:
description: When **type** is *episode*.
properties:
audio:
$ref: "#/components/schemas/AudioField"
audio_length_sec:
$ref: "#/components/schemas/AudioLengthSecField"
description_highlighted:
description: Highlighted segment of this episode's description
example: |
...Go to http://Patreon.com/sw7x7 to donate to the <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> 7x7 podcast, and you'll get some fabulous rewards for your pledge.*** Check out SW7x7.com for full <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> 7x7 show notes and links, and to
type: string
description_original:
description: Plain text of this episode's description
example: |
Yeah, Star Wars Celebration Orlando is 32 days away, but what's the scoop on Celebration 2018? Plus, Rebels Day is Saturday, and much more in our update. Punch it! ***We're listener supported! Go to http://Patreon.com/sw7x7 to donate to the Star Wars 7x7 podcast, and you’ll get some fabulous rewards for your pledge.*** Check out SW7x7.com for full Star Wars 7x7 show notes and links, and to comment on any of the content of this episode! If you like what you've heard, please leave us a rating or review on iTunes or Stitcher, which will also help more people discover this Star Wars podcast. Don't forget to join the Star Wars 7x7 fun on Facebook at Facebook.com/SW7x7, and follow the breaking news Twitter feed at Twitter.com/SW7x7Podcast. We're also on Pinterest and Instagram as "SW7x7" too, and we'd love to connect with you there!
type: string
explicit_content:
$ref: "#/components/schemas/ExplicitField"
id:
$ref: "#/components/schemas/EpisodeIdField"
image:
$ref: "#/components/schemas/EpisodeImageField"
itunes_id:
$ref: "#/components/schemas/iTunesIdField"
link:
$ref: "#/components/schemas/LinkField"
listennotes_url:
$ref: "#/components/schemas/EpisodeLNUrlField"
podcast:
$ref: "#/components/schemas/EpisodeSearchResult_podcast"
pub_date_ms:
$ref: "#/components/schemas/EpisodePubDateMsField"
rss:
$ref: "#/components/schemas/RssField"
thumbnail:
$ref: "#/components/schemas/EpisodeThumbnailField"
title_highlighted:
description: Highlighted segment of this episode's title
example: '815: <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> 2020 Movie and Beyond!'
type: string
title_original:
description: Plain text of this episode' title
example: "815: Star Wars 2020 Movie and Beyond!"
type: string
transcripts_highlighted:
description: Up to 2 highlighted segments of the audio transcript of this episode.
items:
example: |
00:21:27 when Disney bought the <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> franchise from George Lucas they had a plan lots of <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> movies new <span class="ln-search-highlight">Star</span> <span class="ln-search-highlight">Wars</span> movies every month another one was just released while I was talking
type: string
type: array
type: object
EpisodeSearchResult_podcast:
description: The podcast that this episode belongs to.
properties:
genre_ids:
$ref: "#/components/schemas/GenreIdsField"
id:
$ref: "#/components/schemas/PodcastIdField"
image:
$ref: "#/components/schemas/ImageField"
listen_score:
$ref: "#/components/schemas/ListenScoreField"
listen_score_global_rank:
$ref: "#/components/schemas/ListenScoreGlobalRankField"
listennotes_url:
$ref: "#/components/schemas/PodcastLNUrlField"
publisher_highlighted:
$ref: "#/components/schemas/PublisherHighlightedField"
publisher_original:
$ref: "#/components/schemas/PublisherOriginalField"
thumbnail:
$ref: "#/components/schemas/ThumbnailField"
title_highlighted:
$ref: "#/components/schemas/PodcastTitleHighlightedField"
title_original:
$ref: "#/components/schemas/PodcastTitleOriginalField"
type: object
EpisodeSimple:
properties:
audio:
$ref: "#/components/schemas/AudioField"
audio_length_sec:
$ref: "#/components/schemas/AudioLengthSecField"
description:
$ref: "#/components/schemas/EpisodeDescriptionField"
explicit_content:
$ref: "#/components/schemas/ExplicitField"
id:
$ref: "#/components/schemas/EpisodeIdField"
image:
$ref: "#/components/schemas/EpisodeImageField"
link:
$ref: "#/components/schemas/LinkField"
listennotes_edit_url:
$ref: "#/components/schemas/EpisodeLNEditUrlField"
listennotes_url:
$ref: "#/components/schemas/EpisodeLNUrlField"
maybe_audio_invalid:
$ref: "#/components/schemas/MaybeAudioInvalidField"
podcast:
$ref: "#/components/schemas/PodcastMinimum"
pub_date_ms:
$ref: "#/components/schemas/EpisodePubDateMsField"
thumbnail:
$ref: "#/components/schemas/EpisodeThumbnailField"
title:
$ref: "#/components/schemas/EpisodeNameField"
type: object
EpisodeThumbnailField:
description: |
Thumbnail image (300x300) url for this episode.
If an episode doesn't have its own image, then this field would be the url of the podcast artwork thumbnail image.
example: https://cdn-images-1.listennotes.com/podcasts/exponent-ben-thompson-james-allworth-OaJSjb4xQv3.300x300.jpg
type: string
ExplicitField:
description: Whether this podcast contains explicit language.
example: false
type: boolean
Genre:
example:
id: 140
name: Web Design
parent_id: 127
properties:
id:
description: Genre id
example: 93
type: integer
name:
description: Genre name.
example: Business
type: string
parent_id:
description: Parent genre id.
example: 95
type: integer
type: object
GenreIdsField:
example:
- 138
- 86
- 160
- 68
- 82
- 100
- 101
items:
description: Genre ids.
type: integer
type: array
GetGenresResponse:
properties:
genres:
items:
$ref: "#/components/schemas/Genre"
type: array
required:
- genres
type: object
GetLanguagesResponse:
properties:
languages:
example:
- Any language
- Afar
- Abkhazian
- Afrikaans
- Akan
- Albanian
- Arabic
- Azerbaijani
- Bambara
- Bashkir
- Basque
- Belarusian
- Bulgarian
- Catalan
- Chamorro
- Chinese
- Croatian
- Czech
- Danish
- Dutch
- English
- Estonian
- Faeroese
- Finnish
- French
- Gaelic
- Galician
- German
- Greek
items:
type: string
type: array
required:
- languages
type: object
GetPodcastRecommendationsResponse:
properties:
recommendations:
items:
$ref: "#/components/schemas/PodcastSimple"
type: array
required:
- recommendations
type: object
GetPodcastsInBatchForm:
properties:
ids:
description: Comma-separated list of podcast ids.
example: 3302bc71139541baa46ecb27dbf6071a,68faf62be97149c280ebcc25178aa731,37589a3e121e40debe4cef3d9638932a,9cf19c590ff0484d97b18b329fed0c6a
type: string
itunes_ids:
description: Comma-separated itunes ids.
example: 1457514703,1386234384,659155419
type: string
next_episode_pub_date:
description: |
For latest episodes pagination. It's the value of **next_episode_pub_date** from the response of last request. If not specified, just return latest 10 episodes.
example: 1557394247000
type: integer
rsses:
description: Comma-separated rss urls.
example: https://rss.art19.com/recode-decode,https://rss.art19.com/the-daily,https://www.npr.org/rss/podcast.php?id=510331,https://www.npr.org/rss/podcast.php?id=510331
type: string
show_latest_episodes:
default: 0
description: |
Whether or not to fetch up to 10 latest episodes from these podcasts, sorted by pub_date. 1 is yes, and 0 is no.
enum:
- 0
- 1
example: 1
type: integer
type: object
GetPodcastsInBatchResponse:
properties:
latest_episodes:
description: |
Up to 10 latest episodes from these podcasts, sorted by **pub_date**. This field shows up only when **show_latest_episodes** is 1.
items:
$ref: "#/components/schemas/EpisodeSimple"
type: array
podcasts:
items:
$ref: "#/components/schemas/PodcastSimple"
type: array
required:
- podcasts
type: object
GetRegionsResponse:
properties:
regions:
example:
au: Australia
de: Germany
ua: Ukraine
us: United States
type: object
required:
- regions
type: object
ImageField:
description: |
Image url for this podcast's artwork. If you are using PRO/ENTERPRISE plan, then it's
a high resolution image (1400x1400). If you are using FREE plan, then it's the same as **thumbnail**,
low resolution image (300x300).
example: https://cdn-images-1.listennotes.com/podcasts/exponent-ben-thompson-james-allworth-OaJSjb4xQv3.1400x1400.jpg
type: string
IsClaimedField:
description: Whether this podcast is claimed by its producer on [ListenNotes.com](https://www.ListenNotes.com).
example: true
type: boolean
LanguageField:
description: The language of this podcast. You can get all supported languages from `GET /languages`.
example: English
type: string
LatestPubDateMsField:
description: The published date of the latest episode of this podcast. In milliseconds
example: 1557499770000
type: integer
LinkField:
description: Web link of this episode.
example: https://www.npr.org/2020/01/22/798532179/soleimanis-iran
type: string
ListenScoreField:
description: |
The estimated popularity score of a podcast compared to all other rss-based public podcasts in the world on a scale from 0 to 100.
If the score is not available, it'll be null. Learn more at listennotes.com/listen-score
example: 81
type: integer
ListenScoreGlobalRankField:
description: |
The estimated popularity ranking of a podcast compared to all other rss-based public podcasts in the world.
For example, if the value is 0.5%, then this podcast is one of the top 0.5% most popular shows out of all podcasts globally, ranked by Listen Score.
If the ranking is not available, it'll be null. Learn more at listennotes.com/listen-score
example: 0.5%
type: string
MaybeAudioInvalidField:
description: Whether or not this episode's audio is invalid. Podcasters may delete the original audio.
example: false
type: boolean
PodcastDescriptionField:
description: Html of this episode's full description
example: <p>The Star Wars 7x7 Podcast is Rebel-rousing fun for everyday Jedi, between 7 and 14 minutes a day, 7 days a week. Join host Allen Voivod for Star Wars news, history, interviews, trivia, and deep dives into the Star Wars story as told in movies, books, comics, games, cartoons, and more. Subscribe now for your daily dose of Star Wars joy. It's destiny unleashed!</p>
type: string
PodcastExtraField:
properties:
facebook_handle:
description: Facebook username affiliated with this podcast
example: sw7x7
type: string
google_url:
description: Google Podcasts url for this podcast
example: https://play.google.com/music/listen?u=0#/ps/I7gdcrqcmvhfnhh2cyqkcg32tkq
type: string
instagram_handle:
description: Instagram username affiliated with this podcast
example: sw7x7
type: string
linkedin_url:
description: LinkedIn url affiliated with this podcast
type: string
patreon_handle:
description: Patreon username affiliated with this podcast
example: sw7x7
type: string
spotify_url:
description: Spotify url for this podcast
example: https://open.spotify.com/show/2rQJUP9Y3HxemiW3JHt9WV
type: string
twitter_handle:
description: Twitter username affiliated with this podcast
example: SW7x7podcast
type: string
url1:
description: Url affiliated with this podcast
type: string
url2:
description: Url affiliated with this podcast
type: string
url3:
description: Url affiliated with this podcast
type: string
wechat_handle:
description: WeChat username affiliated with this podcast
type: string
youtube_url:
description: YouTube url affiliated with this podcast
example: https://www.youtube.com/sw7x7
type: string
type: object
PodcastIdField:
description: Podcast id.
example: 4d3fe717742d4963a85562e9f84d8c79
type: string
PodcastLNUrlField:
description: The url of this podcast on [ListenNotes.com](https://www.ListenNotes.com).
example: https://www.listennotes.com/c/4d3fe717742d4963a85562e9f84d8c79/
type: string
PodcastLookingForField:
properties:
cohosts:
description: Whether this podcast is looking for cohosts.
example: true
type: boolean
cross_promotion:
description: Whether this podcast is looking for cross promotion opportunities with other podcasts.
example: true
type: boolean
guests:
description: Whether this podcast is looking for guests.
example: true
type: boolean
sponsors:
description: Whether this podcast is looking for sponsors.
example: true
type: boolean
type: object
PodcastMinimum:
properties:
id:
$ref: "#/components/schemas/PodcastIdField"
image:
$ref: "#/components/schemas/ImageField"
listen_score:
$ref: "#/components/schemas/ListenScoreField"
listen_score_global_rank:
$ref: "#/components/schemas/ListenScoreGlobalRankField"