Skip to main content

curl --request POST 'https://api-v2.production.higg.org/api/v1/moduledata/fem' \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --header 'x-api-key: <<apiKey>>' \
     --header 'x-developer-request-token: <<apiKey>>' \
     -d '{
    "include": [
        "performance.annual_prod_vol_amount",
        "performance.annual_prod_vol_units",
        "performance.total_ghg_kgco2e",
        "performance.total_non_renewable_ghg_kgco2e",
        "performance.ghg_electricpurch_kgco2e",
        "performance.water_municipal_l",
        "performance.total_water_l",
        "performance.total_waste_kg",
        "performance.nonhazardous_waste_materials_kg",
        "performance.nonhazardous_waste_plastic_kg",
        "performance.nonhazardous_waste_paper_kg",
        "performance.nonhazardous_waste_cans_kg",
        "performance.nonhazardous_waste_food_kg",
        "performance.hazardous_waste_prodchemdrum_kg",
        "performance.hazardous_waste_dominkcart_kg",
        "performance.total_fem_score",
        "performance.total_air_score",
        "performance.total_chemicals_score",
        "performance.total_ems_score",
        "performance.total_energy_score",
        "performance.total_waste_score",
        "performance.total_wastewater_score",
        "performance.air_levels_achieved",
        "performance.chemicals_levels_achieved",
        "performance.ems_levels_achieved",
        "performance.energy_levels_achieved",
        "performance.water_levels_achieved",
        "performance.wastewater_levels_achieved",
        "performance.waste_levels_achieved"
    ],
    "from": 0,
    "size": 1
}'
{
    "from": 0,
    "size": 1,
    "total": 173,
    "assessments": [
        {
            "id": "5a0a80a704696d7ff49f53d4",
            "statusHistory": {
                "NS": "2017/11/14",
                "ASI": "",
                "ASC": "2019/02/15",
                "VRP": "2019/02/08",
                "VRQ": "",
                "VRE": "",
                "VRC": "",
                "VRF": "2019/02/15",
                "VRD": "",
                "VRI": "",
                "ASD": ""
            },
            "status": "VRF",
            "version": "fem2017",
            "accountId": "5a0a80a7d706617ffac1b2e4",
            "accountName": "Jast PLC",
            "sacId": 1743,
            "country": "UK",
            "selfPosted": true,
            "verifiedPosted": true,
            "verified": true,
            "lastUpdated": 1550269735736,
            "location": {
                "address": "98 Witney Way, KNAYTON YO7 4ET UK",
                "vicinity": "",
                "country": "UK",
                "placeid": "",
                "lat": 53.953485,
                "long": -0.975784
            },
            "oarId": "",
            "taxId": "",
            "socialCreditId": "",
            "performance": {
                "annual_prod_vol_amount": 5003408,
                "annual_prod_vol_units": "Meter",
                "total_ghg_kgco2e": 301277.1982732697,
                "total_non_renewable_ghg_kgco2e": 301277.1982732697,
                "ghg_electricpurch_kgco2e": 301277.1982732697,
                "water_municipal_l": 522000,
                "total_water_l": 522000,
                "total_waste_kg": 8118,
                "nonhazardous_waste_materials_kg": 4288,
                "nonhazardous_waste_plastic_kg": 1314,
                "nonhazardous_waste_paper_kg": 1416,
                "nonhazardous_waste_cans_kg": 180,
                "nonhazardous_waste_food_kg": 814,
                "hazardous_waste_prodchemdrum_kg": 46,
                "hazardous_waste_dominkcart_kg": 60,
                "total_fem_score": 40.046190476190475,
                "total_air_score": 60,
                "total_chemicals_score": 18.240000000000002,
                "total_ems_score": 93.75,
                "total_energy_score": 75,
                "total_waste_score": 25.000000000000004,
                "total_wastewater_score": 8.333333333333334,
                "air_levels_achieved": [
                    1,
                    2,
                    3
                ],
                "chemicals_levels_achieved": [],
                "ems_levels_achieved": [
                    1,
                    2
                ],
                "energy_levels_achieved": [
                    1,
                    2
                ],
                "water_levels_achieved": [],
                "wastewater_levels_achieved": [],
                "waste_levels_achieved": [
                    1
                ]
            }
        }
    ]
}

Set your API token

Identify the performance data you want

Performance data is normalized across years. For a complete list of data fields available, see /v1.0/docs/fem-data-dictionary#performance