-
Notifications
You must be signed in to change notification settings - Fork 2
/
alldebrid.yaml
1934 lines (1927 loc) · 67.6 KB
/
alldebrid.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
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
# Open Alldebrid is an Alldebrid OpenAPI Golang wrapper.
# Copyright (C) 2022 Jacquier Pierre-Emmanuel
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
openapi: 3.0.0
info:
title: Alldebrid API
description: >-
Welcome to the OpenAPI Alldebrid API v4 !<br />
You can use this API to access various Alldebrid services from custom applications or scripts.<br />
<br />
API is organized around REST,<br />
returns JSON-encoded responses and use standard HTTP response codes.<br />
<br />
All calls are to be made on the HTTPS endpoints.<br />
Some are public, others require to be authentificated with an apikey (see Authentication).<br />
<br />
You must also identify your apps or script with a meaningfull agent parameter.<br />
<br />
This API version is namespaced as v4, as such all endpoint start with /v4/,<br />
such like http://api.alldebrid.com/v4/ping?agent=apiShowcase.<br />
<br />
This API v4 should be the final version regarding general response format and errors (hopefully).<br />
version: 4.0.0
servers:
- url: "https://api.alldebrid.com/v4"
description: "Optional server description, e.g. Main (production) server"
paths:
/hosts:
get:
summary: >-
Use this endpoint to retrieve informations about what hosts we support.
description: >-
Use this endpoint to retrieve informations about what hosts we support
and all related informations about it.
parameters:
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: hostOnly
schema:
type: string
required: false
description: Endpoint will only return "hosts" data
responses:
"200":
description: >-
Use this endpoint to retrieve informations about what hosts we
support and all related informations about it.
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
hosts:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: uptobox
type:
type: string
example: premium
domains:
type: array
items:
type: string
example: uptobox.com
regexp:
type: string
example: >-
(uptobox\.com/[0-9a-zA-Z]+(/.*)?)|uptostream\.com/([0-9a-zA-Z]{12})
regexps:
type: array
items:
type: string
example: 'uptostream\\.com/iframe/([0-9a-zA-Z]{12})'
status:
type: boolean
streams:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: youtube
type:
type: string
example: free
domains:
type: array
items:
type: string
example: youtube.be
regexp:
type: string
example: >-
https?:\/\/(?:www\\.)?youtube\\.com\/show\/(?P<id>[^?#]*)",
"https?:\/\/(?:www\\.)?youtube\\.com\/feed\/history|:ythistory
regexps:
type: array
items:
type: string
example: >-
https?:\/\/(?:www\\.)?youtube\\.com\/show\/(?P<id>[^?#]*)
status:
type: boolean
redirectors:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: dlprotecte
type:
type: string
example: premium
domains:
type: array
items:
type: string
example: dl-protecte.com
regexp:
type: string
example: >-
(dl-protecte\.com/[0-9a-zA-Z]+)|(protect-lien\.com/[0-9a-zA-Z]+)|dl-protecte\.org/([0-9a-zA-Z]+)
regexps:
type: array
items:
type: string
example: 'uptostream\\.com/iframe/([0-9a-zA-Z]{12})'
status:
type: boolean
error:
type: object
properties:
code:
type: string
example: AUTH_MISSING_APIKEY
message:
type: string
example: The auth apikey was not sent
/hosts/domains:
get:
summary: >-
Use this endpoint to only retrieve the list of supported hosts
domains and redirectors as an array.
description: >-
Use this endpoint to only retrieve the list of supported hosts domains and redirectors as an array.<br />
<br />
This will also include any alternative domain the hosts or redirectors have.<br />
Please use regexps availables in /hosts or /user/hosts endpoints to validate supported links.<br />
parameters:
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
responses:
"200":
description: >-
Use this endpoint to retrieve informations about what hosts we
support and all related informations about it.
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
hosts:
type: array
items:
type: string
example: uptobox.com
streams:
type: array
items:
type: string
example: youtube.com
redirectors:
type: array
items:
type: string
example: dl-protecte.com
error:
type: object
properties:
code:
type: string
example: AUTH_MISSING_APIKEY
message:
type: string
example: The auth apikey was not sent
/hosts/priority:
get:
summary: >-
Not all hosts are created equal, so some hosts are more limited than
other.
description: >-
Use this endpoint to retrieve an ordered list of main domain of hosts,
from more open to more restricted.
parameters:
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
responses:
"200":
description: >-
Use this endpoint to retrieve informations about what hosts we
support and all related informations about it.
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
hosts:
type: object
additionalProperties:
type: integer
format: int64
example: 4
error:
type: object
properties:
code:
type: string
example: AUTH_MISSING_APIKEY
message:
type: string
example: The auth apikey was not sent
/user:
get:
summary: Use this endpoint to get user informations.
description: >-
Use this endpoint to get user informations.
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
responses:
"200":
description: >-
Use this endpoint to retrieve informations about what hosts we
support and all related informations about it.
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
user:
type: object
properties:
username:
type: string
example: MyUsername
email:
type: string
example: [email protected]
isPremium:
type: boolean
isSubscribed:
type: boolean
isTrial:
type: boolean
premiumUntil:
type: integer
format: int64
example: 1545757200
lang:
type: string
example: fr
preferedDomain:
type: string
example: fr
fidelityPoints:
type: integer
format: int64
example: 200
limitedHostersQuotas:
type: object
additionalProperties:
type: integer
format: int64
example: 3000
notifications:
type: array
items:
type: string
example: FREEDAYS_USED_QUOTA
error:
type: object
properties:
code:
type: string
example: AUTH_MISSING_APIKEY
message:
type: string
example: The auth apikey was not sent
/user/hosts:
get:
summary: >-
This endpoint retrieves a complete list of all available hosts for this
user.
description: >-
This endpoint retrieves a complete list of all available hosts for this user.<br />
Depending of the account subscription status (free user, trial mode, premium user),<br />
the list and limitations will vary.<br />
<br />
The limits and quota are updated in real time. Use this page to have an<br />
up-to-date list of service the user can use on Alldebrid.<br />
<br />
Quotas will reset every day for premium users.<br />
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: hostOnly
schema:
type: string
required: false
description: Endpoint will only return "hosts" data
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
hosts:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: uptobox
type:
type: string
example: premium
domains:
type: array
items:
type: string
example: uptobox.com
regexp:
type: string
example: >-
(uptobox\.com/[0-9a-zA-Z]+(/.*)?)|uptostream\.com/([0-9a-zA-Z]{12})
regexps:
type: array
items:
type: string
example: 'uptostream\\.com/iframe/([0-9a-zA-Z]{12})'
status:
type: boolean
streams:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: youtube
type:
type: string
example: free
domains:
type: array
items:
type: string
example: youtube.be
regexp:
type: string
example: >-
https?:\/\/(?:www\\.)?youtube\\.com\/show\/(?P<id>[^?#]*)",
"https?:\/\/(?:www\\.)?youtube\\.com\/feed\/history|:ythistory
regexps:
type: array
items:
type: string
example: >-
https?:\/\/(?:www\\.)?youtube\\.com\/show\/(?P<id>[^?#]*)
status:
type: boolean
redirectors:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: dlprotecte
type:
type: string
example: premium
domains:
type: array
items:
type: string
example: dl-protecte.com
regexp:
type: string
example: >-
(dl-protecte\.com/[0-9a-zA-Z]+)|(protect-lien\.com/[0-9a-zA-Z]+)|dl-protecte\.org/([0-9a-zA-Z]+)
regexps:
type: array
items:
type: string
example: 'uptostream\\.com/iframe/([0-9a-zA-Z]{12})'
status:
type: boolean
error:
type: object
properties:
code:
type: string
example: AUTH_MISSING_APIKEY
message:
type: string
example: The auth apikey was not sent
/user/notification/clear:
get:
summary: This endpoint clears a user notification with its code.
description: >-
This endpoint clears a user notification with its code. Current
notifications codes can be retreive from the /user endpoint.
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: code
schema:
type: string
required: true
description: Notification code to clear
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
message:
type: string
example: Notification was cleared
error:
type: object
properties:
code:
type: string
example: AUTH_MISSING_APIKEY
message:
type: string
example: The auth apikey was not sent
/link/infos:
get:
summary: Use this endpoint to retrieve informations about a link.
description: >-
Use this endpoint to retrieve informations about a link.<br />
If it is in our systems, you'll have the filename and size (if available).<br />
<br />
If the host is not supported or the link is down, an error will be<br />
returned for that link.<br />
<br />
This endpoint only support host links, not redirectors links. Use the<br />
link/redirector endpoint for this.<br />
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: password
schema:
type: string
required: false
description: Link password (supported on uptobox / 1fichier).
- in: query
name: "link[]"
description: The link or array of links you request informations about.
required: true
schema:
type: array
items:
type: string
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
infos:
description: Array of info objects
type: array
items:
type: object
properties:
link:
type: string
example: "https://uptobox.com/l1ub83vil5c3"
description: Requested link
filename:
type: string
example: ubuntu-18.04.1-server-amd64.iso
description: Link's file filename.
size:
type: integer
format: int64
example: 699400192
description: Link's file size in bytes.
host:
type: string
example: uptobox
description: Link host.
hostDomain:
type: string
example: uptobox.com
description: Host main domain
error:
type: object
properties:
code:
type: string
example: LINK_IS_MISSING
message:
type: string
example: No link was sent
/link/redirector:
get:
summary: >-
Use this endpoint to retrieve links protected by a redirector or link
protector.
description: >-
Use this endpoint to retrieve links protected by a redirector or link
protector.
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: link
schema:
type: string
required: true
description: The redirector or protector link to extract links.
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
links:
type: array
description: Link(s) extracted.
items:
type: string
example: "http://uptobox.com/l1ub83vil5c3"
error:
type: object
properties:
code:
type: string
example: REDIRECTOR_NOT_SUPPORTED
message:
type: string
example: Redirector not supported Redirector not supported
/link/unlock:
get:
summary: This endpoint unlocks a given link.
description: >-
This endpoint can return a delayed ID. In that case, you must follow the
delayed link flow.
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: link
schema:
type: string
required: true
description: The redirector or protector link to extract links.
- in: query
name: password
schema:
type: string
required: false
description: Link password (supported on uptobox / 1fichier).
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
filename:
type: string
example: "[zza].Micmacs.à.tire-larigot.2009.1080p.x265.AC3.mkv"
filesize:
type: integer
format: int64
example: 1951233010
host:
type: string
example: uptobox
hostDomain:
type: string
example: uptobox.com
id:
type: string
example: 2bifjkf54f6
link:
type: string
example: >-
https://d01vz3.debrid.it/dl/2bifjkf54f6/%5Bzza%5D.Micmacs.%C3%A0.tire-larigot.2009.1080p.x265.AC3.mkv
paws:
type: boolean
streams:
type: array
items:
type: object
properties:
id:
type: string
example: hls
ext:
type: string
example: m3u8
quality:
type: string
example: 360
filesize:
type: integer
format: int64
example: 3433538
proto:
type: string
example: https
name:
type: string
example: m3u8
link:
type: string
example: >-
https://www43.uptostream.com/stream/54gwwydcf4/_m_main_0.m3u8
tb:
type: number
example: 130.621
abr:
type: integer
format: int64
example: 128
error:
type: object
properties:
code:
type: string
example: LINK_HOST_NOT_SUPPORTED
message:
type: string
example: This link is not supported.
/link/streaming:
get:
summary: The unlocking flow for streaming link is a bit more complex.
description: >-
First hit the usual link/unlock endpoint. Two cases:<br />
<br />
Stream link has only one quality : downloading link is available
immediatly.<br />
<br />
OR<br />
<br />
Stream links has multiple qualities : you must select the desired<br />
quality to obtain a download link or delayed id by using the<br />
link/streaming endpoint.<br />
<br />
Depending of the stream website, you'll either get a download link, or a<br />
delayed id (see Delayed link section for delayed links).<br />
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: id
schema:
type: string
required: true
description: The link ID you received from the /link/unlock call.
- in: query
name: stream
schema:
type: string
required: true
description: >-
The stream ID you choosed from the stream qualities list returned by
/link/unlock.
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: success
data:
type: object
properties:
filename:
type: string
example: "[zza].Micmacs.à.tire-larigot.2009.1080p.x265.AC3.mkv"
filesize:
type: integer
format: int64
example: 1951233010
host:
type: string
example: uptobox
hostDomain:
type: string
example: uptobox.com
id:
type: string
example: 2bifjkf54f6
link:
type: string
example: >-
https://d01vz3.debrid.it/dl/2bifjkf54f6/%5Bzza%5D.Micmacs.%C3%A0.tire-larigot.2009.1080p.x265.AC3.mkv
paws:
type: boolean
streams:
type: array
items:
type: object
properties:
id:
type: string
example: 140
ext:
type: string
example: mp3
quality:
type: string
example: mp3
filesize:
type: integer
format: int64
example: 3433538
proto:
type: string
example: https
name:
type: string
example: null
link:
type: string
tb:
type: number
example: 130.621
abr:
type: integer
format: int64
example: 128
error:
type: object
properties:
code:
type: string
example: LINK_HOST_NOT_SUPPORTED
message:
type: string
example: This link is not supported.
/link/delayed:
get:
summary: This endpoint give the status of a delayed link.
description: >-
This endpoint give the status of a delayed link.<br />
<br />
Some links need time to generate, this endpoint send the status of such
delayed links.<br />
<br />
You should pool every 5 seconds or more the link/delayed endpoint until
given the download link.<br />
security:
- bearerAuth: []
parameters:
- in: query
name: apikey
schema:
type: string
required: false
description: Deprecated User apikey (Use Bearer Auth in header).
- in: query
name: agent
schema:
type: string
default: open-alldebrid
required: true
description: Your software user-agent.
- in: query
name: id
schema:
type: string
required: true
description: Delayed ID received in /link/unlock.
responses:
"200":
description: >-
This endpoint retrieves a complete list of all available hosts for
this user
content:
application/json:
schema: