1. Documentation
2. Utilities
3. National Grid

National Grid

Description: National Grid is an investor-owned utility company servicing electric and gas customers. Click the below button to register with National Grid..

Website: https://greenbuttonconnect.nationalgrid.com/

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

Third Party Registration

In order for you to request data from National Grid customers, you must register with National Grid as a third party company.

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

Data Access

After registering with National Grid as a third party, to request authorizations from National Grid customers and test accounts, you can use any of these methods:

• Option 1: When you Request Data from your dashboard, select "National Grid" in the utility dropdown.
• Option 2: Using your default Template, set the Utility ID to NATIONALGRID in the url parameter or when you create a Form.
• Option 3: The Green Button OAuth process using the National Grid 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. National Grid 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 by default allow National Grid customers to verify their identity through Single Sign-On (SSO). 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 (sso or test) they want their OAuth authorize request to default to by their preferred authentication choice to the scope string. In general, you'll probably only find this useful for automated testing with test accounts, since the default (sso) is what you probably want to use for real National Grid customers.

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

Test Credentials

Since the National Grid 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 (sso or test).

Try one with your National Grid data share link
(you aren't logged into an account that has a registered National Grid client)

Test Accounts

Test SSO Credentials

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).