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
- 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
- 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
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.
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
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:
|
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:
|
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.
(you aren't logged into an account that has a registered Integrated Energy Data Resource Program client)
Test SSO Credentials
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 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). |
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 |