Energy Information Administration (EIA)

Prev Next

The Energy Information Administration (EIA) fuel rates can be retrieved and utilized when creating fuel surcharge tables. By incorporating this data, fuel surcharge rates can be automatically calculated and applied to quotes and invoices. Through streamlining the management of fuel costs, businesses can accurately account for fluctuations in retail diesel prices and adjust Load rate pricing.

The EIA releases weekly retail diesel prices on Tuesday morning around 10:00 a.m. (ET), which are used for fuel surcharge calculations. The FuelIndexUpdateJob is configured to run at the end of the business day and inserts the latest published EIA data. The fuel rates retrieved from the EIA are stored in Fuel Index History records.

Note: When Monday is a federal holiday, fuel rates post Wednesday morning around 10:00 a.m. (ET). The U.S. National Average retail gasoline and on-highway diesel price in the report is always Monday prices.

Setup

Use the TMS Admin to create fuel indexes and configure the EIA API to pull current and latest diesel information.

Enter Credentials

Pulling data from the EIA API requires a registered API Key. A key can be obtained at no cost from the EIA Registration site. Fill out the form and the API Key is sent via email.

Enable the EIA integration by completing the following steps:

  1. Navigate to TMS Admin.

  2. Select Credentials.

  3. Select the Global Services tab.

  4. Type β€œEIA” in the search bar or locate EIA in the list and open the card.

  5. Check the Enabled box.

  6. Enter the User ID and Password 1 into the text fields.

  7. Click the Save button.

The EIA User ID and API Key are entered in the EIA Credentials card as shown in the example below.

User ID

Password 1

Password 2

Customer Number

Revenova

EIA API Key received via email from EIA.

Remote Site Settings

Upgrading from previous versions of the TMS may have outdated information. Check that the Remote Site Settings for the EIA integration URL are updated.

  1. Click the Setup Gear icon in the top right corner.

  2. From the drop-down, click Setup.

  3. In the Quick Find Toolbar, type Remote Site Settings and click the link.

  4. From the list of remote sites, find EIA and click the Edit link.

  5. Confirm the Remote Site URL matches the Service URL.

  6. When testing in a sandbox, confirm the Remote Site URL matches the Test Service URL.

Service URL:

https://api.eia.gov

Test Service URL:

https://api.eia.gov

Review Fuel Index Records

For automatic updates, the Data Series ID should be set in the Fuel Index record. All weekly indexes can be found by selecting a detail category then a detail series from the EIA API Dashboard. The most common Series are listed here:

Series Name

Series Id

U.S. No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_NUS_DPG.W

East Coast No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R10_DPG.W

New England (PADD 1A) No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R1X_DPG.W

Central Atlantic (PADD 1B) No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R1Y_DPG.W

Lower Atlantic (PADD 1C) No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R1Z_DPG.W

Midwest No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R20_DPG.W

Gulf Coast No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R30_DPG.W

Rocky Mountain No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R40_DPG.W

West Coast No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R50_DPG.W

West Coast (PADD 5) Except Cali No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_R5XCA_DPG.W

California No 2 Diesel Retail Prices, Weekly

PET.EMD_EPD2D_PTE_SCA_DPG.W

The TMS displaying sample Fuel Indexes and associated Data Series IDs.

See the Fuel Indexes article for more information on creating fuel indexes.

Note: If the EIA integration returns an error, check the API Key and fuel index values. If the issue persists, retry again later.

EIA API Integration

After creating a fuel index, run the FuelIndexUpdateJob batch process to view current and historical retail diesel price records.

Keep in mind that running this batch process job pulls information for all available Data Series IDs and updates all current and historical retail diesel fuel index records in the related list.

TMS Operation

EIA Endpoint

Request Type

Response

FuelIndexUpdateJob

Provides weekly retail diesel prices, dating back to a month prior

GET

200: SUCCESS

443: ERROR - API_KEY_INVALID

Base URL for the EIA Get Fuel Index History request:

https://api.eia.gov

There are two (2) fields stored in the TMS after triggering the EIA Get Fuel Index History request:

TMS Object

