UtilityScore Bill Iframe Documentation

UtilityScore Iframe

The UtilityScore Iframe is designed to create a customized monthly utility cost output. The Iframe can be embedded within a web page.

This document describes how to embed the UtilityScore Iframe within a web page, and the parameters that it requires to function properly.

Iframe Documentation for testing

The Iframe can create a customized output based on specific parameters passed in as a query string.

Parameters that can be passed in are:

  1. Required:
    1. key:   key parameter will be provided by UtilityScore. The Iframe will redirect to www.myutilityscore.com if key is not valid.
    2. home_type:  
      • SF: Single-family detached
      • 2to4: Duplex, triplex, or quadplex
      • MF: Multifamily building with 5 or more units
      • Other: Lots, mobile homes
    3. street:  Street number, street name, street suffix
      • Replace all spaces with %20
    4. city:  City, State
      • Replace all spaces with %20
      • Replace all commas with %2C
    5. post_code:   5-digit Zip code
    6. year_built:  Year the house was built
    7. home_area:  Home square footage
    8. lot_area:  Parcel lot square footage
  2. Optional
    1. space_heating_fuel:
      • Two possible values: “Gas” or “Electric”
      • Default based on local data
    2. water_heating_fuel:
      • Two possible values: “Gas” or “Electric”
      • Default based on local data
    3. has_air_conditioning:
      • If the house has air conditioning:
        • Two possible values: "True" or "False"
      • Default based on local data
    4. has_pool:
      • If the house has a pool:
        • Two possible values: "True" or "False"
        • Default based on local data
    5. has_spa:
      • If the house has a spa
        • Two possible values: "True" or "Flase"
      • Default based on local data
    6. num_occupants:
      • number of occupants in the house during the day
        • Two possible values: "True" or "False"
      • Valid values: any integer
    7. daytimeocc:
      • If there are occupants in the house during the day
        • Two possible values: "True" or "False"
      • Default = False
    8. winter_thermostat_setting:
      • Thermostat setting in the Winter (Integer)
      • Default = 68
      • Valid values: any integer
    9. summer_thermostat_setting:
      • Thermostat setting in the summer (Integer)
      • Default = 74
      • Valid values: any integer
    10. has_solar:
      • If the house has solar panels
        • Two possible values: "True" or "False
      • Default = False
    11. solar_capacity:
      • Size of rooftop photovoltaic system in kW
      • Default = 4.5
      • May include decimal
    12. has_electricity:
      • Does the home receive electricity service from a utility? (e.g., no propane, fuel oil, etc)
        • Two possible values: "True" or "False"
        • Default = True
    13. has_naturalgas:
      • Does the home receive natural gas service from a utility? (e.g., not propane, fuel oil, etc)
        • Two possible values: "True" or "False"
        • Default = True
    14. has_water:
      • Does the home receive water from a utility?(e.g., not from a well)
        • Two possilbe values: "True" or "False"
        • Default = True
    15. has_sewer:
      • Does the home receive sewer service from a utility? (e.g., not a septic system)
        • Two possible values: "True" or "False"
        • Default = True

Iframe API call structure:

Each parameter must be separated by an ampersand.

  1. Example:
    1. src=”https://iframe.myutilityscore.com/iframe/homebuyers?street=2816%20mayflower%20dr&city=antioch,%20ca&key=abcdeft&home_type=SF&post_code=94509&year_built=1984&home_area=1800&lot_area=4000”
  2. Without the key or address parameter, the Iframe will redirect to www.myutilityscore.com.