UtilityScore Savings Iframe Documentation

UtilityScore Iframe

The UtilityScore Iframe is designed to create a customized list of home improvements for a specified single-family home address. 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. key:  key parameter will be provided by UtilityScore. The Iframe will redirect to www.myutilityscore.com if key is not valid.
  2. address:  address parameter requires a single-family home address, e.g., “2816 Mayflower Dr, Fremont, Ca 94536”
  3. search:  search parameter will determine whether to show or not show the address search bar. Search parameter can be true, false or omitted.
    1. The address search bar allows a user to enter a new address to search for.
    2. If search parameter is omitted, default will be to show search address field.
    3. If search parameter is true, search address bar will be shown.
    4. If search parameter is false, search address bar will be hidden.
  4. claim_home:  claim_home parameter will determine whether to show the “Claim this home” button. Claim_home parameter can be true, false or omitted.
    1. If claim_home parameter is omitted, default will be to show “Claim this home”.
    2. If claim_home parameter is true, “Claim this home” button will be shown.
    3. If claim_home parameter is false, “Claim this home” button will be hidden.
  5. projects:  projects parameter will show how many projects to display within the SavingsCalculator. Projects parameter can take a list of parameters separated by a comma, e.g. projects=solar,windows,appliances
    1. Projects to filter by:
      • solar
      • heating_cooling
      • plumbing_fixtures
      • appliances
      • water_heating
      • windows
      • all: show all projects for this specific property that are available.
      • none: show no projects for this property.
  6. financing:  financing parameter will determine whether to show financing options for corresponding projects. Financing parameter can be true, false or omitted.
    1. If financing parameter is true, show all financing options.
    2. If financing parameter is false, hide all financing options shown within the Iframe.
    3. If financing parameter is omitted, hide all financing options shown within the Iframe.
  7. post_code:   5-digit Zip code
  8. year_built:  Year the house was built
  9. home_area:  Home square footage
  10. lot_area:  Parcel lot square footage

Iframe API call structure:

Each parameter must be separated by an ampersand.

  1. Example:
    • src="http://iframe.myutilityscore.com/iframe/projectcalculator?address=4471+Lancero+Ct,+Fremont+CA+94536&key=abcdefg&financing=none&search=true&claim_home=false&projects=all"
    • src="http://iframe.myutilityscore.com/iframe/projectcalculator?address=4471+Lancero+Ct,+Fremont+CA+94536key=abcdefg&financing=none&search=true&claim_home=false&projects=solar,windows,heating_cooling”
  2. Without the key or address parameter, the Iframe will redirect to www.myutilityscore.com.