---
title: Encentiv Widget jQuery API
description: Run an API call on each product page where the user will just need to make any appropriate selections and enter their zip code to get a rebate estimate on the page.
---

[Skip to content](https://support.encentivenergy.com/knowledge/encentivizer-widget-jquery-api#main-content)

English

Show submenu for translations

![EE\_logo\_darkBackground.png\]](https://support.encentivenergy.com/hs-fs/hubfs/Branding%20Images%20-%20Logos%20and%20Icons/EE_logo_darkBackground.png?height=40&name=EE_logo_darkBackground.png)

- [SCHEDULE A DEMO](https://www.encentivenergy.com/schedule-a-demo/)

Open main navigation

Close main navigation

- [SCHEDULE A DEMO](https://www.encentivenergy.com/schedule-a-demo/)
- English
  
  Show submenu for translations
- Contact us

 Contact us

 Welcome! How can we help you today?

- There are no suggestions because the search field is empty.

1. [Encentiv Support Center](https://support.encentivenergy.com/knowledge?hsLang=en)
2. [Encentiv Product Documentation](https://support.encentivenergy.com/knowledge/encentiv-product-documentation?hsLang=en)
3. [Rebate Finder](https://support.encentivenergy.com/knowledge/encentiv-product-documentation?hsLang=en#rebate-finder)

# Encentiv Widget jQuery API

## Run an API call on each product page where the user will just need to make any appropriate selections and enter their zip code to get a rebate estimate on the page.

### Initialization

#### Script tag

**NOTE** needed only if you use it as a standalone script

\<script type="text/javascript" src="https://cdn.encentivizer.com/widgets/assets/product-widget-api.js"\>\</script\>

#### required parameters

| Name | Value |
| --- | --- |
| **token** | Widget Token |
| **search** | DLC / Energy Star Model Number / Product ID / Display Name |
| **prewatts** | Existing Wattage, optional for initialization, **MUST** be positive |
| **prehours** | Existing Hours, optional for initialization, **MUST** be positive |

#### regular browser integration

var ee\_api = new EEWidgetAPI({  
    token: 'WIDGET\_TOKEN', search: 'SEARCH\_QUERY', prewatts: 000, prehours: 0000  
});

#### RequireJS integration

require(\["jquery", "ee\_widget\_api"\], function($) {  
    var ee\_api = new EEWidgetAPI({  
        token: 'WIDGET\_TOKEN', search: 'SEARCH\_QUERY', prewatts: 000, prehours: 0000  
    });  
});

### Functions

#### 1. Settings

This method is used to update the base settings for widget API

**required parameters**

| Name | Value |
| --- | --- |
| **token** | Widget Token |
| **search** | DLC / Energy Star Model Number / Product ID / Display Name |
| **prewatts** | Existing Wattage, **MUST** be positive |
| **prehours** | Existing Hours, **MUST** be positive |

**Example**

ee\_api.settings({  
    token: 'WIDGET\_TOKEN', search: 'SEARCH\_QUERY', prewatts: 000, prehours: 0000  
});

#### 2. Categories

This method is used to fetch available categories

**Example**

ee\_api.categories().done(function(data) {  
    console.log(data);  
});

**Returns**

\[  
    {  
        name: "DLC/Energy Star Category"  
        prehours: 0000  
        prewatts: 0000  
        value: "Encentivizer Category Abbreviation"  
    },  
    ...  
\]

#### 3. Utilities

This method is used to fetch available utility ids (rendered html options) based on zip provided

**required parameters**

| Name | Value |
| --- | --- |
| *(token)* | *(Widget Token,* **MUST** *set through initialization/settings)* |
| **zip** | Zipcode |

**optional parameter**

| Name | Value |
| --- | --- |
| format | 'json' |

**example**

ee\_api.utilities({ zip: 00000 }).done(function(data) {  
    console.log(data);  
});

ee\_api.utilities({ zip: 00000, format: 'json' }).done(function(data) {  
    console.log(data);  
});

**returns**

\<option value="..."\>...\</option\>  
...  
\<option value="..."\>...\</option\>

or

\[  
    {  
        program: 'PROGRAM\_NAME',  
        utilities: \[  
            {  
                id: 0000,  
                name: 'UTILITY\_NAME',  
                eiacode: "00000",  
                state: 'XX',  
                commercialrate: 0.0,  
                program\_name: 'PROGRAM\_NAME'  
            },  
            ...  
        \]  
    },  
    ...  
\]

#### 4. Rebates

This method is used to fetch rebates based on zipcode and utility provided

**required parameters**

| Name | Value |
| --- | --- |
| *(token)* | *(Widget Token,* **MUST** *set through initialization/settings)* |
| *(search)* | *(DLC / Energy Star Model Number / Product ID / Display Name,* **MUST** *set through initialization/settings)* |
| *(prewatts)* | *(Existing Wattage,* **MUST** *set through initialization/settings)* |
| *(prehours)* | *(Existing Hours,* **MUST** *set through initialization/settings)* |
| **zip** | Zipcode |
| **utility** | Utility ID |
| **midstream** | true:false (Optional parameter, if omitted, false) |

**example**

ee\_api.rebates({ zip: 00000, utility: 0000 }).done(function(data) {  
    console.log(data);  
});

**return**

{  
    data: \[{  
        caps: \[\],  
        cct: "0",  
        classification: "DLC-Premium" / "DLC-Standard" / "EnergyStar",  
        control\_rebate: "$0",  
        cutsheet\_link: "https://",  
        dlc\_cutsheet\_link: "http://",  
        efficacy: 0,  
        has\_integral\_controls: "YES" / "NO",  
        image\_link: "http://",  
        lumen: 0.00,  
        manufacturer\_rebate: "$0",  
        more\_info: "http://",  
        notes: "N/A",  
        product: "XXXXX-XXXXX",  
        product\_category: "",  
        product\_description: "",  
        product\_id: "",  
        product\_page\_link: "https://",  
        product\_type: "",  
        rebate: "$0",  
        units: "",  
        wattage: 0.0,  
    }, ...\],  
    input\_errors: \[\],  
    program\_rebate\_cap: ""  
}

 

 

 

 

- [General](https://support.encentivenergy.com/knowledge/general?hsLang=en)
- [Features + Functionality](https://support.encentivenergy.com/knowledge/features-functionality?hsLang=en#main-content)

    - [Product Awareness](https://support.encentivenergy.com/knowledge/features-functionality?hsLang=en#product-awareness)
    - [Payback Calculator](https://support.encentivenergy.com/knowledge/features-functionality?hsLang=en#payback-calculator)
    - [Rebate Finder](https://support.encentivenergy.com/knowledge/features-functionality?hsLang=en#rebate-finder)
- [Encentiv Product Documentation](https://support.encentivenergy.com/knowledge/encentiv-product-documentation?hsLang=en#main-content)

    - [Rebate Finder](https://support.encentivenergy.com/knowledge/encentiv-product-documentation?hsLang=en#rebate-finder)
    - [Payback Calculator](https://support.encentivenergy.com/knowledge/encentiv-product-documentation?hsLang=en#payback-calculator)

- [SCHEDULE A DEMO](https://www.encentivenergy.com/schedule-a-demo/)

[![ee\_full logo for light backgrounds](https://support.encentivenergy.com/hs-fs/hubfs/ee_full%20logo%20for%20light%20backgrounds.png?width=250&height=48&name=ee_full%20logo%20for%20light%20backgrounds.png "ee_full logo for light backgrounds")](http://encentivenergy.com)

Need more help? Email support@encentivenergy.com

Copyright © 2026, Encentiv Energy, Inc.