Developers
API
Versioned, machine-readable access to the same records the site presents. Open datasets are readable without a key.
Base URL
https://qinmetrics.com/api/v1
Versioning
The version is in the path. Response shapes under /api/v1 do not change incompatibly; incompatible changes ship as /api/v2 with an overlap period, and retirements are announced on this page in advance.
Response shape
Every response is a JSON object with a data field. List endpoints add a meta object with page, pageSize and total, and accept page, pageSize and q query parameters.
{
"data": [ ... ],
"meta": { "page": 1, "pageSize": 25, "total": 0 }
}Endpoints
| Path | Description |
|---|---|
| /api/v1/health | Service status and the active data source. |
| /api/v1/datasets | The dataset catalogue; filter with scope=global or scope=china. |
| /api/v1/datasets/{slug} | One dataset with its releases. |
| /api/v1/organizations | Organisations; filter with role, kind, scope and q. |
| /api/v1/organizations/{slug} | One organisation with its profile: counts and values as buyer and as supplier. |
| /api/v1/tenders | Procurement processes; filter with scope, status, buyer and q. |
| /api/v1/tenders/{slug} | One procurement process. |
| /api/v1/contracts | Contracts; filter with scope, status, type, buyer, supplier and q. |
| /api/v1/contracts/{slug} | One contract with its payments and events. |
| /api/v1/fiscal/indicators | Fiscal indicators; filter with scope and q. |
| /api/v1/fiscal/indicators/{slug} | One indicator with the periods available. |
| /api/v1/fiscal/indicators/{slug}/observations | Observations for one indicator; filter with jurisdiction, from and to. |
| /api/v1/search?q= | Cross-entity search; q is required. |
Example
curl "https://qinmetrics.com/api/v1/datasets?scope=china"
Rate limits and keys
No key is required for open datasets. Rate limits and API keys will be introduced with the registered access tier and announced here before they take effect.
Citing API data
Cite the dataset and release version returned in the response, together with the retrieval date. See the methodology for the citation format. Methodology