Fuel Prices API Developer's Guide

Fuel Price Example

This section provides an example of a fuel price request.

Note: This example uses a HERE API key to authenticate your request. For the available authentication options, see the Identity & Access Management Developer Guide

User story

The user wants to obtain prices for Diesel fuel within 5km of latitude 52.53087 and longitude 13.44176, which is in Berlin, Germany. Note that the latitude and longitude values are in WGS 84 format.

Request Summary

Resource: stations , note that resource representation is specified via extensions .xml or .json
Parameters: prox – indicates the area searched for fuel prices; in this case the area is a circle defined by a point within Berlin and a radius of 5km.
  fueltype – indicates the type of fuel the query includes in the response; in this case Diesel.

Request

The code block below demonstrates the complete request, specifying that the response data are to be delivered in JSON.


https://fuel-v2.cc.api.here.com/fuel/stations.json
?prox=52.53087,13.44176,5000
&fueltype=1
&apiKey={YOUR_API_KEY}

Here is the same request indicating that the response data are to be delivered in XML.


https://fuel-v2.cc.api.here.com/fuel/stations.xml
?prox=52.53087,13.44176,5000
&fueltype=1
&apiKey={YOUR_API_KEY}

Response

The response to the request contains:

  • the price, delta price and index score of all the fuel stations that met the search criteria (within proximity radius and correct fuel type )
  • list of stations that fit the specified criteria with additional details

The example response in JSON format is as follows:


{
   "hasMore":true,
   "fuelStations":{
    "fuelStation":[
     {
      "brand":"TOTAL",
      "brandIcon":"http://origin.stg.cld.vcdn.data.here.com/p/d/autox_stg/dt/icons/2015-05-06/total.png",
      "fuelPrice":[
         {
          "price":1.389,
          "deltaPrice":0.26,
          "indexScore":98,
          "fuelType":"1",
          "unit":"l",
          "currency":"EUR",
          "lastUpdateTimestamp":"2015-03-12T10:17:45.000Z"
         }
      ],
      "open24x7":true,
      "stationDetails":{
         "openingHours":{
          "regularOpeningHours":[
           {
            "daymask":127,
            "period":[
               {
                "from":"00:00:00",
                "to":"24:00:00"
               }
            ]
           }
          ]
         }
      },
      "address":{
         "city":"Berlin",
         "country":"DEU",
         "region":"Berlin",
         "street":"Margarete-Sommer-Stra�e",
         "streetNumber":"2",
         "postalCode":"10407"
      },
      "contacts":{
         "phone":[
          {
           "value":"+493042852514",
           "label":"PHONE"
          }
         ]
      },
      "distance":0,
      "position":{
         "latitude":52.53087,
         "longitude":13.44176
      },
      "name":"TOTAL",
      "id":"276u33dc-d1d2783a63404a6789f281438f32375f",
      "pvId":"50664433",
      "lastUpdateTimestamp":"2014-12-14T11:01:41.609Z",
      "timeZone":"Europe/Berlin"
     }
    ]
   }
}

The example response in XML format is as follows:


<fuel:fuelStationsResult>
  <hasMore>true</hasMore>
  <fuelStations>
    <fuelStation id="276u33dc-d1d2783a63404a6789f281438f32375f" pvId="50664433" lastUpdateTimestamp="2014-12-14T11:01:41.609Z" timeZone="Europe/Berlin">
      <brand>TOTAL</brand>
      <brandIcon>http://origin.stg.cld.vcdn.data.here.com/p/d/autox_stg/dt/icons/2015-05-06/total.png</brandIcon>
      <fuelPrice fuelType="1" unit="l" currency="EUR" lastUpdateTimestamp="2015-03-12T10:31:46.000Z">
        <price>1.249</price>
        <deltaPrice>0.12</deltaPrice>
        <indexScore>94</indexScore>
      </fuelPrice>
      <address>
        <city>Berlin</city>
        <country>DEU</country>
        <region>Berlin</region>
        <street>Margarete-Sommer-Straße</street>
        <streetNumber>2</streetNumber>
        <postalCode>10407</postalCode>
      </address>
      <contacts>
        <phone>
          <value>+493042852514</value>
          <label>PHONE</label>
        </phone>
      </contacts>
      <distance>0</distance>
      <position>
        <latitude>52.53087</latitude>
        <longitude>13.44176</longitude>
      </position>
      <name>TOTAL</name>
      <open24x7>true</open24x7>
      <stationDetails>
        <openingHours>
          <regularOpeningHours>
            <daymask>127</daymask>
            <period>
              <from>00:00:00</from>
              <to>24:00:00</to>
            </period>
          </regularOpeningHours>
        </openingHours>
      </stationDetails>
    </fuelStation>
  </fuelStations>
</fuel:fuelStationsResult>

For more details about responses to this type of request refer to Fuel Stations Response.