Created
July 30, 2025 15:02
-
-
Save jamtur01/410ca7ea242f7d17440aac9478e423c8 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Stream API | |
The API endpoints for streams and metadata. | |
Stream Search | |
Search for a list of stream links. | |
Note that in addition to the number of retrieved streams deducted from the user's daily link limit, the debridlookup, filematch, and sort=best options might subtract additional points from the limit. Each of these parameters has a weighted contribution to the daily link limit, depending on the complexity of the task. Hence, if 100 links are retrieved, more than 100 points might be deducted from the limit if these features are utilized. If you decide to incorporate these options, consider allowing users to disable them in your app settings. | |
Requests are subject to the user's daily link limit. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
stream | |
stream | |
The API mode which should be set to stream for this query. | |
action | |
Yes | |
Enum | |
retrieve | |
retrieve | |
The API action which should be set to retrieve for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
type | |
Yes | |
Enum | |
movie / show | |
movie | |
The type of stream to retrieve. | |
query | |
Depends | |
String | |
Avatar 2009 | |
The query string to search for. The movie or show with the best match is returned. If no query is provided, an ID should be used instead. | |
idorion | |
Depends | |
String | |
ABC2DEF3GHJ4KLM5NPQ6RST7UVW8XYZ9 | |
The Orion ID of the movie, show or episode. Available for all movies and shows. Only one of the IDs should be provided. | |
idimdb | |
Depends | |
String | |
0499549 | |
The IMDb ID of the movie, show or episode. Available for all movies and shows. Only one of the IDs should be provided. | |
idtmdb | |
Depends | |
String | |
19995 | |
The TMDb ID of the movie. Only available for some movies. Only one of the IDs should be provided. | |
idtvdb | |
Depends | |
String | |
121361 | |
The TVDb ID of the show or episode. Only available for some shows. Only one of the IDs should be provided. | |
idtvrage | |
Depends | |
String | |
24493 | |
The TVRage ID of the show or episode. Only available for very few shows. Only one of the IDs should be provided. | |
idtrakt | |
Depends | |
String | |
269 | |
The Trakt ID of the movie, show or episode. Available for all movies and shows. Only one of the IDs should be provided. | |
idslug | |
Depends | |
String | |
avatar-2009 | |
The Trakt slug of the movie, show or episode. Available for all movies and shows. Only one of the IDs should be provided. | |
numberseason | |
Depends | |
Integer | |
[0,∞] | |
5 | |
The season number. Only used if a show ID was provided. Not used if a movie or episode ID was provided. | |
numberepisode | |
Depends | |
Integer | |
[0,∞] | |
12 | |
The episode number. Only used if a show ID was provided. Not used if a movie or episode ID was provided. | |
limitcount | |
No | |
Integer | |
[0,∞] | |
500 | |
The maximum number of streams to return. If not specified, all available links are returned. Make sure to specify a limit, since without one you might use up the entire daily limit with one query. | |
limitretry | |
No | |
Integer | |
[0,∞] | |
100 | |
The maximum number of streams to return if the normal search fails. If the filters are too restrictive, no streams are returned. A second search can be conducted without any of the filters and its own link limit. By default this option is disabled. | |
limitoffset | |
No | |
Integer | |
[0,∞] | |
200 | |
The links to return according to an offset starting from 0. If the offset is set to X, the first X links are skipped and only the links thereafter are returned. Either a limit offset or page should be provided, but not both. | |
limitpage | |
No | |
Integer | |
[1,∞] | |
2 | |
The links to return according to a page offset starting from 1. This works similar to the normal offset. If the count limit is set to X and the page to Y, then an offset of (X * (Y + 1)) is used. Hence, the offset is specified in large pages instead of individual links. Either a limit offset or page should be provided, but not both. | |
timeadded | |
No | |
Integer | |
[0,∞] | |
1514764800 | |
The minimum Unix timestamp since the stream was initially added. Only streams that were added after this date are returned. Alternatively, the age in number of days can be used. | |
timeaddedage | |
No | |
Integer | |
[0,∞] | |
100 | |
The maximum number of days since the stream was initially added. Only streams that were added within this period are returned. Alternatively, the Unix timestamp can be used. | |
timeupdated | |
No | |
Integer | |
[0,∞] | |
1514764800 | |
The minimum Unix timestamp since the stream was last updated. Only streams that were updated after this date are returned. Alternatively, the age in number of days can be used. | |
timeupdatedage | |
No | |
Integer | |
[0,∞] | |
100 | |
The maximum number of days since the stream was last updated. Only streams that were updated within this period are returned. Alternatively, the Unix timestamp can be used. | |
sortvalue | |
No | |
Enum | |
none / best / shuffle / timeadded / timeupdated / popularity / filesize / streamseeds / streamage / videoquality / audiochannels | |
videoquality | |
The attribute to sort streams by. By default streams are sorted according to best selection, which combines all metadata attributes, trying to find the highest quality streams. The shuffle option randomly mixes the results. | |
sortorder | |
No | |
Enum | |
ascending / descending | |
ascending | |
The order to sort the streams by. By default streams are sorted in descending order. | |
popularitypercent | |
No | |
Float | |
[0,1] | |
0.8 | |
The minimum popularity percentage of streams. Popularity is determined by the number of users who access the stream. The percentage is calculated as a relative measurement to the popularity of other streams for the given movie or show. | |
popularitycount | |
No | |
Integer | |
[0,∞] | |
2452 | |
The minimum popularity count of streams. Popularity is determined by the number of users who access the stream. The count is an absolute measurement. For a finer or relative measurement, the percentage should be used instead. | |
access | |
No | |
Selection | |
direct / indirect / premiumize / premiumizetorrent / premiumizeusenet / premiumizehoster / offcloud / offcloudtorrent / offcloudusenet / offcloudhoster / torbox / torboxtorrent / torboxusenet / torboxhoster / easydebrid / easydebridtorrent / realdebrid / realdebridtorrent / realdebridusenet / realdebridhoster / debridlink / debridlinktorrent / debridlinkhoster / alldebrid / alldebridtorrent / alldebridhoster | |
direct,premiumize | |
The access status of the stream. Only streams that are cached with a debrid service, direct hoster links that do not require an account, or indirect hoster links that require an account or URL resolver, are returned. The cached access status can be checked for all or specific stream types, namely torrents, usenet, and hosters. | |
debridlookup | |
No | |
Selection | |
all / user / premiumize / offcloud / torbox / easydebrid / realdebrid / debridlink / alldebrid | |
premiumize,realdebrid | |
Do a fresh cache lookup on the debrid server to determine the current cache status. If no lookup is done, the previously known cache status is returned instead. The all options retrieves the cache status for all debrid services, whereas the user option only retrieves the cache status of debrid services authenticated by the user. Note that using this option will increase the duration of the API request. Users should authorize their debrid account on Orion's website. | |
debridresolve | |
No | |
Selection | |
user / premiumize / offcloud / torbox / easydebrid / realdebrid / debridlink / alldebrid / list / choice / link / redirect / original / stream / sequential / ip | |
premiumize,123.45.67.89 | |
Add resolving debrid links to the results. The streaming link is only added as a debrid attribute to the results if the user has at least one debrid account authenticated with Orion. If this link is visited, Orion resolves the link with a debrid service and automatically redirects to the debrid file for immediate downloading or streaming. This feature is useful if your app does not have its own debrid functionality. If the value of this parameter is set to user, the first available debrid service authenticated by the user is automatically selected. Alternatively, you can specify the debrid service of choice. More information on the options can be found under the Debrid Resolve endpoint documentation. | |
streamtype | |
No | |
Selection | |
torrent / usenet / hoster | |
torrent,hoster | |
The type of the stream, either from the torrent or usenet network, or from a file hoster. | |
streamsource | |
No | |
Selection | |
thepiratebay,limetorrents | |
The source or website the streams originate from. Names must be alphanumeric without spaces or symbols. | |
streamhoster | |
No | |
Selection | |
openload, rapidgator | |
The server or website the file is hosted on. Names must be alphanumeric without spaces or symbols. | |
streamseeds | |
No | |
Integer | |
[0,∞] | |
50 | |
The minimum number of seeds for torrents. | |
streamage | |
No | |
Integer | |
[0,∞] | |
365 | |
The maximum number of days since the NZB was uploaded to the usenet. | |
protocoltorrent | |
No | |
Selection | |
magnet / http / https / ftp / ftps | |
magnet,https | |
The protocol of the torrent links. | |
protocolusenet | |
No | |
Selection | |
http / https / ftp / ftps | |
http,https | |
The protocol of the usenet links. | |
protocolhoster | |
No | |
Selection | |
http / https / ftp / ftps | |
http,https | |
The protocol of the hoster links. | |
filename | |
No | |
Selection | |
true / false / list | |
hdr,-dv | |
The file name of the stream. If set to true, only streams with a file name will be retrieved. If set to false, only streams without a file name will be retrieved. Alternatively, a comma-separated list of keywords that must match the file name can be passed. Keywords starting with a - are excluded, otherwise they are included. All keywords are ANDed together in lowercase, hence all of the included keywords and none of the excluded keywords must be present in the file name. Note that this matches any substring in the file name, not only full words. Hence, "en" will not only match the English language code, but also any word that contains the substring "en", like "french". Spaces and other special characters have to be URL-encoded. For more advanced file name matching, use the filematch parameter. | |
filematch | |
No | |
String | |
(hdr|dv|dolby.?vision) | |
Match the file name of the stream against a custom regular expression. Expressions have to be URL-encoded. A detailed explanation of this parameter is given at the end of the API documentation. For more basic substring filtering, use the filename parameter. | |
filesize | |
No | |
Range | |
[0,∞] | |
536870912_1073741824 | |
The file size range in bytes. | |
fileunknown | |
No | |
Bool | |
true / false | |
true | |
Whether or not to include streams with an unknown file size. | |
filepack | |
No | |
Bool | |
true / false | |
true | |
Whether or not to return episodes that are part of a season pack. By default all episodes are returned, irrespective of season packs. | |
filelanguages | |
No | |
Selection | |
ab / aa / af / ak / sq / am / ar / an / hy / as / av / ae / ay / az / bm / ba / eu / be / bn / bh / bi / nb / bs / br / bg / my / ca / ch / ce / ny / zh / cv / kw / co / cr / hr / cs / da / dv / nl / dz / en / eo / et / ee / fo / fj / fi / fr / ff / gd / gl / lg / ka / de / el / gn / gu / ht / ha / he / hz / hi / ho / hu / is / io / ig / id / ia / ie / iu / ik / ga / it / ja / jv / kl / kn / kr / ks / kk / km / ki / rw / rn / kv / kg / ko / ku / kj / ky / lo / la / lv / li / ln / lt / lu / lb / mk / mg / ms / ml / mt / gv / mi / mr / mh / mn / na / nv / ng / ne / nd / se / no / ii / nn / oc / oj / or / om / os / pi / ps / fa / pl / pt / pa / qu / ro / rm / ru / sm / sg / sa / sc / sr / sn / sd / si / cu / sk / sl / so / nr / st / es / su / sw / ss / sv / tl / ty / tg / ta / tt / te / th / bo / ti / to / ts / tn / tr / tk / tw / uk / ur / ug / uz / ve / vi / vo / wa / cy / fy / wo / xh / yi / yo / za / zu | |
en,fr | |
The language of the streams, either the audio or the subtitle language. Languages use the ISO 639-1 two-letter codes. If only the audio or the subtitle language should be searched, use the audiolanguages or subtitlelanguages parameters instead. | |
metarelease | |
No | |
Selection | |
bdrip / bdrmx / bdscr / bluray / cam / ddc / dvd / dvdrip / dvdrmx / dvdscr / hdts / hdrip / hdtv / pdvd / ppv / r5 / scr / tk / ts / tvrip / vcd / vhs / vhsrip / dcprip / webcap / webdl / webrip / wp | |
bluray,bdrip | |
The release type of the streams. By default all releases are included. | |
metauploader | |
No | |
Selection | |
publichd,sparks | |
The uploader of the streams. By default all uploaders are included. | |
metaedition | |
No | |
Selection | |
extended / collector / director / commentary / making / special | |
extended | |
The edition of the stream. The video can be an extended edition, collector's edition, director's cut, commentary voiceover, making of, or special edition. By default all editions are included. | |
videoquality | |
No | |
Range | |
cam / cam720 / cam1080 / scr / scr720 / scr1080 / sd / hd720 / hd1080 / hd2k / hd4k / hd6k / hd8k | |
sd_hd1080 | |
The video quality of the stream. | |
videocodec | |
No | |
Selection | |
h266 / h265 / h264 / h262 / h222 / av1 / vp10 / vp9 / vp8 / 3gp / avi / divx / flv / mov / mpeg / wmv / xvid / mkv / webm | |
h265,mkv | |
The video codec or container of the stream. | |
video3d | |
No | |
Bool | |
true / false | |
false | |
Whether or not the stream is in 3D or not. By default all streams are returned, irrespective of 3D features. | |
audiotype | |
No | |
Selection | |
standard / dubbed | |
-dubbed | |
The audio type as a standard or dubbed recording. | |
audiochannels | |
No | |
Range | |
1 / 2 / 6 / 8 | |
2_6 | |
The number of audio channels. Mono is 1 and stereo is 2. 5.1 and 7.1 surround sounds systems have 6 and 8 channels respectively. | |
audiosystem | |
No | |
Selection | |
dd / dts / dig / mpeg / xiph / win / app | |
dd,dts | |
The audio system of the stream. | |
audiocodec | |
No | |
Selection | |
amsthd / amspls / ams / thd / pls / lve / sex / ex / ac3 / ac4 / 70 / 9624 / es / neo6 / neox / neopc / neo / hdhra / hdma / hd / nx / hx / ss / con / ina / pyf / x / dra / aac / mp3 / mp2 / flac / ogg / wma / alac / pcm | |
hdhra,hdma,hd | |
The audio codec of the stream. | |
audiolanguages | |
No | |
Selection | |
ab / aa / af / ak / sq / am / ar / an / hy / as / av / ae / ay / az / bm / ba / eu / be / bn / bh / bi / nb / bs / br / bg / my / ca / ch / ce / ny / zh / cv / kw / co / cr / hr / cs / da / dv / nl / dz / en / eo / et / ee / fo / fj / fi / fr / ff / gd / gl / lg / ka / de / el / gn / gu / ht / ha / he / hz / hi / ho / hu / is / io / ig / id / ia / ie / iu / ik / ga / it / ja / jv / kl / kn / kr / ks / kk / km / ki / rw / rn / kv / kg / ko / ku / kj / ky / lo / la / lv / li / ln / lt / lu / lb / mk / mg / ms / ml / mt / gv / mi / mr / mh / mn / na / nv / ng / ne / nd / se / no / ii / nn / oc / oj / or / om / os / pi / ps / fa / pl / pt / pa / qu / ro / rm / ru / sm / sg / sa / sc / sr / sn / sd / si / cu / sk / sl / so / nr / st / es / su / sw / ss / sv / tl / ty / tg / ta / tt / te / th / bo / ti / to / ts / tn / tr / tk / tw / uk / ur / ug / uz / ve / vi / vo / wa / cy / fy / wo / xh / yi / yo / za / zu | |
en,fr | |
The audio language of the streams. Languages use the ISO 639-1 two-letter codes. If either the audio or the subtitle language should be searched, use the filelanguage parameter instead. | |
subtitletype | |
No | |
Selection | |
soft / hard | |
soft | |
The subtitles of the streams, either soft or hard coded. By default all subtitles and non-subtitle streams are returned. | |
subtitlelanguages | |
No | |
Selection | |
ab / aa / af / ak / sq / am / ar / an / hy / as / av / ae / ay / az / bm / ba / eu / be / bn / bh / bi / nb / bs / br / bg / my / ca / ch / ce / ny / zh / cv / kw / co / cr / hr / cs / da / dv / nl / dz / en / eo / et / ee / fo / fj / fi / fr / ff / gd / gl / lg / ka / de / el / gn / gu / ht / ha / he / hz / hi / ho / hu / is / io / ig / id / ia / ie / iu / ik / ga / it / ja / jv / kl / kn / kr / ks / kk / km / ki / rw / rn / kv / kg / ko / ku / kj / ky / lo / la / lv / li / ln / lt / lu / lb / mk / mg / ms / ml / mt / gv / mi / mr / mh / mn / na / nv / ng / ne / nd / se / no / ii / nn / oc / oj / or / om / os / pi / ps / fa / pl / pt / pa / qu / ro / rm / ru / sm / sg / sa / sc / sr / sn / sd / si / cu / sk / sl / so / nr / st / es / su / sw / ss / sv / tl / ty / tg / ta / tt / te / th / bo / ti / to / ts / tn / tr / tk / tw / uk / ur / ug / uz / ve / vi / vo / wa / cy / fy / wo / xh / yi / yo / za / zu | |
en,fr | |
The subtitle language of the streams. Languages use the ISO 639-1 two-letter codes. If either the audio or the subtitle language should be searched, use the filelanguage parameter instead. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=stream&action=retrieve&type=movie&idimdb=0063350 | |
Response | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success", | |
type: "streamretrieve", | |
description: "Streams Retrieved", | |
message: "The streams were found." | |
}, | |
data: { | |
type: "movie", | |
movie: { | |
id: { | |
orion: "LFQW7TNQMCGPLPT89KGPPDMGPDJJTAJJ", | |
imdb: "0063350", | |
tmdb: "10331" | |
}, | |
time: { | |
added: 1529483160, | |
updated: 1531215897 | |
}, | |
meta: { | |
title: "Night of the Living Dead", | |
year: 1968 | |
}, | |
popularity: { | |
count: 4, | |
percent: 0.05719 | |
} | |
}, | |
count: { | |
total: 117, | |
requested: 0, | |
retrieved: 117 | |
}, | |
streams: [ | |
{ | |
id: "A8CPEBRPHL99HB9FJBAD8EUG9EMJ7PE6", | |
time: { | |
added: 1529483160, | |
updated: 1530521619 | |
}, | |
links: [ | |
"magnet:?xt=urn:btih:b8602f98bf58d1ddcd413ef40ead4aa4853f4b7c", | |
"https://thepiratebay.org/torrent/4561223.torrent", | |
"https://orionoid.com/container/A8CPEBRPHL99HB9FJBAD8EUG9EMJ7PE6" | |
], | |
stream: { | |
type: "torrent", | |
source: "thepiratebay", | |
hoster: null, | |
seeds: 7, | |
time: 0 | |
}, | |
access: { | |
direct: false, | |
premiumize: true, | |
offcloud: false, | |
torbox: true, | |
easydebrid: true, | |
realdebrid: false | |
}, | |
file: { | |
hash: "b8602f98bf58d1ddcd413ef40ead4aa4853f4b7c", | |
name: "Night.Of.The.Living.Dead.1968.720p.BluRay.x264-CtrlHD [PublicHD]", | |
size: 4692251770, | |
pack: false | |
}, | |
meta: { | |
release: "bluray", | |
uploader: "publichd", | |
edition: null | |
}, | |
video: { | |
quality: "hd720", | |
codec: "h264", | |
3d: false | |
}, | |
audio: { | |
type: "standard", | |
channels: 2, | |
system: "dd", | |
codec: "ac3", | |
languages: [ | |
"en" | |
] | |
}, | |
subtitle: { | |
type: null, | |
languages: [] | |
}, | |
popularity: { | |
count: 1, | |
percent: 0.74159 | |
} | |
} | |
], | |
requests: { | |
total: 121, | |
daily: { | |
limit: 5000, | |
used: 121, | |
remaining: 4879 | |
} | |
} | |
} | |
} | |
Container API | |
The API endpoints for torrent and NZB containers, hashes, and identifiers. | |
Container Details | |
Search for a list of torrent and nzb container details. | |
Hashes are already returned from the stream search endpoint and there is no need to make an additional request to this endpoint to retrieve them. This endpoint is only for retrieving details of torrents and nzbs that were not retrieved from Orion, but from some external scraper. | |
Requests are subject to the user's daily hash limit. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
container | |
container | |
The API mode which should be set to container for this query. | |
action | |
Yes | |
Enum | |
retrieve | |
retrieve | |
The API action which should be set to retrieve for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
links | |
Yes | |
List | |
["https://www2.yggtorrent.ch/engine/ download_torrent?id=459370", "https://abnzb.com/api?t=get& id=716b6d95f2c61b1c57edbace625ac739"] | |
A list of links to retrieve details for. Currently only links pointing to torrent and usenet containers are supported. Links submitted as GET or POST parameters must be URL-encoded. Links submitted as JSON parameters do not have to be URL-encoded. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=container&action=retrieve&links[]=https%3A%2F%2Fwww2.yggtorrent.ch%2Fengine%2Fdownload_torrent%3Fid%3D459370&links[]=https%3A%2F%2Fabnzb.com%2Fapi%3Ft%3Dget%26id%3Dfaf1de51f8a3762b7c3f893becdcceb6 | |
Response | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success" | |
}, | |
data: { | |
containers: [ | |
{ | |
id: "67CLFH58MVGFKHLJ6JBEMQV9GPJS7GE8", | |
type: "torrent", | |
time: null, | |
hash: "db4586385cd95941cd41199f11e5067c39108ed6", | |
link: { | |
orion: null, | |
source: https://www2.yggtorrent.ch/engine/download_torrent?id=459370, | |
magnet: null | |
} | |
}, | |
{ | |
id: "5JLQC8HMBK8DGJP94TTNTFNN7KDBKAKM", | |
type: "usenet", | |
time: null, | |
hash: "34ad6d53b9742cb47f76f47340ef5484242e936d", | |
link: { | |
orion: https://orionoid.com/container/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA/5JLQC8HMBK8DGJP94TTNTFNN7KDBKAKM, | |
source: https://abnzb.com/api?t=get&id=faf1de51f8a3762b7c3f893becdcceb6 | |
}, | |
segment: { | |
first: "[email protected]", | |
largest: "[email protected]", | |
list: [ | |
"[email protected]", | |
"[email protected]", | |
"[email protected]", | |
"n4_J150R4IYdO4lmSqUTiNFWjB-@od3GbD5v._ZN", | |
"[email protected]" | |
] | |
} | |
} | |
], | |
count: { | |
requested: 2, | |
retrieved: 2 | |
}, | |
requests: { | |
total: 2563, | |
daily: { | |
limit: 10000, | |
used: 6852, | |
remaining: 3148 | |
} | |
} | |
} | |
} | |
Container Identifiers | |
Search for a list of SHA1 hashes and segment IDs of torrent and nzb containers. This function is a combination of the container hash and segment functions. More details can be found under the hash and segment sections. | |
Hashes are already returned from the stream search endpoint and there is no need to make an additional request to this endpoint to retrieve them. This endpoint is only for retrieving details of torrents and nzbs that were not retrieved from Orion, but from some external scraper. | |
Requests are subject to the user's daily hash limit. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
container | |
container | |
The API mode which should be set to container for this query. | |
action | |
Yes | |
Enum | |
identifier | |
identifier | |
The API action which should be set to identifier for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
links | |
Yes | |
List | |
["https://abnzb.com/api?t=get& id=716b6d95f2c61b1c57edbace625ac739"] | |
A list of links to retrieve identifiers for. Currently only links pointing to torrent and usenet containers are supported. Links submitted as GET or POST parameters must be URL-encoded. Links submitted as JSON parameters do not have to be URL-encoded. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=container&action=identifier&links[]=https%3A%2F%2Fwww2.yggtorrent.ch%2Fengine%2Fdownload_torrent%3Fid%3D459370&links[]=https%3A%2F%2Fabnzb.com%2Fapi%3Ft%3Dget%26id%3Dfaf1de51f8a3762b7c3f893becdcceb6 | |
Response | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success" | |
}, | |
data: { | |
identifiers: { | |
https://www2.yggtorrent.ch/engine/download_torrent?id=459370: { | |
hash: "db4586385cd95941cd41199f11e5067c39108ed6" | |
}, | |
https://abnzb.com/api?t=get&id=faf1de51f8a3762b7c3f893becdcceb6: { | |
hash: "34ad6d53b9742cb47f76f47340ef5484242e936d", | |
segment: { | |
first: "[email protected]", | |
largest: "[email protected]", | |
list: [ | |
"[email protected]", | |
"[email protected]", | |
"n4_J150R4IYdO4lmSqUTiNFWjB-@od3GbD5v._ZN", | |
"[email protected]" | |
] | |
} | |
} | |
}, | |
count: { | |
requested: 2, | |
retrieved: 2 | |
}, | |
requests: { | |
total: 2563, | |
daily: { | |
limit: 10000, | |
used: 6852, | |
remaining: 3148 | |
} | |
} | |
} | |
} | |
Container Hashes | |
Search for a list of torrent and nzb container SHA1 hashes. | |
Hashes are already returned from the stream search endpoint and there is no need to make an additional request to this endpoint to retrieve them. This endpoint is only for retrieving details of torrents and nzbs that were not retrieved from Orion, but from some external scraper. | |
Requests are subject to the user's daily hash limit. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
container | |
container | |
The API mode which should be set to container for this query. | |
action | |
Yes | |
Enum | |
hash | |
hash | |
The API action which should be set to hash for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
links | |
Yes | |
List | |
["https://www2.yggtorrent.ch/engine/ download_torrent?id=459370", "https://abnzb.com/api?t=get& id=716b6d95f2c61b1c57edbace625ac739"] | |
A list of links to retrieve hashes for. Currently only links pointing to torrent and usenet containers are supported. Links submitted as GET or POST parameters must be URL-encoded. Links submitted as JSON parameters do not have to be URL-encoded. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=container&action=hash&links[]=https%3A%2F%2Fwww2.yggtorrent.ch%2Fengine%2Fdownload_torrent%3Fid%3D459370&links[]=https%3A%2F%2Fabnzb.com%2Fapi%3Ft%3Dget%26id%3Dfaf1de51f8a3762b7c3f893becdcceb6 | |
Response | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success" | |
}, | |
data: { | |
hashes: { | |
https://www2.yggtorrent.ch/engine/download_torrent?id=459370: "db4586385cd95941cd41199f11e5067c39108ed6" | |
}, | |
count: { | |
requested: 2, | |
retrieved: 1 | |
}, | |
requests: { | |
total: 2563, | |
daily: { | |
limit: 10000, | |
used: 6852, | |
remaining: 3148 | |
} | |
} | |
} | |
} | |
Container Segments | |
Search for a list of segment IDs of nzb containers. All identifiers are the first message ID of the <segments> section. A list of first message IDs from all <segments>, the first <segments>, and the largest <segments> is returned. To retrieve any other message IDs, download the entire container. | |
Requests are subject to the user's daily hash limit. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
container | |
container | |
The API mode which should be set to container for this query. | |
action | |
Yes | |
Enum | |
segment | |
segment | |
The API action which should be set to segment for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
links | |
Yes | |
List | |
["https://abnzb.com/api?t=get& id=716b6d95f2c61b1c57edbace625ac739"] | |
A list of links to retrieve segments for. Currently only links pointing to usenet containers are supported. Links submitted as GET or POST parameters must be URL-encoded. Links submitted as JSON parameters do not have to be URL-encoded. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=container&action=segment&links[]=https%3A%2F%2Fabnzb.com%2Fapi%3Ft%3Dget%26id%3Dfaf1de51f8a3762b7c3f893becdcceb6 | |
Response | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success" | |
}, | |
data: { | |
segments: { | |
https://abnzb.com/api?t=get&id=faf1de51f8a3762b7c3f893becdcceb6: { | |
first: "[email protected]", | |
largest: "[email protected]", | |
list: [ | |
"[email protected]", | |
"[email protected]", | |
"n4_J150R4IYdO4lmSqUTiNFWjB-@od3GbD5v._ZN", | |
"[email protected]" | |
] | |
} | |
}, | |
count: { | |
requested: 2, | |
retrieved: 2 | |
}, | |
requests: { | |
total: 2563, | |
daily: { | |
limit: 10000, | |
used: 6852, | |
remaining: 3148 | |
} | |
} | |
} | |
} | |
Container Download | |
Download a torrent or nzb container file. | |
Requests are subject to the user's daily container limit. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
container | |
container | |
The API mode which should be set to container for this query. | |
action | |
Yes | |
Enum | |
download | |
download | |
The API action which should be set to download for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
id | |
Yes | |
String | |
https://abnzb.com/api?t=get& id=faf1de51f8a3762b7c3f893becdcceb6 | |
An ID, SHA1 hash, or source link of the container. Links submitted as GET or POST parameters must be URL-encoded. Links submitted as JSON parameters do not have to be URL-encoded. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=container&action=download&id=https%3A%2F%2Fabnzb.com%2Fapi%3Ft%3Dget%26id%3Dfaf1de51f8a3762b7c3f893becdcceb6 | |
Response | |
The request returns the binary data of the container file on success. On failure, such as the container not exisiting, or the daily limit being reached, a standard JSON response with the error will be returned. Check the response's content type to determine the success or failure of the download. | |
Debrid API | |
The API endpoints for interfacing with external debrid services. | |
Debrid Support | |
Determine the networks and hosters supported by various debrid services, by retrieving regular expressions, domains, and the active statuses. | |
This request might take some, since calls are made to external APIs. You should therefore use a timeout of at least 30 seconds, depended on the number of debrid services to check. This feature does not require users to have their debrid account authenticated with Orion, but it is recommended for additional functionality. | |
Requests can be made with one of the following parameters: | |
No IDs or links, to retrieve detailed data for all stream types and hosters. | |
A single item ID and a list of stream IDs, to determine debrid support for the given IDs. | |
A list of torrent, usenet, and hoster links, to determine debrid support for the given links. | |
Requests are subject to the user's daily hash limit. If possible, developers should not submit IDs or links to this endpoint, since if will use more of the user's daily hash limit. A better way is to retrieve the regular expressions from this endpoint and match them locally in the app. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
debrid | |
debrid | |
The API mode which should be set to debrid for this query. | |
action | |
Yes | |
Enum | |
support | |
support | |
The API action which should be set to support for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
type | |
Yes | |
Selection | |
all / user / premiumize / offcloud / torbox / easydebrid / realdebrid / debridlink / alldebrid | |
premiumize,realdebrid | |
The debrid services to check support for. The user option automatically selects the debrid services authenticated by the user. The all option uses all debrid services. Multiple services can be passed as a comma separated list. | |
global | |
No | |
Bool | |
true / false | |
true | |
When set to false, all debrid services specified in the type parameter are listed separately. When set to true, all debrid services specified in the type parameter are combined into a single global strcuture. | |
status | |
No | |
Bool | |
true / false | |
true | |
Certain networks or hosters might be temporarily unavailable on some debrid services. When set to true, only networks or hosters that are currently active are returned. If this parameter not specified, all networks or hosters are returned, even those that are currently inactive. | |
output | |
No | |
String | |
expression / domain | |
expression | |
The format of the response data being returned. By default all detailed data is returned. When set to expression, only the regular expressions of all services are returned. When set to domain, only the domains of all services are returned. | |
iditem | |
No | |
String | |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | |
The Orion ID of the movie or episode the check debrid support for. Only a single item ID can be requested. Must be used in combination with stream IDs. This parameter is not needed if you look up raw links. | |
idstream | |
No | |
List | |
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY | |
The Orion ID of the stream to check debrid support for. Must be used in combination with an item ID. Multiple stream IDs can be passed in as an array when making JSON requests. For GET and POST requests, URL arrays can be used: streamid[]=id0 &streamid[]=id1 &streamid[]=id2 &streamid[]=id3. | |
link | |
No | |
List | |
https://filehoster.com/somefile | |
The torrent, usenet, or hoster links to check debrid support for. Torrent magnets and links for .torrent or .nzb files are supported. Multiple links can be passed in as an array when making JSON requests. For GET and POST requests, URL arrays can be used: link[]=link1 &link[]=link2 &link[]=link3. Links must be URL-encoded when passed as GET or POST parameters. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=debrid&action=support&type=premiumize | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=debrid&action=support&type=all&link[]=magnet%3A%3Fxt%3Durn%3Abtih%3A1FA82BB959257AFC7D849D7B014BDD2F76BD2C12&link[]=https%3A%2F%2Ffilehoster.com%2Fsomefile | |
Response | |
The returned data has one of the following structures: | |
With no IDs or links: A list of networks and hosters supported by the debrid service, with domains, regular expressions and other detailed info. | |
With IDs or links: A list of the passed IDs or links together with a boolean value that indicates whether or not the given stream is supported by the debrid service. | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success", | |
type: "debridsupport", | |
description: "Support Successful", | |
message: "The debrid supported services were successfully determined." | |
}, | |
data: { | |
support: { | |
premiumize: { | |
torrent: { | |
id: "torrent", | |
name: "Torrent", | |
access: "premium", | |
status: true, | |
cache: true, | |
limit: { | |
size: null, | |
count: null, | |
point: null, | |
concurrent: null | |
}, | |
expression: { | |
main: "(^magnet:\?|\.torrent$)", | |
all: [ | |
"^magnet:\?", | |
"\.torrent$" | |
] | |
} | |
}, | |
usenet: { | |
id: "usenet", | |
name: "Usenet", | |
access: "premium", | |
status: true, | |
cache: false, | |
limit: { | |
size: null, | |
count: null, | |
point: null, | |
concurrent: null | |
}, | |
expression: { | |
main: "(\.nzb$|[=/?&]getnzb|spot(?:web|net)|\/get\/collection\/|nzbreader|api.*?t=get(?:$|&)|newznab|nzb:|nzb\.fcgi|action=nzb|https?://(?:.*?\.)*(?:abnzb|dognzb|miatrix|ninjacentral|nzbfinder|nzbgeek|nzbndx|nzbnoob|nzbs2go|tabula.*?rasa|usenet.*?crawler|binsearch|binzb|findnzb|freenzbs|nzbfriends|nzbhunter|nzbid|nzbindex|nzbking|nzbserver|nzbstars|nzbxs|rcsnet|spotnzb)(?:\.[a-zA-Z0-9\-]{2,})+\/.+)", | |
all: [ | |
"\.nzb$", | |
"[=/?&]getnzb", | |
"spot(?:web|net)", | |
"\/get\/collection\/", | |
"nzbreader", | |
"api.*?t=get(?:$|&)", | |
"newznab", | |
"nzb:", | |
"nzb\.fcgi", | |
"action=nzb", | |
"https?://(?:.*?\.)*(?:abnzb|dognzb|miatrix|ninjacentral|nzbfinder|nzbgeek|nzbndx|nzbnoob|nzbs2go|tabula.*?rasa|usenet.*?crawler|binsearch|binzb|findnzb|freenzbs|nzbfriends|nzbhunter|nzbid|nzbindex|nzbking|nzbserver|nzbstars|nzbxs|rcsnet|spotnzb)(?:\.[a-zA-Z0-9\-]{2,})+\/.+" | |
] | |
} | |
}, | |
hoster: { | |
id: "hoster", | |
name: "Hoster", | |
access: "premium", | |
status: true, | |
cache: true, | |
limit: { | |
size: null, | |
count: null, | |
point: null, | |
concurrent: null | |
}, | |
service: [ | |
{ | |
id: "1fichier", | |
name: "1Fichier", | |
type: "host", | |
access: "premium", | |
status: true, | |
direct: true, | |
cache: true, | |
limit: { | |
size: null, | |
count: null, | |
point: 2, | |
concurrent: null | |
}, | |
domain: { | |
main: "1fichier.com", | |
all: [ | |
"1fichier.com", | |
"alterupload.com", | |
"cjoint.net", | |
"dl4free.com", | |
"tenvoi.com", | |
"pjointe.com", | |
"megadl.fr", | |
"piecejointe.net", | |
"mesfichiers.org", | |
"dfichiers.com", | |
"desfichiers.com" | |
] | |
}, | |
expression: { | |
main: "(https?://1fichier\.com/.*)", | |
all: [ | |
"(https?://1fichier\.com/.*)" | |
] | |
} | |
}, | |
{ | |
id: "rapidgator", | |
name: "Rapidgator", | |
type: "host", | |
access: "premium", | |
status: true, | |
direct: false, | |
cache: false, | |
limit: { | |
size: 62914560000, | |
count: null, | |
point: null, | |
concurrent: null | |
}, | |
domain: { | |
main: "rapidgator.net", | |
all: [ | |
"rapidgator.net", | |
"rg.to" | |
] | |
}, | |
expression: { | |
main: "(((rapidgator\.net|rg\.to|rapidgator\.asia)/file/([0-9a-zA-Z]{32}))|((rapidgator\.net/file/[0-9]{8})))", | |
all: [ | |
"((rapidgator\.net|rg\.to|rapidgator\.asia)/file/([0-9a-zA-Z]{32}))", | |
"(rapidgator\.net/file/[0-9]{8})" | |
] | |
} | |
}, | |
{ | |
id: "zippyshare", | |
name: "Zippyshare", | |
type: "host", | |
access: "premium", | |
status: true, | |
direct: false, | |
cache: false, | |
limit: { | |
size: 96636764160, | |
count: 300, | |
point: null, | |
concurrent: null | |
}, | |
domain: { | |
main: "zippyshare.com", | |
all: [ | |
"zippyshare.com" | |
] | |
}, | |
expression: { | |
main: "((https?:\/\/)?(www.+\.)zippyshare\.com\/v\/([A-Za-z0-9]{8})\/file\.html)", | |
all: [ | |
"((https?:\/\/)?(www.+\.)zippyshare\.com\/v\/([A-Za-z0-9]{8})\/file\.html)" | |
] | |
} | |
} | |
] | |
} | |
} | |
}, | |
requests: { | |
total: 34267, | |
daily: { | |
limit: 5000, | |
used: 353, | |
remaining: 4647 | |
} | |
} | |
} | |
} | |
Debrid Lookup | |
Look up the cached status of a file on a debrid server. Cached files can be streamed directly from a debrid server without having to wait for the download to complete. | |
This request might take very long, since calls are made to external APIs. You should therefore use a timeout of at least 60 seconds, depended on the number of debrid services, links and hashes to check. Free users must have their debrid account authenticated with Orion for this feature. Premium users can make cache lookups even without a debrid account. | |
Requests can be made with one of the following parameters: | |
A single item ID and a list of stream IDs. | |
A list of torrent hashes. | |
A list of hoster links. | |
A combination of the previous options. | |
Lookups can also be done as part of the stream search API request using the debridlookup parameter, without the need of a separate request to this endpoint. Doing the lookup during stream searching is recommended. Calls to this API endpoint should only be done if no other option is possible. | |
This API request should never be made for individual links. If you have multiple links to look up, you should add them all to a single API request. If there have many links to check and you make a separate API request for each link in parallel, you put a heavy load on both our server and debrid servers. Our system will start dropping connections if too many are established simultaneously. | |
Requests are subject to the user's daily link limit. Free users need at least one debrid account authenticated with Orion. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
debrid | |
debrid | |
The API mode which should be set to debrid for this query. | |
action | |
Yes | |
Enum | |
lookup | |
lookup | |
The API action which should be set to lookup for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
type | |
Yes | |
Selection | |
all / user / premiumize / offcloud / torbox / easydebrid / realdebrid / debridlink / alldebrid | |
premiumize,realdebrid | |
The debrid cache to look up. The user option automatically selects the debrid services authenticated by the user. The all option looks up the cache of all debrid services. Do not retrieve all debrid caches if you do not really need them. Multiple services can be passed as a comma separated list. | |
refresh | |
No | |
Bool | |
true / false | |
true | |
Whether to make a fresh cache lookup or return the last cache status known to Orion. Fresh lookups will make API calls to external debrid servers and are therefore slower. Using the last known status is a lot faster, but only works with Orion IDs and not with raw hashes or links. | |
iditem | |
Depends | |
String | |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | |
The Orion ID of the movie or episode the look up. Only a single item ID can be requested. Must be used in combination with stream IDs. This parameter is not needed if you look up raw links or hashes. | |
idstream | |
Depends | |
List | |
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY | |
The Orion ID of the stream to lookup. Must be used in combination with an item ID. Multiple stream IDs can be passed in as an array when making JSON requests. For GET and POST requests, URL arrays can be used: streamid[]=id0 &streamid[]=id1 &streamid[]=id2 &streamid[]=id3. | |
link | |
Depends | |
List | |
https://filehoster.com/somefile | |
The hoster links to check against the debrid cache. Links for .torrent or .nzb files are not supported. Torrent magnets work, but you should rather extract the hash and pass it to the API call to save bandwidth. Only Premiumize supports hoster caching. Multiple links can be passed in as an array when making JSON requests. For GET and POST requests, URL arrays can be used: link[]=link1 &link[]=link2 &link[]=link3. Links must be URL-encoded when passed as GET or POST parameters. | |
hash | |
Depends | |
List | |
1a2b3c4d5e1a2b3c4d5e1a2b3c4d5e1a2b3c4d5e | |
The torrent hashes to check against the debrid cache. Torrent magnets work, but you should rather extract the hash and pass it to the API call to save bandwidth. Premiumize, OffCloud, TorBox, EasyDebrid, RealDebrid, DebridLink, and AllDebrid support torrent caching. SHA1 hashes are fully supported, whereas SHA26 from BitTorrent version 2 have limited support. Multiple hashes can be passed in as an array when making JSON requests. For GET and POST requests, URL arrays can be used: hash[]=hash1 &hash[]=hash2 &hash[]=hash3. | |
item | |
Depends | |
List | |
['1a2b3c4d5e1a2b3c4d5e1a2b3c4d5e1a2b3c4d5e','https://filehoster.com/somefile'] | |
This parameter is the same as the hash and link parameters, except that you can pass both a link and a hash to it. This is useful if you have a mix of torrent and hoster links and want to look them up together. The same requirements of the hash and link options apply. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=debrid&action=lookup&type=all&iditem=SLTG5HFUCENDNF6FCUPJVFJJFXFN5EFF&idstream[]=HCRDQGARE94ALTHCXGMLE6HBHC7UKMRK&idstream[]=DH4TTGMVTHUVHC42WFLNJVCAR7QJGNV7 | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=debrid&action=lookup&type=premiumize,offcloud,torbox&item[]=0807625c6261b0998ebae8eac7132282c8a4ca0e&item[]=https%3A%2F%2Ffilehoster.com%2Fsomefile | |
Response | |
The returned statuses have one of the following values: | |
true: The file is cached with on the debrid server and can be streamed immediately. | |
false: The file is not cached on the debrid server and must be downloaded first. | |
null: The cache status could not be checked, due to problems with the external debrid API, non-URL-encoded links, incorrect hashes, or a other issues with the API request. | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success", | |
type: "debridlookup", | |
description: "Lookup Successful", | |
message: "The debrid cache was successfully looked up." | |
}, | |
data: { | |
lookup: { | |
DH4TTGMVTHUVHC42WFLNJVCAR7QJGNV7: { | |
offcloud: false, | |
premiumize: true, | |
torbox: true | |
}, | |
HCRDQGARE94ALTHCXGMLE6HBHC7UKMRK: { | |
offcloud: false, | |
premiumize: true, | |
torbox: true | |
} | |
}, | |
count: { | |
requested: 2, | |
retrieved: 2 | |
}, | |
requests: { | |
total: 2582793, | |
daily: { | |
limit: 50000, | |
used: 99, | |
remaining: 49901 | |
} | |
} | |
} | |
} | |
Debrid Resolve | |
Resolve a link through an external debrid service. The link is downloaded by the debrid service and if successful, the resolved streaming links are returned. Only files that are cached on the debrid server will resolve immediately. Non-cached files will be added to the debrid downloader, but cannot be resolved until the debrid server has finished downloading the files. | |
Premiumize requires that the public IP address of the device making the API call to Orion must have the same IP address of the device that is streaming the resolved link. Keep this under consideration when the user has multiple devices, internet or VPN connections, or ChromeCasts/AirPlays the link to a different device. | |
Sometimes resolving can take some time, especially with RealDebrid and AllDebrid, since Orion has to make calls to external APIs. The timeout of this API call should be at least 30 seconds, or preferably 60-90 seconds for extreme cases. | |
Although raw links can be resolved, we recommended to use the Orion item ID (movie or episode) and stream IDs instead, since it unlocks additional features for file packs. Both these IDs are returned by the stream search endpoint. | |
This API request should never be made for all available links. Instead, only the link chosen by the user should be resolved on request. Do not scrape a bunch of links and resolve all of them before selecting one for playback. If your app does not have an interactive process for a user to choose a file, or you have to pass direct video streaming links to the media player, use the debridresolve parameter in the stream search endpoint. Doing this will add a unique Orion link to each stream in the results. When the link is visited or played by a media player, Orion automatically resolves the link and makes a HTTP 300 redirect to the actual video file on the debrd server. Hence, links are resolved on demand only when the user starts playback. | |
Requests are subject to the user's daily container limit. Users need at least one debrid account authenticated with Orion. | |
Parameters | |
Name Required Type Options Example Description | |
mode | |
Yes | |
Enum | |
debrid | |
debrid | |
The API mode which should be set to debrid for this query. | |
action | |
Yes | |
Enum | |
resolve | |
resolve | |
The API action which should be set to resolve for this query. | |
keyapp | |
Yes | |
String | |
AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA | |
The app API key. Either use the app and user API keys, or the authentication token. | |
keyuser | |
Yes | |
String | |
BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB | |
The user API key. Either use the app and user API keys, or the authentication token. | |
token | |
Yes | |
String | |
X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2X1Y2 | |
The authentication token. Either use the app and user API keys, or the authentication token. | |
iditem | |
No | |
String | |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX | |
The Orion ID of the movie or episode that the stream belongs to. Either provide an item and stream ID pair, or a link, but not both. Due to additional features, it is recommended to resolve IDs instead of links. | |
idstream | |
No | |
String | |
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY | |
The Orion ID of the stream to be downloaded. Either provide an item and stream ID pair, or a link, but not both. Due to additional features, it is recommended to resolve IDs instead of links. | |
link | |
No | |
String | |
magnet:?xt=urn:btih: b8602f98bf58d1ddcd413ef40ead4aa4853f4b7c | |
The link to be resolved. The link must be URL-encoded if passed as a GET or POST parameter. Either provide an item and stream ID pair, or a link, but not both. Due to additional features, it is recommended to resolve IDs instead of links. | |
type | |
No | |
String | |
user / premiumize / offcloud / torbox / easydebrid / realdebrid / debridlink / alldebrid | |
premiumize | |
The external service to use for the resolving. The user option automatically selects the first available debrid service authenticated by the user. Debrid services that have the file cached will be selected first with the user option. If the file is not cached anywhere, it will be added to the download list of the first available debrid service. | |
output | |
No | |
String | |
list / choice / link / redirect | |
redirect | |
The manner in which the output should be handled. Return alist of all file, links, and their corresponding metadata. One file in the list has a choice attribute which is most likely the file the user would want to play, based on the file name and size. If this parameter is set to choice, only a single link is returned in JSON format. The link option returns the link as raw text instead of JSON. The redirect option resolves the link, picks the preferred file, and then uses a HTTP 300 to automatically redirect to the file on the debrid server for immediate streaming or downloading without any further API interaction. The link and redirect options will return HTTP 4xx or 5xx errors instead of JSON messages if something goes wrong. If the parameter is not provided, the list of resolved files is returned. | |
file | |
No | |
String | |
original / stream / sequential | |
stream | |
Retrieve either the original unprocessed file or the web stream optimized for browsers with limited video and audio codec support. Otherwise choose sequential to first try the web stream and if not available, return the original file. The original file is returned if this parameter is not provided. Premiumize only has web streams if the original file is not already browser supported. RealDebrid web streams can only be accessed through a browser and not through an external media player. OffCloud does not have web stream support. AllDebrid has web streams that are often of lower quality. DebridLink has proper web streams on demand. | |
ip | |
No | |
String | |
12.34.56.78 | |
The IPv4 address of the device that will stream the file. This parameter is only required when resolving through Premiumize and the IP address of the device making this API call is different to the IP address of the device that is streaming the file. Premiumize links are fixed to an IP address and cannot be accessed by other IP addresses. | |
Request | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=debrid&action=resolve&type=user&iditem=SLTG5HFUCENDNF6FCUPJVFJJFXFN5EFF&idstream=HCRDQGARE94ALTHCXGMLE6HBHC7UKMRK | |
API | |
URL: https://api.orionoid.com | |
Body: keyapp=AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&keyuser=BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB&mode=debrid&action=resolve&type=premiumize&link=magnet:?xt=urn:btih:b8602f98bf58d1ddcd413ef40ead4aa4853f4b7c | |
Response | |
Only files in the debrid cache will resolve immediately. Non-cached files can still be added with this API request, but no links will be returned. | |
If the call to the external API fails, the external error message is returned as part of the data object. If the external API call succeeds, a list of files and resolved links is returned. A redirect link is also returned that can be opened by the user in a browser to show the debrid download list. Each file object contains the following attributes: | |
original: The original full-quality and untouched file. Files always have an original attribute. | |
stream: The web stream converted from the original file. Web streams are optimized for browsers which have limited video and audio codec support. Stream files are also typically smaller and saves bandwidth. Premiumize fully supports web streams but sometimes does not convert certain file types. RealDebrid web streams do not point to video files and can therefore only be played in a browser. OffCloud does not have web stream support. AllDebrid has web streams that are often of lower quality. DebridLink has proper web streams on demand. | |
choice: One file in the list might have a choice attribute indicating that this is most likely the file the user wants to play. Some torrents and usenet containers have multiple video files, such as show/season packs or bonus content. If you do not want to write custom code for choosing the correct file using the file name, you can just scan through the list for the first file that has a choice attribute. For this to work, the API call has to be initiated with the item and stream IDs. If raw links are resolved, there is not enough info to make a choice between files. | |
File sizes will show as 0 if the external debrid server does not know the size. | |
{ | |
name: "Orion API", | |
version: "4.0.0", | |
result: { | |
status: "success", | |
type: "debridresolve", | |
description: "Link Resolved", | |
message: "The link was successfully added to the Premiumize downloader and resolved." | |
}, | |
data: { | |
redirect: https://www.premiumize.me/transfers, | |
files: [ | |
{ | |
original: { | |
size: 2979745876, | |
name: "Avatar.2009.EXTENDED.1080p.BluRay.x265-RARBG.mkv", | |
link: https://cdn.com/dl/Avatar.2009.EXTENDED.1080p.BluRay.x265-RARBG.mkv, | |
type: "video/x-matroska", | |
extension: "mkv", | |
category: "video" | |
}, | |
stream: { | |
size: 0, | |
name: "Avatar.2009.EXTENDED.1080p.BluRay.x265-RARBG.mkv.mp4", | |
link: https://cdn.com/dl/Avatar.2009.EXTENDED.1080p.BluRay.x265-RARBG.mkv.mp4, | |
type: "video/mp4", | |
extension: "mp4", | |
category: "video" | |
}, | |
choice: true | |
}, | |
{ | |
original: { | |
size: 109009, | |
name: "31_English.srt", | |
link: https://cdn.com/dl/31_English.srt, | |
type: "application/x-subrip", | |
extension: "srt", | |
category: "subtitle" | |
} | |
}, | |
{ | |
original: { | |
size: 30, | |
name: "RARBG.txt", | |
link: https://cdn.com/dl/RARBG.txt, | |
type: "text/plain", | |
extension: "txt", | |
category: "text" | |
} | |
} | |
] | |
} | |
} | |
General API |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment