{"openapi":"3.1.0","info":{"title":"EmiMine API","description":"National data and organisation-scoped data for the EmiMine platform. Authenticate with an API key (Authorization: Bearer emk_live_...). National data endpoints are open; organisation endpoints need a key.","version":"3.1.0-dev"},"paths":{"/api/v1/national/summary":{"get":{"tags":["National data"],"summary":"Headline figures for Ghana","description":"Footprint, label shares, NID1 comparison and levers (profile ghamem-1.1), with bundle provenance.","operationId":"summary_api_v1_national_summary_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Summary Api V1 National Summary Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/national/series":{"get":{"tags":["National data"],"summary":"Annual series by component","description":"Median and 95% range per component and year. profile: ghamem-1.1 (footprint) or land-0.2 (inventory-pool land).","operationId":"series_api_v1_national_series_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"profile","in":"query","required":false,"schema":{"type":"string","default":"ghamem-1.1","title":"Profile"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Series Api V1 National Series Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/national/categories":{"get":{"tags":["National data"],"summary":"Inventory categories and label status","operationId":"categories_api_v1_national_categories_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Categories Api V1 National Categories Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/national/land":{"get":{"tags":["National data"],"summary":"Mining land clearance 2001-2024 (land-0.2)","operationId":"land_api_v1_national_land_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Land Api V1 National Land Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/factors":{"get":{"tags":["National data"],"summary":"Calculator factor library","operationId":"factor_library_api_v1_factors_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Factor Library Api V1 Factors Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/schema/disclosure":{"get":{"tags":["Open"],"summary":"Ten-field disclosure JSON Schema","operationId":"disclosure_json_schema_api_v1_schema_disclosure_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Disclosure Json Schema Api V1 Schema Disclosure Get"}}}}}}},"/api/v1/disclosures/published":{"get":{"tags":["Open"],"summary":"Published mine disclosures","operationId":"published_api_v1_disclosures_published_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Published Api V1 Disclosures Published Get"}}}}}}},"/api/v1/org":{"get":{"tags":["Organisation data"],"summary":"The organisation this key belongs to","operationId":"org_api_v1_org_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Org Api V1 Org Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/sites":{"get":{"tags":["Organisation data"],"summary":"Sites","operationId":"sites_api_v1_sites_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Sites Api V1 Sites Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/sites/{site_id}/inventories":{"get":{"tags":["Organisation data"],"summary":"Inventories of a site","operationId":"site_inventories_api_v1_sites__site_id__inventories_get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"integer","title":"Site Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":true},"title":"Response Site Inventories Api V1 Sites  Site Id  Inventories Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Organisation data"],"summary":"Create or update a draft inventory","description":"Creates the year's inventory, or replaces the activity data of a draft one, and returns the calculated results.","operationId":"put_inventory_api_v1_sites__site_id__inventories_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"site_id","in":"path","required":true,"schema":{"type":"integer","title":"Site Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Put Inventory Api V1 Sites  Site Id  Inventories Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/inventories/{inventory_id}":{"get":{"tags":["Organisation data"],"summary":"One inventory with every line","operationId":"inventory_api_v1_inventories__inventory_id__get","security":[{"HTTPBearer":[]}],"parameters":[{"name":"inventory_id","in":"path","required":true,"schema":{"type":"integer","title":"Inventory Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Inventory Api V1 Inventories  Inventory Id  Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/scenarios":{"get":{"tags":["Organisation data"],"summary":"Decarbonisation scenarios","operationId":"scenarios_api_v1_scenarios_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Scenarios Api V1 Scenarios Get"}}}}},"security":[{"HTTPBearer":[]}]}},"/api/v1/disclosures/own":{"get":{"tags":["Organisation data"],"summary":"The organisation's disclosures","operationId":"own_disclosures_api_v1_disclosures_own_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response Own Disclosures Api V1 Disclosures Own Get"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InventoryIn":{"properties":{"year":{"type":"integer","maximum":2100.0,"minimum":2000.0,"title":"Year"},"activity":{"additionalProperties":{"type":"number"},"type":"object","title":"Activity","description":"Activity data by key, as on the calculator form (for example diesel_mobile in litres)."},"params":{"additionalProperties":{"type":"number"},"type":"object","title":"Params"}},"type":"object","required":["year","activity"],"title":"InventoryIn"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBearer":{"type":"http","description":"An EmiMine API key, created by an organisation administrator.","scheme":"bearer"}}}}