API v2 released 26 April 2020
API v2.2 released 16 July 2020
API v2.3 released 2 August 2020
API URL - https://api.orangefox.download/v2
All requests is only POST yet.
API output is always JSON except for 404 situations.
/: redirects to this page/ping: Will return 'PONG' if API is working/api: Will show information about API and its version/oem: List of available OEMs/oem/<oem_name>: List of devices by that OEM/oem/<oem_name>/releases: List of releases under that OEM/oem/<oem_name>/releases/<release_type>: Same as above but filters only special type/device: Show list of devices (incl. codename, fullname and oem)/device/<codename>: Gets device info/device/releases: Will show list of devices which have releases/device/releases/<release_type>: Same as above but filters only special type/releases/<release_id>: Get release by its ID/release/last: Get latest release/release/<release_type>/last: Get latest release with special release type/device/<codename>/releases: List of avaible releaes for specific device/device/<codename>/releases/last: Get latest release for specific device/device/<codename>/releases/<release_type>: List of avaible releaes for specific device with special release type/device/<codename>/releases/<release_type>/last: Get latest release info by selected release type for specific device/device/<codename>/releases/<release_type>/<version>: Get version by its version variable for specific device/releases/updates/<release_id or unixtime>: Will give all releases after given option, for example if you will add unixtime there, API will return you all releases which made after that time./device/<codename>/releases/updates/<release_id or unixtime>: Same as above, but will filter for specific device only/device/<codename>/releases/<build_type>/updates/<release_id or unixtime>: Same as above, but also will filter for release type.oem_name: Name of OEM, example is 'Xiaomi'codename: Codename of device, example is 'lavender'release_type: Release type, can be 'stable', 'beta' or 'any'version: Version of release, example is 'R11.0_2'release_id: Unique ID of release, can be found by gettings its release/api{ "api":{
"documentations":"https://wiki.orangefox.tech/dev/api",
"status":"ok",
"version":"v2.2"
}
}
/oem["Asus","General","LG","Lenovo","Meizu","Motorola","Realme","Samsung","Wileyfox","Xiaomi"]
/oem/XiaomiThis method can have
only_codenamesargument!
[
{
"_id":"5e5fd987b64ceb812d16a663",
"codename":"libra",
"fullname":"Xiaomi Mi 4C",
"modelname":"Mi 4C",
"oem":"Xiaomi"
},
{
"_id":"5e5fd988b64ceb812d16a6b4",
"codename":"sagit",
"fullname":"Xiaomi Mi 6",
"modelname":"Mi 6",
"oem":"Xiaomi"
},
...
]
/oem/Xiaomi?only_codenames=True["libra","sagit","wayne","dipper", ...]
/deviceThis method can have
only_codenamesargument!
[
{
"_id":"5e59825977c93477b29eadb7",
"codename":"x00t",
"fullname":"Asus ZenFone Max Pro M1",
"modelname":"ZenFone Max Pro M1",
"oem":"Asus"
},
{
"_id":"5e59825877c93477b29ead1e",
"codename":"z00ed",
"fullname":"Asus Zenfone 2 Laser ZE500KL",
"modelname":"Zenfone 2 Laser ZE500KL",
"oem":"Asus"
},
{
"_id":"5e59825a77c93477b29eae4d",
"codename":"zenfone3",
"fullname":"Asus Zenfone 3",
"modelname":"Zenfone 3",
"oem":"Asus"
},
...
]
/device?only_codenames=True["x00t","z00ed","zenfone3","x01ad","x01bd", ...]
/device/<codename>{
"_id":"5e59825977c93477b29eae02",
"codename":"lavender",
"fullname":"Xiaomi Redmi Note 7",
"maintained":1,
"maintainer":{
"name":"DarthJabba9/Yacha"
},
"modelname":"Redmi Note 7",
"oem":"Xiaomi"
}
maintained parameter/device/releasesThis method can have
only_codenamesargument!
[
{
"_id":"5e59825977c93477b29eadb7",
"codename":"x00t",
"fullname":"Asus ZenFone Max Pro M1",
"modelname":"ZenFone Max Pro M1",
"oem":"Asus"
},
{
"_id":"5e59825877c93477b29ead1e",
"codename":"z00ed",
"fullname":"Asus Zenfone 2 Laser ZE500KL",
"modelname":"Zenfone 2 Laser ZE500KL",
"oem":"Asus"
},
{
"_id":"5e59825a77c93477b29eae4d",
"codename":"zenfone3",
"fullname":"Asus Zenfone 3",
"modelname":"Zenfone 3",
"oem":"Asus"
},
...
]
/device/releases?only_codenames=True["mido","sagit","chiron","riva","j5xnlte", ...]
/device/wayne/releases/stable/R10.1_1
sfparameter can not exits! You should cover it in your code
{
"_id":"5e5a6f7c77c93477b2bff0ef",
"build_type":"stable",
"changelog":"- Fixed all the bugs that were in the previous version\r\n- Updated kernel",
"codename":"wayne",
"date":"Sat, 29 Feb 2020 12:04:56 GMT",
"file_name":"OrangeFox-R10.1_1-Stable-wayne.zip",
"md5":"122c7eb74a3b834aee9ed7da9b874044",
"sf":{
"path":"wayne/OrangeFox-R10.1_1-Stable-wayne.zip",
"url":"https://sourceforge.net/projects/orangefox/files/wayne/OrangeFox-R10.1_1-Stable-wayne.zip"
},
"size_bytes":43958924,
"size_human":"42MB",
"unixtime":1582977896,
"url":"https://files.orangefox.tech/OrangeFox-Stable/wayne/OrangeFox-R10.1_1-Stable-wayne.zip",
"version":"R10.1_1"
}
/releases/updates/1582977896This method can have
only_idsargument!
[
{
"_id":"5e5a930177c93477b2c55f09",
"build_type":"stable",
"changelog":"- Fixed zip queue",
"codename":"chiron",
"date":"Sat, 29 Feb 2020 14:36:56 GMT",
"file_name":"OrangeFox-R10.1_1_non_sar-Stable-chiron.zip",
"md5":"595c6166d6332804910178d3a0c01da1",
"notes":"- non system-as-root build (NON-SaR)",
"sf":{
"path":"chiron/OrangeFox-R10.1_1_non_sar-Stable-chiron.zip",
"url":"https://sourceforge.net/projects/orangefox/files/chiron/OrangeFox-R10.1_1_non_sar-Stable-chiron.zip"
},
"size_bytes":49885735,
"size_human":"48MB",
"unixtime":1582987016,
"url":"https://files.orangefox.tech/OrangeFox-Stable/chiron/OrangeFox-R10.1_1_non_sar-Stable-chiron.zip",
"version":"R10.1_1_non_sar"
},
{
"_id":"5e5a955a77c93477b2c5b463",
"build_type":"stable",
"changelog":"- Fixed zip queue",
"codename":"chiron",
"date":"Sat, 29 Feb 2020 14:46:56 GMT",
"file_name":"OrangeFox-R10.1_1_sar-Stable-chiron.zip",
"md5":"bf145bdbb6953c71c6dd470fbaa182a1",
"notes":"- system-as-root build (SaR)",
"sf":{
"path":"chiron/OrangeFox-R10.1_1_sar-Stable-chiron.zip",
"url":"https://sourceforge.net/projects/orangefox/files/chiron/OrangeFox-R10.1_1_sar-Stable-chiron.zip"
},
...
]
/releases/updates/1582977896?only_ids=True["5e5a930177c93477b2c55f09","5e5a955a77c93477b2c5b463","5e5abdad77c93477b2cbcfbd", ...]