Developers
EmiMine API
JSON over HTTPS. National data endpoints are open (CC BY 4.0); organisation endpoints need an API key created by an administrator.
Authentication
Send your key as a bearer token. Keys are shown once when created and stored only as a hash. Version 3.1.0-dev.
curl -H "Authorization: Bearer emk_live_xxxxxxxx_..." https://emimine.ncelknust.org/api/v1/sitescurl https://emimine.ncelknust.org/api/v1/national/summaryNational data
| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /api/v1/national/summary | Headline figures for Ghana Footprint, label shares, NID1 comparison and levers (profile ghamem-1.1), with bundle provenance. | None |
| GET | /api/v1/national/series | Annual series by component Median and 95% range per component and year. profile: ghamem-1.1 (footprint) or land-0.2 (inventory-pool land). | None |
| GET | /api/v1/national/categories | Inventory categories and label status | None |
| GET | /api/v1/national/land | Mining land clearance 2001-2024 (land-0.2) | None |
| GET | /api/v1/factors | Calculator factor library | None |
Open
| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /api/v1/schema/disclosure | Ten-field disclosure JSON Schema | None |
| GET | /api/v1/disclosures/published | Published mine disclosures | None |
Organisation data
| Method | Path | What it does | Access |
|---|---|---|---|
| GET | /api/v1/org | The organisation this key belongs to | Key |
| GET | /api/v1/sites | Sites | Key |
| GET | /api/v1/sites/{site_id}/inventories | Inventories of a site | Key |
| POST | /api/v1/sites/{site_id}/inventories | Create or update a draft inventory Creates the year's inventory, or replaces the activity data of a draft one, and returns the calculated results. | Key |
| GET | /api/v1/inventories/{inventory_id} | One inventory with every line | Key |
| GET | /api/v1/scenarios | Decarbonisation scenarios | Key |
| GET | /api/v1/disclosures/own | The organisation's disclosures | Key |