API.md

AppleDB API Usage

The AppleDB API is located on api.appledb.dev and hosted from the gh-pages branch of this repo.

All requests should be GET requests, this API is currently just static data.

URLs are case sensitive.

Structure

• /bypass/ - jailbreak detection bypasses for apps
  • /bypass/index.json - list all bundle IDs where information is available
  • /bypass/<bundle id>.json (example) - information on a specific app's jailbreak detection bypass
  • /bypass/main.json (.gz/.xz) - contains information for all apps
• /compat/ - jailbreak compatibility information for devices
  • /compat/<key>/ - compatibility information for a specific device
    • /compat/<key>/<build>.json (example) - compatibility information for a specific build and device
• /device/ - information on devices
  • /device/index.json - list of all keys
  • /device/<key>.json (example) - information on a specific device
  • /device/main.json (.gz/.xz) - contains information for all devices
• /group/ - information on device groups
  • /group/index.json - list of all keys
  • /group/<key>.json (example) - information on a specific device group
  • /group/main.json (.gz/.xz) - contains information for all device groups
• /ios/ - information on OS versions (not just iOS)
  • /ios/index.json - list of all keys (<osStr>;<build>)
  • /ios/<osStr>;<build>.json (example) - information on a specific OS build
  • /ios/main.json (.gz/.xz) - contains information for all OS builds
  • /ios/<osType>/ - information for a specific OS
    • /ios/<osType>/index.json (example) - list of all keys for a specific OS, relative to the /ios/ path
    • /ios/<osType>/main.json (example (.gz/.xz)) - contains information for all OS builds for a specific OS
  • Note: <osStr> is the marketing name of the operating system (ie. Mac OS X, OS X, macOS), while <osType> is an AppleDB-determined name that does not change with marketing changes (ie. macOS)
    • Endpoints using <osType> may change to using <osStr> in the future
• /jailbreak/ - information on jailbreaks
  • /jailbreak/index.json - list of all jailbreaks
  • /jailbreak/<name>.json (example) - information on a specific jailbreak
  • /jailbreak/main.json (.gz/.xz) - contains information for all jailbreaks
• /main.json (.gz/.xz) - contains information for all endpoints, excluding jailbreak compatibility information

API Changelog

To stay updated on changes to the API (and AppleDB development in general), you can join our Discord.

2024-03-01

• Remove iosVersion and sortVersion

2024-02-01

• Add compressed endpoints for main.json

Important

With the previous iteration of the API, OTAs were stripped from all endpoints to deal with space issues. With this iteration of the API, OTAs are only stripped from the uncompressed main.json endpoints. This is a stopgap until we can figure out how to deal with this issue and make OTAs available on all endpoints.

2023-09-13

• Initial version of this document