Developer Network NREL NREL Developer Network

Utility Rates (Version 2 - Deprecated) (GET /api/georeserv/service/utility_rates)

Deprecated: We encourage you to migrate to version 3 of the utility rates API.

Utility Rates Version 2 API Will Shutdown on October 31, 2016

This deprecated API will be shutdown on October 31, 2016. Please migrate to the new API.

For further questions or assistance, contact us.

Find utility rates and the utility companies for a specific location.

Request URL

GET /api/georeserv/service/utility_rates.format?parameters

Request Parameters

Parameter Required Value Description
format Yes
Type: string
Default: None
Options: json, xml, csv

The output response format.

api_key Yes
Type: string
Default: None

Your developer API key. See API key usage for more information.

lat Depends
Type: decimal
Default: None
Latitude, required if address not given.
lon Depends
Type: decimal
Default: None
Longitude, required if address not given.
address Depends
Type: string
Default: None
Address to use, lat/lon returned by Google's geocoding service.

Response Fields

Field Value Description
errors
Type: list of dictionaries

List of dictionaries containing errors that may be associated with an input field.

infos
Type: list of dictionaries

Non-error information about the inputs, or anything else in the system.

inputs
Type: list of dictionaries

List of the inputs as understood from the user.

version
Type: string

Version of Georeserv used to return this response.

warnings
Type: list of dictionaries

Warnings for the system, including information about coming deprecations to parameters, or to the call itself.

outputs
Type: list of outputs

First row in the list is the field names, remaining rows are the data, in this case in order by month.

Examples

JSON Output Format

GET /api/georeserv/service/utility_rates.json?address=Boulder,%20CO&api_key=DEMO_KEY

{
  "errors": [
    {
    }
  ],
  "infos": [

  ],
  "inputs": {
    "address": "Boulder, CO"
  },
  "outputs": {
    "commercial": 0.07,
    "company_id": "15466",
    "industrial": 0.06,
    "name": "PSC of Colorado",
    "residential": 0.09
  },
  "version": "2.0.26",
  "warnings": [

  ]
}

XML Output Format

GET /api/georeserv/service/utility_rates.xml?address=Boulder,%20CO&api_key=DEMO_KEY

<?xml version="1.0"?>
<params>
  <param>
    <value>
      <array>
        <data>
          <value>
            <string>errors</string>
          </value>
          <value>
            <array>
              <data>
                <value>
                  <struct/>
                </value>
              </data>
            </array>
          </value>
        </data>
      </array>
    </value>
  </param>
  <param>
    <value>
      <array>
        <data>
          <value>
            <string>infos</string>
          </value>
          <value>
            <array>
              <data/>
            </array>
          </value>
        </data>
      </array>
    </value>
  </param>
  <param>
    <value>
      <array>
        <data>
          <value>
            <string>inputs</string>
          </value>
          <value>
            <struct>
              <member>
                <name>address</name>
                <value>
                  <string>Boulder, CO</string>
                </value>
              </member>
            </struct>
          </value>
        </data>
      </array>
    </value>
  </param>
  <param>
    <value>
      <array>
        <data>
          <value>
            <string>outputs</string>
          </value>
          <value>
            <struct>
              <member>
                <name>residential</name>
                <value>
                  <double>0.089999999999999997</double>
                </value>
              </member>
              <member>
                <name>industrial</name>
                <value>
                  <double>0.059999999999999998</double>
                </value>
              </member>
              <member>
                <name>commercial</name>
                <value>
                  <double>0.070000000000000007</double>
                </value>
              </member>
              <member>
                <name>name</name>
                <value>
                  <string>PSC of Colorado</string>
                </value>
              </member>
              <member>
                <name>company_id</name>
                <value>
                  <string>15466</string>
                </value>
              </member>
            </struct>
          </value>
        </data>
      </array>
    </value>
  </param>
  <param>
    <value>
      <array>
        <data>
          <value>
            <string>version</string>
          </value>
          <value>
            <string>2.0.26</string>
          </value>
        </data>
      </array>
    </value>
  </param>
  <param>
    <value>
      <array>
        <data>
          <value>
            <string>warnings</string>
          </value>
          <value>
            <array>
              <data/>
            </array>
          </value>
        </data>
      </array>
    </value>
  </param>
</params>

Rate Limits

Standard rate limits apply. No more than 1,000 requests may be made in any hour

Errors

Standard errors may be returned. In addition, the following service-specific errors may be returned:

HTTP Status Code Description
400 Invalid Request - One or more parameters did not pass validation, or a parameter may be missing. Check the error section of the response to see how the request url should be modified to address the error.
Help Improve this Content