Skip to main content
curl --request POST \
     --url 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": [
        "ghg"
    ],
    "version": "fem2022",
    "verified": true,
    "from": 0,
    "size": 4
}'
{
    "from": 0,
    "size": 10,
    "total": 4,
    "assessments": [
        {
            "id": "REDACTED",
            "statusHistory": {
                "NS": "",
                "ASI": "",
                "ASC": "",
                "VRP": "",
                "VRQ": "",
                "VRE": "",
                "VRC": "",
                "VRF": "",
                "VRD": "",
                "VRI": "",
                "ASD": ""
            },
            "status": "NS",
            "version": "fem2022",
            "accountId": "REDACTED",
            "accountName": "REDACTED",
            "sacId": REDACTED,
            "country": "United States",
            "selfPosted": false,
            "verifiedPosted": false,
            "verified": true,
            "lastUpdated": 1588958810381,
            "location": {
                "address": "REDACTED",
                "vicinity": "REDACTED",
                "country": "REDACTED",
                "placeid": "REDACTED",
                "lat": REDACTED,
                "long": REDACTED
            },
            "ghg": {}
        },
        {
            "id": "REDACTED",
            "statusHistory": {
                "NS": "",
                "ASI": "2020/03/18",
                "ASC": "2020/05/01",
                "VRP": "2020/05/01",
                "VRQ": "",
                "VRE": "",
                "VRC": "",
                "VRF": "",
                "VRD": "",
                "VRI": "",
                "ASD": ""
            },
            "status": "VRP",
            "version": "fem2022",
            "accountId": "REDACTED",
            "accountName": "REDACTED",
            "sacId": REDACTED,
            "country": "Indonesia",
            "selfPosted": true,
            "verifiedPosted": false,
            "verified": true,
            "lastUpdated": 1609906534418,
            "location": {
                "address": "South Jakarta, South Jakarta City, Jakarta, Indonesia",
                "vicinity": "South Jakarta",
                "country": "Indonesia",
                "placeid": "REDACTED",
                "lat": REDACTED,
                "long": REDACTED
            },
            "ghg": {
                "self": {
                    "renewables": {
                        "total": 0,
                        "sources": []
                    },
                    "nonRenewables": {
                        "total": 8957406.468886847,
                        "sources": [
                            {
                                "name": "electricpurch",
                                "ghg": 1312958.842
                            },
                            {
                                "name": "natgaslpg",
                                "ghg": 7644447.626886847
                            }
                        ]
                    },
                    "refrigerants": {
                        "total": 0,
                        "sources": []
                    },
                    "sitecountrytext": "El Salvador",
                    "annualProductionQuant": 7018425,
                    "totalGhg": 8957406.468886847
                }
            }
        },
        {
            "id": "REDACTED",
            "statusHistory": {
                "NS": "",
                "ASI": "2020/01/22",
                "ASC": "2020/01/31",
                "VRP": "2020/02/01",
                "VRQ": "",
                "VRE": "",
                "VRC": "",
                "VRF": "",
                "VRD": "",
                "VRI": "",
                "ASD": ""
            },
            "status": "VRP",
            "version": "fem2022",
            "accountId": "REDACTED",
            "accountName": "REDACTED",
            "sacId": REDACTED,
            "country": "United States",
            "selfPosted": true,
            "verifiedPosted": false,
            "verified": true,
            "lastUpdated": 1620274918429,
            "location": {
                "address": "Denver, CO, USA",
                "vicinity": "Fountain",
                "country": "United States",
                "placeid": "REDACTED",
                "lat": 39.7392358,
                "long": -104.990251
            },
            "ghg": {
                "self": {
                    "renewables": {
                        "total": 0,
                        "sources": []
                    },
                    "nonRenewables": {
                        "total": 8957406.468886847,
                        "sources": [
                            {
                                "name": "electricpurch",
                                "ghg": 1312958.842
                            },
                            {
                                "name": "natgaslpg",
                                "ghg": 7644447.626886847
                            }
                        ]
                    },
                    "refrigerants": {
                        "total": 0,
                        "sources": []
                    },
                    "sitecountrytext": "El Salvador",
                    "annualProductionQuant": 7018425,
                    "totalGhg": 8957406.468886847
                }
            }
        },
        {
            "id": "REDACTED",
            "statusHistory": {
                "NS": "",
                "ASI": "2020/06/09",
                "ASC": "2020/02/14",
                "VRP": "",
                "VRQ": "",
                "VRE": "",
                "VRC": "",
                "VRF": "",
                "VRD": "",
                "VRI": "",
                "ASD": ""
            },
            "status": "ASI",
            "version": "fem2022",
            "accountId": "REDACTED",
            "accountName": "REDACTED",
            "sacId": REDACTED,
            "country": "United States",
            "selfPosted": false,
            "verifiedPosted": false,
            "verified": true,
            "lastUpdated": 1591733834425,
            "location": {
                "address": "REDACTED",
                "vicinity": "REDACTED",
                "country": "REDACTED",
                "placeid": "REDACTED",
                "lat": REDACTED,
                "long": REDACTED
            },
            "ghg": {}
        }
    ]
}
1

Enter your API credentials

Set the authentication headers with your API key and developer request token:
--header 'x-api-key: <<apiKey>>'
--header 'x-developer-request-token: <<apiKey>>'
2

Include GHG data

Here’s we’ve included ghg.Available include options are:
  • scores
  • ghg
  • usage
  • performance
"include": [
    "ghg"
],
3

Filter for the year

Use the version attribute to specify the year.
"version": "fem2022",
4

Filter by verification status

Use the verified attribute to include only verified assessments.
"verified": true,
5

Set the number of results

Control the number of results returned with the size parameter.
"size": 4