API v2
Last updated: August 7, 2026
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.Available methods
- /: redirects to this page
- /ping: Will return 'PONG' if API is working
- /api: Will show information about API and its version {.grid-list}
Devices
- /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 {.grid-list}
Releases
- /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 {.grid-list}
Updates
- /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. {.grid-list}
Variables
- 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 {.grid-list}
Examples
/api
Loading...
/oem
Loading...
/oem/Xiaomi
This method can have
only_codenames
argument!Loading...
/oem/Xiaomi?only_codenames=True
Loading...
/device
This method can have
only_codenames
argument!Loading...
/device?only_codenames=True
Loading...
/device/<codename>
Loading...
About
maintained
parameter
- 1: Maintained
- 2: Maintained without having device on hands
- 3: Unmaintained {.grid-list}
/device/releases
This method can have
only_codenames
argument!Loading...
/device/releases?only_codenames=True
Loading...
/device/wayne/releases/stable/R10.1_1
sf
parameter can not exits! You should cover it in your codeLoading...
/releases/updates/1582977896
This method can have
only_ids
argument!Loading...
/releases/updates/1582977896?only_ids=True
Loading...
{.grid-list}