Stations
This resource retrieves a list of fuel stations which match the specified criteria.
Requests for this resource use the HTTP GET method. The search criteria are specified by means of query parameters, which must include a search geometry.
Search geometry can be one of:
- prox: A circular area defined by the coordinates of its center and a radius.
- corridor: A path defined as a set of points (latitude, longitude pairs) and a width.
- bbox: A square defined by its top left latitude and longitude and its bottom right latitude and longitude.
Request
This code block shows a search request that uses proximity (prox) to define the search area.
https://fuel-v2.cc.api.here.com/fuel/stations.xml
?prox=52.516667,13.383333,5000
&apiKey={YOUR_API_KEY}Request Parameters
This table documents both mandatory and optional request parameters supported by the stations resource.
| Parameter | Required | Description |
|---|---|---|
app_id - legacy | Yes | A-20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include authentication with every request. For more information on authentication, see the Identity & Access Management Developer Guide. |
app_code - legacy | Yes | A-20 byte Base64 URL-safe encoded string used for the authentication of the client application. You must include authentication with every request. For more information on authentication, see the Identity & Access Management Developer Guide. |
| apiKey | Yes | A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged-in user, you can generate it at https://developer.here.com/projects. API Keys never expire but you can disable your API Keys at any time. You cannot have more than two API Keys for one app at the same time. You must include an apiKey with every request. For more information on authentication, see the Identity & Access Management Developer Guide. |
prox | prox, bbox or corridor must be present | A circular search area defined by the latitude and longitude of its center (compliant with WGS 84) and an integer representing the radius of the area in meters, all separated by commas. For example, The maximum radius of the circle is 200 km. |
bbox | prox, bbox or corridor must be present | Bounding box defined by the latitude and longitude (compliant with WGS 84) of its top left and bottom right corners. The top left and bottom right pairs are separated by a semicolon and the latitude and longitude pairs are separated by commas. For example, one possible bounding box value is The bounding box size (width and/or high) must be no larger than 400km. |
corridor | prox, bbox or corridor must be present | A strip defined as a semicolon-separated list of points (pairs of comma-separated latitude and longitude WGS 84 compliant values) For example, Maximum corridor area is 5000 km2 Requests to the |
fueltype | No | Comma separated integers identifying the fuel types or categories included in the response. The number of values is unlimited Stations with unknown price information are excluded from the result set by default. When For more information on available fuel types and categories, see Fuel Types and Categories. |
corridorwidth | No | The width of the corridor in meters. This parameter takes effect only if The maximum corridor width is 20 km. Default: 5000 |
maxresults | No | The maximum number of results a response can contain. This parameter together with the Default: 50. |
sortkey | No | Criteria for sorting a list of search results. The possible values are:
|
sortorder | No | The sort order of the results. The possible values are:
Default: asc |
offset | No | A value specifying the index of the first result. This parameter together with the Default: 0. |
showallstations | No | Fuel stations with unknown price or fuel type information are included in the result set. This parameter works together with fueltype parameter. The possible values are:
Default: false |
imagedimensions | No | Request specific maximum size of brand icon image to match UI and bandwidth requirements The format specifies dimension for a scaled image by providing either the desired width, desired height, or both Valid elements are:
Examples:
Note: The provided values are used as upper boundaries for the dimensions of the returned image. The solution never scales up a small image and maintains the aspect ratio of the original image. |
brand | No | A list of brands to filter the stations in the response. The brand names in the list are separated with commas. The result contains only the stations that have a brand field which matches one specified in the list. The matching is case-insensitive. |
Response
For more information on the responses to queries for the stations resource, see Fuel Stations Response.