TMS Field

Type

EIA Field

Fuel Index History

Effective Date

Date

period

Fuel Index History

Value

Currency

value

See a sample GET 200: SUCCESS response below:

{
  "response": {
    "query execution": 0.000120803,
    "count query execution": 0.006701722,
    "total": 28,
    "dateFormat": "YYYY-MM-DD",
    "frequency": "weekly",
    "data": [
      {
        "period": "2022-07-11",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.568,
        "units": "$/GAL"
      },
      {
        "period": "2022-07-04",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.675,
        "units": "$/GAL"
      },
      {
        "period": "2022-06-27",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.783,
        "units": "$/GAL"
      },
      {
        "period": "2022-06-20",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.81,
        "units": "$/GAL"
      },
      {
        "period": "2022-06-13",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.718,
        "units": "$/GAL"
      },
      {
        "period": "2022-06-06",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.703,
        "units": "$/GAL"
      },
      {
        "period": "2022-05-30",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.539,
        "units": "$/GAL"
      },
      {
        "period": "2022-05-23",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.571,
        "units": "$/GAL"
      },
      {
        "period": "2022-05-16",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.613,
        "units": "$/GAL"
      },
      {
        "period": "2022-05-09",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.623,
        "units": "$/GAL"
      },
      {
        "period": "2022-05-02",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.509,
        "units": "$/GAL"
      },
      {
        "period": "2022-04-25",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.16,
        "units": "$/GAL"
      },
      {
        "period": "2022-04-18",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.101,
        "units": "$/GAL"
      },
      {
        "period": "2022-04-11",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.073,
        "units": "$/GAL"
      },
      {
        "period": "2022-04-04",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.144,
        "units": "$/GAL"
      },
      {
        "period": "2022-03-28",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.185,
        "units": "$/GAL"
      },
      {
        "period": "2022-03-21",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.134,
        "units": "$/GAL"
      },
      {
        "period": "2022-03-14",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 5.25,
        "units": "$/GAL"
      },
      {
        "period": "2022-03-07",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 4.849,
        "units": "$/GAL"
      },
      {
        "period": "2022-02-28",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 4.104,
        "units": "$/GAL"
      },
      {
        "period": "2022-02-21",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 4.055,
        "units": "$/GAL"
      },
      {
        "period": "2022-02-14",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 4.019,
        "units": "$/GAL"
      },
      {
        "period": "2022-02-07",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 3.951,
        "units": "$/GAL"
      },
      {
        "period": "2022-01-31",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 3.846,
        "units": "$/GAL"
      },
      {
        "period": "2022-01-24",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 3.78,
        "units": "$/GAL"
      },
      {
        "period": "2022-01-17",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 3.725,
        "units": "$/GAL"
      },
      {
        "period": "2022-01-10",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 3.657,
        "units": "$/GAL"
      },
      {
        "period": "2022-01-03",
        "duoarea": "NUS",
        "area-name": "U.S.",
        "product": "EPD2D",
        "product-name": "No 2 Diesel",
        "process": "PTE",
        "process-name": "Retail Sales",
        "series": "EMD_EPD2D_PTE_NUS_DPG",
        "series-description": "U.S. No 2 Diesel Retail Prices (Dollars per Gallon)",
        "value": 3.613,
        "units": "$/GAL"
      }
    ]
  },
  "request": {
    "command": "/v2/petroleum/pri/gnd/data/",
    "params": {
      "api_key": "1ad7c058a4c211cd8f641cba16d7261a",
      "frequency": "weekly",
      "start": "2022-01-01",
      "facets": {
        "series": [
          "EMD_EPD2D_PTE_NUS_DPG"
        ]
      },
      "sort": [
        {
          "column": "period",
          "direction": "desc"
        }
      ],
      "data": [
        "value"
      ]
    }
  },
  "apiVersion": "2.0.2"
}

See a sample GET response for a 443: Error due to an invalid API Key:

{
  "error": {
    "code": "API_KEY_INVALID",
    "message": "An invalid api_key was supplied. Get one at https://api.eia.gov:443"
  }
}