Compatibility data API
Published
The compatibility data API serves the explorer’s feature data as JSON at the same URLs as the pages. You can fetch it directly from a browser: responses carry Access-Control-Allow-Origin: *. It requires no key or signup and has no rate limit.
Use the data in a build-target checker, linter, editor plugin, dashboard, or answer engine that needs to answer “can I use X in a PWA”.
Start here
Section titled “Start here”curl https://openpwa.net/compatibility/index.jsonThe index lists every feature with its category, provenance, and a data_url:
{ "name": "OpenPWA compatibility dataset", "licence": "CC BY 4.0", "attribution": "OpenPWA — https://openpwa.net", "count": 61, "features": [ { "slug": "web-share", "name": "Web Share API", "category": "Capabilities", "confidence": "high", "verified_at": "2026-10-03", "support_rows": 9, "data_url": "https://openpwa.net/compatibility/web-share.json", "page_url": "https://openpwa.net/compatibility/web-share/" } ]}page_url is null when a dataset has been published but its prose entry has not,
so it does not link to a 404.
Endpoints
Section titled “Endpoints”| Endpoint | What it returns |
|---|---|
/compatibility/index.json |
Every feature: category, provenance, data_url, page_url |
/compatibility/{slug}.json |
One feature: support rows, ecosystem-policy rows, provenance |
/compatibility/by-country.json |
Country-weighted effective reach per feature, per region |
A single feature
Section titled “A single feature”curl https://openpwa.net/compatibility/web-nfc.jsonEach record carries the spec and MDN URLs, a confidence grade, and the verified_at
date the row was last checked. Use these to assess the evidence for a support value.
confidence is computed from each row’s source (high for a row generated from a
browser-compat-data entry, medium for a vendor document or release note, low for
anything else), and a feature’s grade is its weakest row. Every row that cites a
browser-compat-data file is also cross-checked against the live BCD file on each
deploy; a row that disagrees with the source it cites, or cites a path that no longer
resolves, blocks the deploy.
biz_compat records whether ad networks, payment providers, and app stores accept a
capability in production. Sponsored rows are
flagged with sponsored: true and do not change an editorial support value.
Country-weighted reach
Section titled “Country-weighted reach”curl https://openpwa.net/compatibility/by-country.jsonreach is computed at build time from support × browser market share; it is not
stored by hand. Each region carries its market-share source, source_url, and as_of
date, and the payload states the derivation method so you can reproduce or reject it.
It is an approximate, weighted estimate; no measurement is involved.
The shares are StatCounter Global Stats browser market share, all platforms, for the month in
as_of (2026-09 at the October 2026 refresh). Each region also carries its grouped shares, the
CSV data_url they were read from, retrieved_at, and source_licence (CC BY-SA 3.0). The
payload’s reach_data_licence is CC BY-SA 4.0 with the attribution to use; the support data
inside it keeps the CC BY 4.0 terms below (support_data_licence).
Using it in a page
Section titled “Using it in a page”const { features } = await fetch( 'https://openpwa.net/compatibility/index.json',).then((r) => r.json());
const webShare = await fetch( features.find((f) => f.slug === 'web-share').data_url,).then((r) => r.json());
console.log(webShare.support, webShare.verified_at);Licence
Section titled “Licence”The dataset is CC BY 4.0. Use it commercially, modify it, redistribute it; the one condition is attribution:
Data: <a href="https://openpwa.net">OpenPWA</a>,<a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a>The index and per-feature payloads carry licence, licence_url, attribution, and
attribution_html, so a consumer can render the credit without hard-coding it.
by-country.json carries the same block as support_data_licence; its reach figures are
not covered (see above).
Stability
Section titled “Stability”Feature slugs are stable: a slug is the dataset’s identity, and the build fails if one
stops matching its source file. Fields are added, not removed or repurposed. Data is
rebuilt on publish, so verified_at on a row tells you when a human last checked that
row, not when the file was regenerated.
Report an incorrect value with a source for the correction.
← Back to the Compatibility explorer.