# Benchmarks
source: https://developer.mastercard.com/carbon-calculator/documentation/testing/testcase/test_case_engagement_benchmarks/index.md

Delivers country-based consumption figures based on your country of origin.

## Pre-requisites {#pre-requisites}

Refer to the [Benchmarks](https://developer.mastercard.com/carbon-calculator/documentation/use-cases/engagement-services/benchmarks/index.md) use case.


API Reference: `GET /benchmarks`

<br />

## Test Cases {#test-cases}

### Test Case: Success-Benchmarks {#test-case-success-benchmarks}

##### Request {#request}

    {{host}}/benchmarks?country=US&period=year

##### Response {#response}

```json
{
      "id": "US",
      "emission": {
          "yearly": 1.425
      },
      "parisAgreement": {
          "yearly": 1.66
      }
}
```

### Test Case: Fail-Invalid Request parameter {#test-case-fail-invalid-request-parameter}

##### Request {#request-1}

    {{host}}/benchmarks

##### Response {#response-1}

```json
{
    "Errors": {
        "Error": [
            {
                "Source": "Carbon-Calculator",
                "ReasonCode": "BAD_REQUEST",
                "Description": "One of the request parameters is invalid, try again with correct request.",
                "Recoverable": false,
                "Details": "country is a required field"
            }
        ]
    }
}
```

### Test Case: Fail-Invalid country code {#test-case-fail-invalid-country-code}

##### Request {#request-2}

    {{host}}/benchmarks?country=XY

##### Response {#response-2}

```json
{
    "Errors": {
        "Error": [
            {
                "Source": "Carbon-Calculator",
                "ReasonCode": "BAD_REQUEST",
                "Description": "One of the request parameters is invalid, try again with correct request.",
                "Recoverable": false,
                "Details": "Country code is invalid"
            }
        ]
    }
}
```

### Test Case: Fail-Invalid period {#test-case-fail-invalid-period}

##### Request {#request-3}

    {{host}}/benchmarks?country=US&period=abc

##### Response {#response-3}

```json
{
    "Errors": {
        "Error": [
            {
                "Source": "Carbon-Calculator",
                "ReasonCode": "INVALID_REQUEST_PARAMETER",
                "Description": "One of the request parameters is invalid, try again with correct request.",
                "Recoverable": false,
                "Details": "Period: Accepted values are 'month' and 'year'"
            }
        ]
    }
}
```