Wiki logo

OrangeFox Wiki

WikiMD Playground

OrangeFox Recovery API

Last updated: December 4, 2025

V5 OrangeFox API changes

This release was intended to fix issues migrating from V3 API, it introduced
_id
legacy field in the
/updates
endpoint. Additionally, the global public statistics were added. Lastly, from now on, the API is rate limited.

V4 OrangeFox API changes

Please check out its swagger for notes and documentation - https://api.orangefox.download/redoc The new OrangeFox is almost completely backwards compatible, except these:

Removed

  • Users/maintainers endpoints removed
  • Releases sorting modes removed

Added

  • archived
    releases support
  • build_id
    releases support

Endpoints deprecations

  • *
    /devices/get
    and
    /releases/get
    are depreacted *
  • /updates/
    is deprecated, please use
    /releases/?after_release_id=
    as a drop-in replacement instead.

Parameters deprecations

  • _id
    parameters was changed to
    id
    eveywhere to ensure consistency, the old ones wasn't removed thought for compatiblity reasons and considered deprecated/
  • /releases/?codename=
    is depreacted, please use device ID instead
  • /devices/?model_name=
    is depreacted, please use device ID or codename instead

JSON Body response model deprecations

  • _id
    parameters was changed to
    id
    eveywhere to ensure consistency, the old ones wasn't removed thought for compatiblity reasons and considered deprecated.
  • model_name
    and
    codename
    for both
    /devices
    and
    /devices/<id>
    endpoints are depreacted. We are introduced
    model_names
    and
    codenames
    which would contain multiple items in future.
  • size
    in
    /release/<id>
    is deprecated
Current API docs

API Libraries

{.links-list}

Example of using plain OrangeFox API in projects

name | language
OrangeFox Android App | Java old OrangeFox downloads website (dSite) | NodeJS / React old OrangeFox web flasher (ToyBox) | NodeJS / React OrangeFox web monorepo (new downloads website + admin dashboard) | NodeJS / React

Example of using official API libraries

OrangeFox Telegram bot (oBot) | Python (old/deprecated Python library)

Third-party

Notes

Special mirror names and its definitions

By using
/release/{id}
method you will see a mirrors field, it contains download mirrors, usually they are named in the Alpha 2 (ISO 3166) way (for example
US
and
NL
), but there is some reserved named with other definition:
  • DL: Global mirror 🌎
  • AR: Archieve 🗃