UtilityScore for Home Buyers Widget Documentation


Horizontal Widget
horizontal utilityscore widget

Square Widget
horizontal utilityscore widget

Attribution Widget
horizontal utilityscore widget

MyUtilityScore Horizontal Widget

Syntax

MyUtilityScore Horizontal Widget embeds a banner-like layout displaying the utility score of a property address according to its specific characteristics (location, utility provider, number of rooms, home area, and lot area). It utilizes Javascript to be executed. The syntax of the code to be embedded within the HTML web page’s source code is as follows:

<script id="utilityscore-horwidget" src="https://widgets.myutilityscore.com/horwidget.js?key=[KEYVALUE]&street=[Number, Street name, Street Suffix]&city=[] &post_code=[ZIP Code]&year_built=[Year Built]&home_area=[Home Square Footage]&lot_area=[Parcel Lot Square Footage]" type="text/javascript"></script>

A full example of the widget call considering all parameters would be as follows:
<script id="utilityscore-horwidget" src="https://widgets.myutilityscore.com/horwidget.js?key=aaaaa&street=4471%20Lancero%20Ct&city=Fremont%2C%20CA&post_code=94536&year_built=1970&home_area=1600& lot_area=6000&width=600&height =50
&space_heating_fuel=Gas&water_heating_fuel=Gas& has_airconditioning=true&air_conditioning_type=Central&has_pool=true&has_spa=false&num_occupants =4&daytimeocc=true&
winter_thermostat_setting
=70& summer_thermostat_setting=72&has_solar=true& solar_capacity=7&has_electricity=true& has_naturalgas=true&has_water=false&has_sewer=false&type="text/javascript"></script>

Non-operational platforms: www.Wix.com

Required Parameters

Parameter Description Valid Value Examples
Id=”utilityscore-horwidget” Locates the section where the UtilityScore widget’s code will be inserted. ”utilityscore-horwidget”
Key= Unique alphanumeric code provided during the UtilityScore registration process to identify the company and server embedding the widget. *UNIQUE TO ALL USERS*
Home_type= Residential property type
The only valid values
  • SF: Single-family detached
  • 2to4: Duplex, triplex, or quadplex
  • MF: Multifamily building with 5 or more units
  • Other: Lots, mobile homes
  • SF
  • 2to4
  • MF
  • Other
Street= Street number, street name, street suffix
  • Replace all spaces with %20
  • 5502%20Market%20St
  • 5502%20Market%20Street
City= City, State
  • Replace all spaces with %20
  • Replace all commas with %2C
  • Oakland%2C%20CA
  • San Francisco%2C%20CA
Post_Code= 5-digit Zip code
  • 94607
  • 95121
Year_Built= Year the house was built.
  • 1995
  • 2003
Home_Area= Home square footage
  • 1500
  • 2067
Lot_Area= Parcel lot square footage
  • 6000
  • 9034

Optional Parameters

Parameter Description Valid Value Examples
Width=
  • The widget will adjust its size in pixels to show the utility score information
  • Default=600
  • Valid values: any integer
600
Height=
  • The widget will adjust its size in pixels to show the utility score information
  • Default=50
  • Valid values: any integer
50
Space_Heating_Fuel=
  • Two possible values: "Gas" or "Electric"
  • Default based on local data
  • Gas
  • Electric
Water_Heating_Fuel=
  • Two possible values: "Gas" or "Electric"
  • Default based on local data
  • Gas
  • Electric
Has_Air_Conditioning=
  • If the house has air conditioning
  • Two possible values: "True" or "False"
  • Default based on local data
  • Central
  • Room
Has_Pool=
  • If the house has a pool
  • Two possible values: "True" or "False"
  • Default based on local data
  • True
  • False
Has_Spa=
  • If the house has a spa
  • Two possible values: "True" or "False"
  • Default based on local data
  • True
  • False
Num_Occupants=
  • Number of occupants in the house (Integer)
  • Default=3
  • Valid values: any integer
  • 3
  • 6
  • 7
  • 8
Daytimeocc=
  • If there are occupants in the house during the day
  • Two possible values: "True" or "False"
  • Default=False
  • True
  • False
Winter_Thermostat_Setting=
  • Thermostat setting in the Winter (Integer)
  • Default=68
  • Valid values: any integer
    68
Summer_Thermostat_Setting=
  • Thermostat setting in the Summer (Integer)
  • Default=74
  • Valid values: any integer
    74
Has_Solar=
  • If the house has solar panels
  • Two possible values: "True" or "False"
  • Default=False
  • True
  • False
Solar_Capacity=
  • Size of rooftop photovoltaic system in kW
  • Default =4.5
  • May include decimal
  • 3
  • 3.5
  • 4
  • 4.5
  • 7
