# Get Utility Bill Information

Endpoint: GET /api/v1/utility-bill
Version: 1.0.0

## Header parameters:

  - `Accept` (string)
    Example: "application/json"

  - `token` (string)
    Example: "{API Key}"

## Query parameters:

  - `streetNumber` (string, required)
    Lead's street number.

  - `streetAddress` (string, required)
    Lead's street address.

  - `city` (string, required)
    Lead’s city name.

  - `state` (string, required)
    Lead's state name (two-letter abbreviation, e.g., NY).

  - `zip` (string, required)
    Lead’s zip code (5 digit code).

## Response 200 fields (application/json):

  - `timestamp` (string)
    The timestamp when the response was returned. It is provided in ISO 8601 format.
    Example: "2024-08-20T14:30:00Z"

  - `status` (string)
    Indicates whether the request was successful or an error occurred.
    Enum: "success", "error"

  - `message` (string)
    Human-readable message describing the result of the request.
    Example: "Data successfully retrieved."

  - `address` (string)
    Full address used in the request.
    Example: "123 Main St, Austin, TX"

  - `data` (object)
    Contains utility data.

  - `data.units` (object)
    Units of measurement used in the response data.

  - `data.units.consumption` (string)
    Unit of measurement for energy consumption.
    Example: "kWh"

  - `data.units.cost` (string)
    Unit of measurement for energy cost.
    Example: "USD"

  - `data.units.emissions` (string)
    Unit of measurement for emissions.
    Example: "kgCO2"

  - `data.units.emissionRate` (string)
    Unit of measurement for emission rate.
    Example: "kgCO2/kWh"

  - `data.units.utilityRate` (string)
    Unit of measurement for utility rate.
    Example: "USD/kWh"

  - `data.electricity` (object,null)
    Electricity consumption, cost and emission statistics.

  - `data.electricity.monthlyAverageConsumption` (number)
    Average monthly electricity consumption over the last 12 months.
    Example: 435.2

  - `data.electricity.monthlyAverageCost` (number)
    Average monthly electricity cost over the last 12 months.
    Example: 98.5

  - `data.electricity.annualConsumption` (number)
    Total electricity consumption over the last 12 months.
    Example: 5222.4

  - `data.electricity.annualCost` (number)
    Total electricity cost over the last 12 months.
    Example: 1182

  - `data.electricity.quarterAverageConsumption` (object)
    Average electricity consumption per quarter.

  - `data.electricity.quarterAverageConsumption.q1` (number)
    Average electricity consumption for Q1 (Jan-Mar).
    Example: 410.2

  - `data.electricity.quarterAverageConsumption.q2` (number)
    Average electricity consumption for Q2 (Apr-Jun).
    Example: 455

  - `data.electricity.quarterAverageConsumption.q3` (number)
    Average electricity consumption for Q3 (Jul-Sep).
    Example: 472.6

  - `data.electricity.quarterAverageConsumption.q4` (number)
    Average electricity consumption for Q4 (Oct-Dec).
    Example: 402.9

  - `data.electricity.quarterAverageCost` (object)
    Average electricity cost per quarter.

  - `data.electricity.quarterAverageCost.q1` (number)
    Average electricity cost for Q1 (Jan-Mar).
    Example: 90.4

  - `data.electricity.quarterAverageCost.q2` (number)
    Average electricity cost for Q2 (Apr-Jun).
    Example: 102.1

  - `data.electricity.quarterAverageCost.q3` (number)
    Average electricity cost for Q3 (Jul-Sep).
    Example: 110.5

  - `data.electricity.quarterAverageCost.q4` (number)
    Average electricity cost for Q4 (Oct-Dec).
    Example: 91

  - `data.electricity.peakMonth` (object)
    Month with highest electricity consumption.

  - `data.electricity.peakMonth.name` (string)
    Peak month name.
    Example: "August"

  - `data.electricity.peakMonth.consumption` (number)
    Electricity consumption in the peak month.
    Example: 520

  - `data.electricity.peakMonth.cost` (number)
    Electricity cost in the peak month.
    Example: 120.5

  - `data.electricity.monthlyAverageUtilityRate` (number)
    Monthly average electricity utility rate over the last 12 month.
    Example: 0.215

  - `data.electricity.emissions` (object)
    Emissions data from electricity usage.

  - `data.electricity.emissions.annualEmissions` (number)
    Total electricity emissions over the last 12 months.
    Example: 1200

  - `data.electricity.emissions.monthlyAverageEmissions` (number)
    Monthly average electricity emissions over the last 12 months.
    Example: 100

  - `data.electricity.emissions.monthlyAverageEmissionRate` (number)
    Monthly average electricity emissions per kWh of electricity consumption over the last 12 months.
    Example: 0.18

  - `data.electricity.emissions.peakMonth` (object)
    Month with highest electricity emissions.

  - `data.electricity.emissions.peakMonth.emissions` (number)
    Electricity emissions in peak month.
    Example: 0.21

  - `data.fossilFuel` (object,null)
    Fossil fuel usage statistics.

  - `data.fossilFuel.type` (string)
    Type of fossil fuel.
    Example: "Natural Gas"

  - `data.fossilFuel.annualConsumption` (number)
    Total fossil fuel consumption over the last 12 months.
    Example: 2840

  - `data.fossilFuel.annualCost` (number)
    Total fossil fuel cost over the last 12 months.
    Example: 380

  - `data.fossilFuel.monthlyAverageUtilityRate` (number)
    Monthly average fossil fuel utility rate over the last 12 months.
    Example: 0.134

  - `data.ratios` (object,null)

  - `data.ratios.electricToFossilRatio` (number)
    Ratio of electricity to fossil fuel consumption over the last 12 months.
    Example: 1.84

## Response 400 fields (application/json):

  - `error` (string)
    Example: "Bad Request"

  - `statusCode` (integer)
    Example: 400

  - `message` (array)
    Example: ["state must be a string","state should not be empty"]

## Response 401 fields (application/json):

  - `error` (string)
    Example: "Unauthorized"

  - `statusCode` (integer)
    Example: 401

  - `message` (string)
    Example: "Invalid API Key"

## Response 404 fields (application/json):

  - `error` (string)
    Example: "Not Found"

  - `statusCode` (integer)
    Example: 404

  - `message` (string)
    Example: "Cannot GET /api/v1/utility-bill"

## Response 500 fields (application/json):

  - `error` (string)
    Example: "Internal Server Error"

  - `statusCode` (integer)
    Example: 500

  - `message` (string)
    Example: "Unexpected server error occurred. Please try again later."