Integrated Energy Data Resource Program

Description: Integrated Energy Data Resource Program is overseen by the State of New York. The utilities that participate in this program are:

Central Hudson
Consolidated Edison
Liberty Utilities
National Fuel
National Grid
New York State Electric & Gas
Orange & Rockland
PSEG Long Island
Rochester Gas and Electric

Website: http://greenbutton.iedr.nyserda.ny.gov

Utility ID: IEDR (this is the utility identifier you use in our API)

Third Party Registration

New York State Registration

Third Parties must be registered with New York State Department of Public Service (DPS) in addition to registering with the IEDR platform prior to being granted access to live data. For instructions on registering with DPS, see the links below. Note that the registration forms and points of contact are unique to the category of third party seeking registration.

For Distributed Energy Resource (DER) Providers: https://dps.ny.gov/distributed-energy-resource-der-regulation-and-oversight
For Energy Service Companies (ESCOs): https://dps.ny.gov/energy-services-company-esco-competitive-market-information
For Energy Brokers and Energy Consultants: https://dps.ny.gov/energy-broker-and-energy-consultant-registration

A valid email must be supplied with the above registration that matches the email provided below on the IEDR Registration Form. If you are a third party that previously registered with DPS but did not provide a valid email address, please resubmit your registration form including only the contact details (page 1) and there will be an accelerated review and update process handled by DPS.

To confirm your registration with DPS and the presence of a valid email, check the consolidated DPS Registration Directory:

Navigate to: https://documents.dps.ny.gov/PTC/home
Click Dataset on the footer of this page
Click Download on the "Registered ESE Listing (.csv)” menu option

IEDR’s Green Button Connect Tool Registration

As part of their Green Button Connect My Data (GBCMD) program, IEDR is using UtilityAPI's EE/DER Engagement Platform to allow third-party companies to request data access from New York State utility customers. Authorizations use the Green Button OAuth process, which means that third-parties have to be pre-registered with Integrated Energy Data Resource Program so they can be assigned a client_id.

When you register, you will be automatically put into "sandbox" mode. This means you can only request data from test accounts, not real New York State utility customers. In order to be moved to "live" mode, you need to verify your email address with UtilityAPI. You can do so by clicking on the "Verify Email" link on the UtilityAPI settings page. After you verify the email, Integrated Energy Data Resource Program will review your registration and allow you to switch to "live" mode (you will get an email when this happens).

Data Access

After registering with Integrated Energy Data Resource Program as a third party, to request authorizations from Integrated Energy Data Resource Program customers and test accounts, you can use any of these methods:

Option 1: When you Request Data from your dashboard, select "Integrated Energy Data Resource Program" in the utility dropdown.
Option 2: Using your default Template, set the Utility ID to IEDR in the url parameter or when you create a Form.
Option 3: The Green Button OAuth process using the Integrated Energy Data Resource Program OAuth Authorize Endpoint found in your OAuth settings.

Once a customer has authorized, you will see an Authorization appear on your dashboard and via both our JSON API and Green Button API.

Note: By default, third parties are authorized to collect two years of historical data. Please note that intervals are only available for up to one year of the historical data for the current release.

Sandbox Mode

When your first register as a third party, your registration status is set to Sandbox mode. This means you can only request data from test accounts, so you can try it out or start building an integration, but real customers won't be able to authorize data sharing with you yet. Integrated Energy Data Resource Program will review your registration, then you'll get an email letting you know that you can now switch your status to Live mode in your settings.

Authentication Options

During the OAuth authorization flow, we allow Integrated Energy Data Resource Program customers to authenticate by logging into their utility accounts. However, since third parties may not have a real customer account when they start, we also offer a "test scenario" option. Third parties can pre-select which option they want their OAuth authorize request to default to by their preferred authentication choice to the scope string.

Scope parameter format:
auth-{type}[-{value}]

Full scope string example with authentication option (percent encoded):
scope=FB%3D4_16_51%3BAdditionalScope%3Dauth-test-test_residential

Note: Test credentials still work when set as authentication option scope parameters, so you can use them to test out authentication options.

Type	Can Have Value?	Description	Scope String Example
`utility`	Yes	Pre-selects a utility for the customer, and can be used with other options. Possible values: Rochester Gas and Electric: `rge` New York State Electric & Gas: `nyseg` National Grid: `natgd` National Fuel: `natfl` Central Hudson: `cenhud` Consolidated Edison: `coned` Orange & Rockland: `oandr` Liberty Utilities: `liberty` PSEG Long Island: `psegli`	`auth-utility-rge` `auth-utility-nyseg_auth-phone-5554443333`
`sso`	No	Try to use single sign-on to authenticate the customer using their utility account. Compatible utilities: Rochester Gas and Electric New York State Electric & Gas National Grid Central Hudson Consolidated Edison Orange & Rockland Liberty Utilities PSEG Long Island	`auth-sso`

Test Credentials

Since the Integrated Energy Data Resource Program OAuth authorization flow uses their authentication system by default, that means you can't use UtilityAPI's default test usernames to manually simulate a test scenario. Instead, below we have created some special test accounts you can simulate to try out the various authentication methods.

Try one with your Integrated Energy Data Resource Program data share link
(you aren't logged into an account that has a registered Integrated Energy Data Resource Program client)

Username	Password	Equivalent Test Scenario	Description
`test_residential_user`	`test_residential_user`	`residential`	A residential customer with 2 accounts and 2 meters per service type (e.g electric).
`test_commercial_user`	`test_commercial_user`	`commercial`	A commercial customer with 2 accounts and 2 meters per service type (e.g electric).
`test_badlogin`	`test_badlogin`	`badlogin`	Simulate error where a credential is incorrect.

Test Accounts

Test Account	Equivalent Test Scenario	Description
`test_residential_account1`	`residential`	A residential customer with 1 account and 1 meter per service type (e.g electric).
`test_residential_user`	`residential`	A residential customer with 2 accounts and 2 meters per service type (e.g electric).
`test_commercial_account1`	`commercial`	A commercial customer with 1 account and 1 meter per service type (e.g electric).
`test_commercial_user`	`commercial`	A commercial customer with 2 accounts and 2 meters per service type (e.g electric).
`test_badlogin`	`badlogin`	Simulate error where we couldn't find that customer.

Demo Third Party

To demonstrate how you can integrate the GBC OAuth authorization process into your apps and websites, we offer a demo third party website that can be configured with any GBC client, so long as it has a specific redirect_uri added. We have also created public, sandbox-only GBC clients that you can try out (see table below).

Client ID	Company Name	Pre-configured Demo Link
`IEDR_ccccccccc`	Test Company	Link

Documentation

API Endpoints