Has_Electricity=
  • Does the home receive electricity service from a utility? (e.g. not an on-site generator)
  • Two possible values: "True" or "False"
  • Default=True
  • True
  • False
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
  • True
  • False
Has_Water=
  • Does the home receive water service from a utility? (e.g., not from a well)
  • Two possible values: "True" or "False"
  • Default=True
  • True
  • False
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
  • True
  • False

Specifics:

  • The US widget embeds a DIV tag after the <script> tag is located: <div id="utilityscore-horwidget-container"></div>
  • All CSS styles embedded have “utilityscore” as name prefix to avoid conflicts.
  • All variables used are local. Global variables have a “Utilityscore” name prefix used only to ensure loading of UtilityScore widget’s components are completed.
  • Code is isolated in its execution to avoid conflicts.
  • Some CMS (such as Wordpress) escape parameter ‘&’ separator generating an error. In such cases, it is possible to escape the ‘&’ separator for parameter values as %26, for example in:
    • <script id="utilityscore-horwidget" src="https://widgets.myutilityscore.com/horwidget.js?key=aaaaa%26street=4471%20Lancero%20Ct%26city=Fremont%2C%20CA%26post_code=94536%26year_built=1970%26home_area=1600&lot_area=6000%26width=600%26
      height=50" type="text/javascript"></script>
  • A webpage can have a maximum of one MyUtilityScore Horizontal Widget, one MyUtilityScore Square Widget, and one MyUtilityScore Attribution Widget.

The widget is shown as follows with single-family address:

horizontal utilityscore widget

The widget is shown as follows with a multi-family address:

horizontal utilityscore widget

The widget is shown as follows with a commercial/land address:

horizontal utilityscore widget

The messages displayed on the widget may change depending on the client and may be updated at any time.

MyUtilityScore Square Widget

Syntax

MyUtilityScore Square Widget embeds a square-like layout displaying the utility score of a property address according to its specific characteristics (location, utility provider, number of rooms, home area, and lot area). It utilizes Javascript to be executed. The syntax of the code to be embedded within the HTML web page’s source code is as follows:

<script id="utilityscore-sqwidget" src="https://widgets.myutilityscore.com/sqwidget.js?key=[KEYVALUE]&street=[Number, Street name, Street Suffix]&city=[]&post_code=[ZIP Code]&year_built=[Year Built]&home_area=[Home Square Footage]&lot_area=[Parcel Lot Square Footage]" type="text/javascript"></script>

A full example of the widget call considering all parameters would be as follows:
<script id="utilityscore-sqwidget" src="https://widgets.myutilityscore.com/horwidget.js?key=aaaaa&street=4471%20Lancero%20Ct&city=Fremont%2C%20CA&post_code=94536&year_built=1970&home_area=1600&lot_area=6000&width=600&height=50
&space_heating_fuel=Gas&water_heating_fuel=Gas&has_airconditioning=true&air_conditioning_type=Central&has_pool=true&has_spa=false&num_occupants=4&daytimeocc=true&
winter_thermostat_setting
=70&summer_thermostat_setting=72&has_solar=true&solar_capacity=7&has_electricity=true&has_naturalgas=true&has_water=false&has_sewer=false&type="text/javascript"></script>

Non-operational platforms: www.Wix.com

Required Parameters

Parameter Description Valid Value Examples
Id=”utilityscore-sqwidget” Locates the section where the UtilityScore widget’s code will be inserted. ”utilityscore-horwidget”
Key= Unique alphanumeric code provided during the UtilityScore registration process to identify the company and server embedding the widget. *UNIQUE TO ALL USERS*
Home_type= Residential property type
The only valid values
  • SF: Single-family detached
  • 2to4: Duplex, triplex, or quadplex
  • MF: Multifamily building with 5 or more units
  • Other: Lots, mobile homes
  • SF
  • 2to4
  • MF
  • Other
Street= Street number, street name, street suffix
  • Replace all spaces with %20
  • 5502%20Market%20St
  • 5502%20Market%20Street
City= City, State
  • Replace all spaces with %20
  • Replace all commas with %2C
  • Oakland%2C%20CA
  • San Francisco%2C%20CA
Post_Code= 5-digit Zip code
  • 94607
  • 95121
Year_Built= Year the house was built.
  • 1995
  • 2003
Home_Area= Home square footage
  • 1500
  • 2067
Lot_Area= Parcel lot square footage
  • 6000
  • 9034

Optional Parameters

Parameter Description Valid Value Examples
Width=
  • The widget will adjust its size in pixels to show the utility score information
  • Default=600
  • Valid values: any integer
600
Height=
  • The widget will adjust its size in pixels to show the utility score information
  • Default=50
  • Valid values: any integer
