API
Read the index programmatically · open JSON · version 3.1.0
Overview
The Optional Work Index is readable as open JSON. No key is required for read access.
Access-Control-Allow-Origin
is open. Country codes are ISO 3166-1 alpha-3 (the European Union is the bloc code EUU).
Endpoints
base · https://owindex.com
| Resource | Request | Returns |
|---|---|---|
| Country | /api/?country=CHN |
Full result for one country: OWI, supply, demand, sub-indices, coverage. |
| Category | /api/?category=5a |
Roll-up for one tier: average OWI, supply and demand, and the member list with range. |
| Snapshot | /api/?all=1 |
Light score (OWI, supply, demand) for every country. Served from the precomputed snapshot. |
| Default | /api/ |
Equivalent to country=USA. |
Example
Request
fetch("https://owindex.com/api/?country=CHN")
.then(r => r.json())
.then(d => console.log(d.owi, d.supply_score, d.demand_score));
.then(r => r.json())
.then(d => console.log(d.owi, d.supply_score, d.demand_score));
Response (abridged)
{
"ok": true,
"iso3": "CHN",
"owi": 0.0,
"supply_score": 0.0,
"demand_score": 0.0,
"combine": "geometric",
"sub_indices": { ... },
"coverage": { "supply": 3, "demand": 2, ... },
"version": "3.1.0"
}
"ok": true,
"iso3": "CHN",
"owi": 0.0,
"supply_score": 0.0,
"demand_score": 0.0,
"combine": "geometric",
"sub_indices": { ... },
"coverage": { "supply": 3, "demand": 2, ... },
"version": "3.1.0"
}
Fields
| Field | Meaning |
|---|---|
| owi | Combined index, geometric mean of the two sides, 0 to 100. |
| supply_score | Supply side: can machines do the work. |
| demand_score | Demand side: can people afford to stop. |
| sub_indices | The five sub-index scores, each with components and side weight. |
| coverage | How many inputs on each side came from primary data. |
| combine | Always "geometric"; the method used to combine the two sides. |
Use and limits
Read access is open and free for research and public-interest use; please attribute figures to the Optional Work Index.