Overview
The Energy Information Administration (EIA) fuel rates can be retrieved and utilized in the creation of fuel surcharge tables. By incorporating this data, fuel surcharge rates can be automatically calculated and applied to quotes and invoices. This process streamlines the management of fuel costs, enabling businesses to accurately account for fluctuations in fuel prices and adjust pricing accordingly. The EIA provides weekly fuel indexes needed for fuel surcharge calculations.
The EIA releases Diesel Prices each Monday evening*, the TMS batch job, FuelIndexUpdateJob, is configured to run at the end of each business day and insert the latest data-based on published EIA data. The fuel rates retrieved from the EIA are stored in Fuel Index History records.
*In the case of a federal holiday, fuel rates post the data on the next day. The U.S. National Average On-Highway Diesel Price is announced by the EIA Monday at 4 p.m.
Setup
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 to your email address. The EIA API key will be entered in the EIA Credentials card described below.
Enable the EIA integration by completing the following steps.
Navigate to TMS Admin.
Select Credentials.
Select the Global Services tab.
Find EIA in the list and open the card.
Check the Enabled box.
Enter the User ID and Password 1 into the text fields.
Click the Save button when finished.
See example in the table 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 up to date.
Click the Setup gear icon in the top right corner.
From the drop-down, click Setup.
In the Quick Find Toolbar type Remote Site Settings and click the link.
From the list of remote sites find EIA and click the Edit link.
Update the Remote Site URL to match the Service URL below:
Service URL: https://api.eia.gov
Text Service URL: https://api.eia.gov
Review Fuel Index Records
For automatic updates, the Data Series ID will need to be set in the Fuel Index record. All weekly indexes can be found by selecting a child category, then child 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 |
Create a New Fuel Index
Create a new Fuel Index table from the TMS Admin → Fuel Indexes link.
Click New Fuel Index.
Enter the Name and the Data Series ID found in the EIA API Dashboard.
Click Save.
.png)
If the EIA integration returns an error, retry again later, check the API Key, and fuel index values.
Schedule the FuelIndexUpdateJob
Schedule the FuelIndexUpdateJob daily at 6pm to enable automatic index and fuel surcharge refreshes.