50
Space_Heating_Fuel=
  • Two possible values: "Gas" or "Electric"
  • Default based on local data
  • Gas
  • Electric
Water_Heating_Fuel=
  • Two possible values: "Gas" or "Electric"
  • Default based on local data
  • Gas
  • Electric
Has_Air_Conditioning=
  • If the house has air conditioning
  • Two possible values: "True" or "False"
  • Default based on local data
  • Central
  • Room
Has_Pool=
  • If the house has a pool
  • Two possible values: "True" or "False"
  • Default based on local data
  • True
  • False
Has_Spa=
  • If the house has a spa
  • Two possible values: "True" or "False"
  • Default based on local data
  • True
  • False
Num_Occupants=
  • Number of occupants in the house (Integer)
  • Default=3
  • Valid values: any integer
  • 3
  • 6
  • 7
  • 8
Daytimeocc=
  • If there are occupants in the house during the day
  • Two possible values: "True" or "False"
  • Default=False
  • True
  • False
Winter_Thermostat_Setting=
  • Thermostat setting in the Winter (Integer)
  • Default=68
  • Valid values: any integer
    68
Summer_Thermostat_Setting=
  • Thermostat setting in the Summer (Integer)
  • Default=74
  • Valid values: any integer
    74
Has_Solar=
  • If the house has solar panels
  • Two possible values: "True" or "False"
  • Default=False
  • True
  • False
Solar_Capacity=
  • Size of rooftop photovoltaic system in kW
  • Default =4.5
  • May include decimal
  • 3
  • 3.5
  • 4
  • 4.5
  • 7
Has_Electricity=
  • Does the home receive electricity service from a utility? (e.g. not an on-site generator)
  • Two possible values: "True" or "False"
  • Default=True
  • True
  • False
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
  • True
  • False
Has_Water=
  • Does the home receive water service from a utility? (e.g., not from a well)
  • Two possible values: "True" or "False"
  • Default=True
  • True
  • False
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
  • True
  • False

Specifics:

  • The US widget embeds a DIV tag after the <script> tag is located: <div id="utilityscore-horwidget-container"></div>
  • All CSS styles embedded have “utilityscore” as name prefix to avoid conflicts.
  • All variables used are local. Global variables have a “Utilityscore” name prefix used only to ensure loading of UtilityScore widget’s components are completed.
  • Code is isolated in its execution to avoid conflicts.
  • Some CMS (such as Wordpress) escape parameter ‘&’ separator generating an error. In such cases, it is possible to escape the ‘&’ separator for parameter values as %26, for example in:
    • <script id="utilityscore-sqwidget" src="https://widgets.myutilityscore.com/sqwidget.js?key=aaaaa%26street=4471%20Lancero%20Ct%26city=Fremont%2C%20CA%26post_code=94536%26year_built=1970%26home_area=1600&lot_area=6000%26width=600%26
      height=50" type="text/javascript"></script>
  • A webpage can have a maximum of one MyUtilityScore Horizontal Widget, one MyUtilityScore Square Widget, and one MyUtilityScore Attribution Widget.

Layout

The widget is shown as follows with single-family address:

horizontal utilityscore widget

The widget is shown as follows with a multi-family address:

horizontal utilityscore widget

The widget is shown as follows with a commercial/land address:

horizontal utilityscore widget

The messages displayed on the widget may change depending on the client and may be updated at any time.

MyUtilityScore Attribution Widget

Syntax

MyUtilityScore Attribution Widget embeds a small UtilityScore logo display along with a short message. It displays no specific information on it's interface, but when clicked, it will bring the user to the myutilityscore.com page for that home's address. The syntax of the code to be embedded within the HTML web page’s source code is as follows:

<script id="utilityscore-attribution" src="https://widgets.myutilityscore.com/attribution.js?key=[KEYVALUE]&street=[Number, Street name, Street Suffix]&city=[]&post_code=[ZIP Code]&year_built=[Year Built]&home_area=[Home Square Footage]&lot_area=[Parcel Lot Square Footage]" type="text/javascript"></script>

A full example of the widget call considering all parameters would be as follows:
<script id="utilityscore-attribution" src="https://widgets.myutilityscore.com/horwidget.js?key=aaaaa&street=4471%20Lancero%20Ct&city=Fremont%2C%20CA&post_code=94536&year_built=1970&home_area=1600&lot_area=6000&width=600&height=50
&space_heating_fuel=Gas&water_heating_fuel=Gas&has_airconditioning=true&air_conditioning_type=Central&has_pool=true&has_spa=false&num_occupants=4&daytimeocc=true&
winter_thermostat_setting
=70&summer_thermostat_setting=72&has_solar=true&solar_capacity=7&has_electricity=true&has_naturalgas=true&has_water=false&has_sewer=false&type="text/javascript"></script>

