About this site · Updated 2026-10-28
Developers and API
Public firmware data endpoints, sitemaps and RSS feeds from Hyper ROM, including the device catalog, per-device detail, dataset metadata, field structures, caching guidance and attribution requirements.
Three public data endpoints are available: /data/catalog.json for the device catalog, /api/device.php?code={codename} for a single device, and /data/meta.json for dataset metadata. An RSS feed at /feed.xml and llms.txt are provided for aggregators and AI retrieval.
Public endpoints
| Endpoint | Description | Cache |
|---|---|---|
| /data/catalog.json | Device summary, system distribution and recent-update flags | 2 minutes |
| /api/device.php?code={codename} | All branches and builds for one device | 5 minutes |
| /data/meta.json | Data commit, sync time and statistics | 1 minute |
| /api/geo-questions.json | Fixed question set used for AI citation checks | 1 hour |
| /feed.xml | RSS feed of recent firmware updates | 5 minutes |
| /llms.txt | Site structure and data notes for AI retrieval | 1 hour |
| /sitemap.xml | Sitemap index | 1 hour |
Device detail fields
| Field | Type | Description |
|---|---|---|
| code | string | Device codename |
| name | object | Device name in Chinese and English |
| branches[].region | string | Region code (cn / global / eea …) |
| branches[].name | object | Branch display name |
| branches[].roms[] | array | Builds in that branch |
| roms[].version | string | Build number |
| roms[].release | string | Release date, YYYY-MM-DD |
| roms[].recovery | string | Recovery package file name |
| roms[].fastboot | string | Fastboot package file name |
Usage guidelines
- The endpoints are read-only GET requests with no authentication. Do not poll aggressively; cache for at least 5 minutes.
- Link to the official CDN URLs shown on the page instead of mirroring or re-uploading files.
- Credit HegeKen/HyperData and this page when reusing the data.
- For bulk access, start from /sitemap.xml and /data/catalog.json rather than crawling every page.
Frequently asked questions
Is there a rate limit?
No hard limit is enforced at the moment, but keep request rates reasonable and cache responses. Staying under 30 requests per minute per IP is recommended.
Can the data be used commercially?
The data comes from an open-source project, so read the upstream licence first. Firmware files remain the property of Xiaomi.