Skip to content

Latest commit

 

History

History
114 lines (81 loc) · 6.77 KB

API.md

File metadata and controls

114 lines (81 loc) · 6.77 KB

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

Note

See CALENDARS.md for calendar endpoint information.

  • /bypass/ - jailbreak detection bypasses for 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
  • /group/ - information on 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
  • /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.

2025-09-16

  • Add signed to all *OS firmwares that Apple is still signing. This is either an array of devices for which the build is still signed or true meaning all devices are signed. Absence of this value means the build is completely unsigned. Note that this uses IPSW build manifests, where available, for iOS, iPadOS, bridgeOS, macOS, and visionOS, and falls back to OTA build manifests in all other cases.

2025-09-12

  • Add buildId and systemImageId to *OS firmwares, where applicable. buildId mirrors BuildID and systemImageId mirrors SystemImageID from /System/Library/CoreServices/SystemVersion.plist. buildId is a top level firmware key, while systemImageId is per source (as it differs between root FS images).

Warning

This information is incomplete and still in the process of being added (it is mostly only present for firmwares with unencrypted OTAs, and excludes deltas). Check for key presence before usage.

2025-03-12

  • Add calendar endpoints

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