Non-operational platforms: www.Wix.com

Required Parameters

Parameter Description Valid Value Examples
Id=”utilityscore-attribution Locates the section where the UtilityScore widget’s code will be inserted. ”utilityscore-horwidget”
Key= Unique alphanumeric code provided during the UtilityScore registration process to identify the company and server embedding the widget. *UNIQUE TO ALL USERS*
Home_type= Residential property type
The only valid values
  • SF: Single-family detached
  • 2to4: Duplex, triplex, or quadplex
  • MF: Multifamily building with 5 or more units
  • Other: Lots, mobile homes
  • SF
  • 2to4
  • MF
  • Other
Street= Street number, street name, street suffix
  • Replace all spaces with %20
  • 5502%20Market%20St
  • 5502%20Market%20Street
City= City, State
  • Replace all spaces with %20
  • Replace all commas with %2C
  • Oakland%2C%20CA
  • San Francisco%2C%20CA
Post_Code= 5-digit Zip code
  • 94607
  • 95121
Year_Built= Year the house was built.
  • 1995
  • 2003
Home_Area= Home square footage
  • 1500
  • 2067
Lot_Area= Parcel lot square footage
  • 6000
  • 9034

Optional Parameters

Parameter Description Valid Value Examples
Width=
  • The widget will adjust its size in pixels to show the utility score information
  • Default=600
  • Valid values: any integer
600
Height=
  • The widget will adjust its size in pixels to show the utility score information
  • Default=50
  • Valid values: any integer
50
Space_Heating_Fuel=
  • Two possible values: "Gas" or "Electric"
  • Default based on local data
  • Gas
  • Electric
Water_Heating_Fuel=
  • Two possible values: "Gas" or "Electric"
  • Default based on local data
  • Gas
  • Electric
Has_Air_Conditioning=
  • If the house has air conditioning
  • Two possible values: "True" or "False"
  • Default based on local data
  • Central
  • Room
Has_Pool=
  • If the house has a pool
  • Two possible values: "True" or "False"
  • Default based on local data
  • True
  • False
Has_Spa=
  • If the house has a spa
  • Two possible values: "True" or "False"
  • Default based on local data
  • True
  • False
Num_Occupants=
  • Number of occupants in the house (Integer)
  • Default=3
  • Valid values: any integer
  • 3
  • 6
  • 7
  • 8
Daytimeocc=
  • If there are occupants in the house during the day
  • Two possible values: "True" or "False"
  • Default=False
  • True
  • False
Winter_Thermostat_Setting=
  • Thermostat setting in the Winter (Integer)
  • Default=68
  • Valid values: any integer
    68
Summer_Thermostat_Setting=
  • Thermostat setting in the Summer (Integer)
  • Default=74
  • Valid values: any integer
    74
Has_Solar=
  • If the house has solar panels
  • Two possible values: "True" or "False"
  • Default=False
  • True
  • False
Solar_Capacity=
  • Size of rooftop photovoltaic system in kW
  • Default =4.5
  • May include decimal
  • 3
  • 3.5
  • 4
  • 4.5
  • 7
Has_Electricity=
  • Does the home receive electricity service from a utility? (e.g. not an on-site generator)
  • Two possible values: "True" or "False"
  • Default=True
  • True
  • False
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
  • True
  • False
Has_Water=
  • Does the home receive water service from a utility? (e.g., not from a well)
  • Two possible values: "True" or "False"
  • Default=True
  • True
  • False
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
  • True
  • False

Specifics:

  • The US widget embeds a DIV tag after the <script> tag is located: <div id="utilityscore-attribution-container"></div>
  • All CSS styles embedded have “utilityscore” as name prefix to avoid conflicts.
  • All variables used are local. Global variables have a “Utilityscore” name prefix used only to ensure loading of UtilityScore widget’s components are completed.
  • Code is isolated in its execution to avoid conflicts.
  • Some CMS (such as Wordpress) escape parameter ‘&’ separator generating an error. In such cases, it is possible to escape the ‘&’ separator for parameter values as %26, for example in:
    • <script id="utilityscore-attribution" src="https://widgets.myutilityscore.com/attribution.js?key=aaaaa%26street=4471%20Lancero%20Ct%26city=Fremont%2C%20CA%26post_code=94536%26year_built=1970%26home_area=1600&lot_area=6000%26width=600%26
      height=50" type="text/javascript"></script>
  • A webpage can have a maximum of one MyUtilityScore Horizontal Widget, one MyUtilityScore Square Widget, and one MyUtilityScore Attribution Widget.

Layout

The messages displayed on the widget may change depending on the client and may be updated at any time.