HERE Fuel Prices API v2

{"openapi":"3.0.2","info":{"title":"Fuel Prices API v2","version":"2.1.0","description":"What is the Fuel Prices API?  \n\nThe HERE Fuel Prices API is a RESTful API that:\n\n- provides dynamic data on the price of fuel at fuel stations within a specified area and filtered by desired fuel type\n- provides lists of fuel stations within a specified area, including data on fuel types available, prices and location\n- provides data such as fuel prices and location information for individual fuel stations\n- provides a price index for a specified geometry that ranks the fuel stations using current prices and statistically-modelled prices where the price data is unavailable\n\nWhy use the Fuel Prices API?\n\nThe Fuel Prices API provides solutions for the following high level use cases.\n\n- Show lists of fuel stations with information on location and prices along a planned route or based on a location\n- Allow the user to sort fuel stations based on the price index\n"},"externalDocs":{"description":"The developer guide and related API references are available here.","url":"https://www.here.com/docs/category/fuel-prices"},"security":[{"Bearer":[]}],"tags":[{"name":"Fuel stations","description":"Search fuel stations"},{"name":"Fuel types and brands","description":"Get available fuel types and brands"},{"name":"API Information","description":"API Information"}],"paths":{"/fuel/stations":{"get":{"tags":["Fuel stations"],"summary":"Fuel stations search","description":"Retrieves fuel stations within geospatial area","operationId":"Fuel Prices API v2 fuelStationsSearch","parameters":[{"name":"prox","in":"query","description":"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.","required":false,"schema":{"type":"string"}},{"name":"bbox","in":"query","description":"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.","required":false,"schema":{"type":"string"}},{"name":"corridor","in":"query","description":"A strip defined as a semicolon-separated list of points (pairs of comma-separated latitude and longitude WGS 84","required":false,"schema":{"type":"string"}},{"name":"corridorwidth","in":"query","description":"The width of the corridor in meters. This parameter takes effect only if corridor are included in the request.","required":false,"schema":{"type":"integer","format":"int32","default":5000}},{"name":"fueltype","in":"query","description":"An integer identifying the fuel type or category included in the response.\nAvailable types (all can be retrieved from `/fuel/fueltypes` endpoint):\n|Fuel type ID|Name|\n|---|---|\n|-1|All Truck Diesel|\n|-2|All Diesel\n|-3|All Petrol\"\n|-4|All LPG|\n|-5|All CNG|\n|-6|All Ethanol|\n|-7|All Methanol|\n|-8|All Additives|\n|1|Diesel|\n|2|Regular|\n|3|Mid-grade|\n|4|Premium|\n|5|E-85|\n|6|Bio-Diesel|\n|7|Bio-Diesel 10|\n|8|Bio-Diesel 15|\n|9|Bio-Diesel 20|\n|10|Diesel plus|\n|11|Truck-Diesel|\n|12|Red-Diesel|\n|13|E-10|\n|14|LPG-GLP|\n|15|LRP|\n|16|Methane|\n|17|Midgrade-self|\n|18|Diesel-self|\n|19|AdBlue|\n|20|V-Power-95|\n|21|CNG|\n|22|Ethanol|\n|23|Ethanol w. additives|\n|24|GPL self|\n|25|Premium self|\n|26|Leaded Four|\n|27|Super Unleaded|\n|28|Super Unleaded Ultimate|\n|29|Diesel-plus self|\n|30|Methanol self|\n|31|Mid-grade E10|\n|32|Super-Diesel|\n|33|Unleaded E5|\n|34|Unleaded E25|\n|35|Unleaded|\n|36|Unleaded 91|\n|37|Unleaded 93|\n|38|Unleaded 97|\n|39|Unleaded 99|\n|40|Unleaded 100|\n|41|Unleaded 102|\n|42|Methanol|\n|43|Unleaded E10|\n|44|Shell V-Power Racing|\n|45|Shell V-Power 100|\n|46|Shell V-Power Diesel|\n|47|Aral Ultimate 102|\n|48|Aral Ultimate Diesel|\n|49|BP Ultimate Super|\n|50|BP Ultimate Diesel|\n|51|Blue One 95|\n|52|Diesel Cleanline|\n|53|Super E5|\n|54|Super E10|\n|55|Premium Diesel|\n|56|Unleaded 95|\n|57|Simple gasoline|\n|58|Simple diesel|\n|59|Super Unleaded 98|\n|60|Unleaded 98|\n|61|Premium gasoline|\n|62|Synergy Supreme+ Diesel|\n|63|Supreme Diesel|\n|64|Unleaded 92|\n|65|Unleaded 80|\n|66|Super Unleaded 95|\n|67|Super Unleaded 92|\n|68|LNG|\n|69|Super E5 Premium|\n|70|Heating oil|\n|71|AdBlue Car|\n|72|AdBlue Truck|\n|73|Hydrotreated vegetable oil|\n|74|Hydrogen|\n|75|E-85 cash (US ONLY)|\n|76|Diesel cash (US ONLY)|\n|77|Mid-grade cash (US ONLY)|\n|78|Regular cash (US ONLY)|\n|79|Regular clear - without ethanol (US ONLY)|\n|80|Premium cash (US ONLY)|\n|81|Two stroke petrol|\n|82|Unleaded 87|\n|83|Unleaded 89|\n|84|GTL - Gas to liquid fuel|\n|85|HVO 30 - Diesel with 30% of hydrotreated vegetable oil|\n|86|Premium Diesel cash|\n|87|Red-Diesel cash|\n|88|Bio-Diesel 20 cash|\n|89|Super E15|\n|90|Heating oil cash|\n|91|AdBlue cash|\n|92|AdBlue Truck cash|\n|93|Bio-Diesel cash|\n|94|Bio-Diesel 10 cash|\n|95|LPG-GLP cash|\n|96|CNG cash|\n|97|Truck Diesel cash|\n","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"maxresults","in":"query","description":"The maximum number of results a response can contain. This parameter together with the offset parameter in the query and HasMore in the response can be used for pagination.","required":false,"schema":{"type":"integer","format":"int32","default":50}},{"name":"offset","in":"query","description":"A value specifying the index of the first result. This parameter together with the maxresults parameter in the query and HasMore in the response can be used for pagination.","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"sortkey","in":"query","description":"Criteria for sorting a list of search results.","required":false,"schema":{"type":"string","enum":["price","distance"]}},{"name":"sortorder","in":"query","description":"The sort order of the results.","required":false,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"brand","in":"query","description":"|\nList of brands to filter the stations in the response. The brand names in the list are separated with commas.\nThe result will contain only the stations that have brand field that match to the one of those specified in the list.\nThe matching is caseinsensitive.\nList of brands can be retireved using `/fuel/fuelbrands` endpoint\n","required":false,"explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"showallstations","in":"query","description":"Also fuel stations with unknown price or fuel type information will be included in the result set. This parameter works together with fueltype parameter.","required":false,"schema":{"type":"boolean","default":false}},{"name":"imagedimensions","in":"query","description":"Request specific maximum size of brand icon image to match UI and bandwidth requirements The format is that specifies dimension for a scaled image by providing either the desired width, desired heigh, or both","example":"w20-h20","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/X-Request-Id"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuelStationsResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FuelStationsResult"}}}},"400":{"description":"Invalid parameters were provided","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"429":{"$ref":"#/components/responses/Error429Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}},"/fuel/stations/{id}":{"get":{"tags":["Fuel stations"],"summary":"Fuel station details","description":"Retrieves fuel station details for given station id","operationId":"Fuel Prices API v2 fuelStationDetail","parameters":[{"name":"id","in":"path","description":"Fuel station id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/X-Request-Id"}],"responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuelStationsResult"}},"application/xml":{"schema":{"$ref":"#/components/schemas/FuelStationsResult"}}}},"400":{"description":"Invalid parameters were provided","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"404":{"description":"Fuel station with given id does not exist","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"$ref":"#/components/responses/Error500Response"}}}},"/fuel/fueltypes":{"get":{"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"tags":["Fuel types and brands"],"summary":"Fuel types","description":"Returns all available fuel types. Fuel type id can be used as fuelType query parameter in Fuel stations search","operationId":"Fuel Prices API v2 fuelTypes","responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuelTypes"},"examples":{"dieselFuelTypesExample":{"$ref":"#/components/examples/FuelTypesExample"}}}}},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"500":{"$ref":"#/components/responses/Error500Response"}}}},"/fuel/fuelbrands":{"get":{"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"tags":["Fuel types and brands"],"summary":"Fuel brands","description":"Returns all available fuel station brands. Fuel station brand can be used as brands query parameter in Fuel stations search","operationId":"Fuel Prices API v2 fuelBrands","responses":{"200":{"description":"OK","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FuelBrands"},"examples":{"fuelBrandsExample":{"$ref":"#/components/examples/FuelBrandsExample"}}}}},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"500":{"$ref":"#/components/responses/Error500Response"}}}},"/fuel/isalive":{"get":{"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"tags":["API Information"],"summary":"Fuel service is alive check","description":"Fuel service is working properly","operationId":"Fuel Prices API v2 fuelIsAlive","responses":{"200":{"headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ApiIsAliveStatus"}}},"description":"Service is live, all components works"},"500":{"$ref":"#/components/responses/Error500Response"},"503":{"$ref":"#/components/responses/Error503Response"}}}},"/fuel/version":{"get":{"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"tags":["API Information"],"summary":"Fuel service version","description":"Fuel service version","operationId":"Fuel Prices API v2 fuelVersion","responses":{"200":{"headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Version"}}},"description":"Service version"},"500":{"$ref":"#/components/responses/Error500Response"},"503":{"$ref":"#/components/responses/Error503Response"}}}}},"servers":[{"url":"https://fuel-v2.cc.api.here.com","description":"Production environment URL"},{"url":"https://fuel-v2.cit.cc.api.here.com","description":"Staging environment URL"}],"components":{"parameters":{"X-Request-Id":{"name":"X-Request-Id","in":"header","description":"User-provided token that can be used to trace a request or a group of requests sent to the service.","schema":{"type":"string"}}},"headers":{"X-Correlation-Id":{"description":"Auto-generated unique identifier to identify this request.","schema":{"type":"string"},"example":"4d173a1e-6f1b-459b-b74f-23686354aaea"},"X-Request-Id":{"description":"User-provided token that can be used to trace a request or a group of requests sent to the service.\n","schema":{"type":"string"}}},"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request.\n\nFor more information on how to get a bearer token, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html.\n"}},"responses":{"Error401Response":{"description":"API response in case of lacking valid authorization credentials.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"},"example":{"error":"Unauthorized","error_description":"No credentials found"}}}},"Error403Response":{"description":"API response in case of insufficient credentials for access to the requested resource.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthError"},"example":{"error":"Forbidden","error_description":"These credentials do not authorize access"}}}},"Error429Response":{"description":"API response in case of too many requests","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":429,"code":"E611125","title":"Too many requests","cause":"Request rate limit reached","action":"Retry later, lower the request rate","correlationId":"efefe455-d2e3-4e23-86aa-4e9a8a1680d4"}}}},"Error500Response":{"description":"API response in case of internal server error","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/InternalServerErrorExample"}}}}},"Error502Response":{"description":"API response in case of bad gateway","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/502errorResponseExample"}}}}},"Error503Response":{"description":"API response in case of service unavailable","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"status":503,"code":"E611001","title":"Service not available","cause":"Service current not available","action":"Retry later","correlationId":"efefe455-d2e3-4e23-86aa-4e9a8a1680d4"}}}},"Error504Response":{"description":"API response in case of gateway timeout.","headers":{"X-Correlation-Id":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"errorResponseExample":{"$ref":"#/components/examples/504errorResponseExample"}}}}}},"schemas":{"ErrorResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32","description":"The HTTP status code"},"title":{"type":"string","description":"Human-readable error description"},"code":{"type":"string","description":"Error code"},"cause":{"type":"string","description":"Human-readable explanation for the error"},"action":{"type":"string","description":"Human-readable action for the user"},"correlationId":{"type":"string","description":"Auto-generated ID univocally identifying this request"}},"required":["title","status","code","cause","action","correlationId"]},"AuthError":{"description":"Error object reported in case of authentication or authorization errors.","type":"object","properties":{"error":{"type":"string","description":"Error message"},"error_description":{"type":"string","description":"Detailed information about the error"}},"example":{"error":"Unauthorized","error_description":"ApiKey invalid. ApiKey not found."}},"Version":{"type":"object","properties":{"builtAtMillis":{"type":"string","example":"1599152544387","description":"UNIX timestamp whene artifact has been bult"},"name":{"type":"string","example":"fuel-webapp","description":"Application name"},"gitBranch":{"type":"string","example":"master","description":"Source code repository branch name"},"scalaVersion":{"type":"string","example":"2.11.12","description":"Scala version used for builds"},"version":{"type":"string","example":"2.12.101","description":"Application version"},"sbtVersion":{"type":"string","example":"1.1.6","description":"SBT version used for builds"},"playVersion":{"type":"string","example":"2.6.6","description":"Play framework version under which application is running"},"gitHeadRev":{"type":"string","example":"70df102bec5c0183f9794a91805d8fe775d1d70c","description":"Git commit ID"},"gitBuildDate":{"type":"string","example":"2020-09-03T17:02:17.024Z","description":"Date of build"},"builtAtString":{"type":"string","example":"2020-09-03 17:02:24.387","description":"Date of build as a string"}}},"Error":{"type":"object","properties":{"Type":{"type":"string","example":"Invalid Request","description":"Type of error"},"Message":{"type":"array","description":"Detailed error description","items":{"type":"string","example":"Request parameter 'product' does not conform with expected data type. Please check the documentation."}}}},"FuelStationsResult":{"type":"object","properties":{"hasMore":{"type":"boolean","example":false,"description":"More stations available (limit is 50 per one page if maxresults is not specified)"},"fuelStations":{"type":"object","properties":{"fuelStation":{"type":"array","description":"List of fuel stations found within search area","items":{"$ref":"#/components/schemas/FuelStation"}}}}}},"FuelStation":{"type":"object","properties":{"id":{"type":"string","example":"276u33d9-a17acb43a137436ba33808cab15bc914","description":"Unique fuel station identifier.","xml":{"attribute":true}},"pvId":{"type":"string","example":"50664035","description":"PVID identifier.","xml":{"attribute":true}},"lastUpdateTimestamp":{"type":"string","format":"datetime","example":"2020-04-23T14:32:20.371Z","description":"Timestamp of the last update of information about this POI by the content supplier. Represents a datetime in ISO 8601 format. If time is UTC, 'Z' is added directly after the time without a space (e.g. 2014-01-14T10:00Z). Otherwise, time offsets from UTC is added after time in format ±[hh][mm] (e.g. 2014-01-14T10:00:00+0100)","xml":{"attribute":true}},"timeZone":{"type":"string","example":"Europe/Berlin","description":"Time zone of the POI. Represents the standard denominator of the time zone.","xml":{"attribute":true}},"name":{"type":"string","example":"Shell","description":"Fuel station name"},"brand":{"type":"string","example":"Shell","description":"Fuel station brand"},"brandIcon":{"type":"string","example":"https://download.vcdn.cc.data.here.com/p/d/autox/pr/icons/2015-09-11/shell.png","description":"Link to fuel station brand icon"},"distance":{"type":"integer","format":"int32","example":125,"description":"Air distance to the station in meters from given location"},"open24x7":{"type":"boolean","example":true,"description":"Boolean value indicating if the fuel station is open 24 hours a day."},"address":{"$ref":"#/components/schemas/AddressType"},"contacts":{"$ref":"#/components/schemas/ContactType"},"position":{"$ref":"#/components/schemas/PositionType"},"entrancePosition":{"$ref":"#/components/schemas/PositionType"},"fuelPrice":{"type":"array","items":{"$ref":"#/components/schemas/FuelPriceType"}},"stationDetails":{"$ref":"#/components/schemas/FuelStationDetailType"}}},"AddressType":{"type":"object","description":"Fuel station address","properties":{"city":{"type":"string","example":"Berlin","description":"City name"},"street":{"type":"string","example":"Sonnenallee","description":"Street name of the fuel station"},"streetNumber":{"type":"string","example":"56","description":"House number of the fuel station"},"region":{"type":"string","example":"Berlin","description":"Region"},"district":{"type":"string","example":"Mitte","description":"District"},"country":{"type":"string","example":"DEU","description":"ISO 3166 3-lettre country code"},"postalCode":{"type":"string","example":"12045","description":"Postal code"},"unparsedAddress":{"type":"string","example":"Sonnenallee 56 Berlin 12045 DEU","description":"The string with unparsed address"}}},"ContactType":{"type":"object","description":"Fuel station contacts","properties":{"phone":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"},"example":[{"value":"+49306811313","label":"PHONE"}]},"fax":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"},"example":[{"value":"+493068893007","label":"FAX"}]},"email":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"},"example":[{"value":"shellcustomercare@shell.com","label":"EMAIL"}]},"website":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"},"example":[{"value":"https://find.shell.com/de/fuel/10024324-berlin-karl-marx-str","label":"WEBADDRESS"}]}}},"PositionType":{"type":"object","description":"WGS84 format co-ordinates for the fuel station","properties":{"latitude":{"type":"number","format":"double","example":52.48468,"description":"Latitude in WGS84 format of the fuel station."},"longitude":{"type":"number","format":"double","example":13.42942,"description":"Longitude in WGS84 format of the fuel station."}}},"FuelPriceType":{"type":"object","description":"Information on the prices for fuels at the station.","properties":{"price":{"type":"number","format":"double","example":1.169,"description":"Real-time price for the fuel."},"errorMargin":{"type":"number","format":"double","example":0.038,"description":"The difference between estimated and real-time prices averaged over all reported fuel prices for the specified fuel type and for this particular station and rounded to the nearest hundredth. For example, +/- 0.05 EUR indicates an error rate of 5 cents in the estimated fuel prices. If the price is not an estimate, field errorMargin will be suppressed."},"deltaPrice":{"type":"number","format":"double","example":0.049,"description":"The difference between the price and the price for the cheapest station/fuel type pair for the specified geometry."},"indexScore":{"type":"integer","format":"int32","minimum":0,"maximum":100,"example":78,"description":"Also known as a Fuel Price Index, this is a relative ranking for the fuel station for the specified area. When a fuel station has a low score, then its fuel price is lower than the prices at other stations with higher scores. Values are between 0 and 100."},"available":{"type":"boolean","example":true,"description":"The fuel type is available (true) for refuelling or is not available (false) at this moment"},"fuelType":{"type":"string","example":"1","description":"Fuel type.","xml":{"attribute":true}},"unit":{"type":"string","enum":["l","gal"],"example":"l","description":"Unit of measurement for fuel.","xml":{"attribute":true}},"currency":{"type":"string","example":"EUR","description":"Currency used in the price.","xml":{"attribute":true}},"lastUpdateTimestamp":{"type":"string","example":"2020-09-07T05:16:36.000Z","description":"Information about when the fuel price information was last updated, in ISO 8601 format. If the time is UTC, a Z is added. An example of this kind of timestamp value is 2013-12-31T12:00:00.000Z. If the time is not UTC , then the offset is added as a ±[hh][mm] value (for example, 2014-01-14T10:00:00.000+0100).","xml":{"attribute":true}}}},"FuelStationDetailType":{"type":"object","description":"Other fuel station details - opening hours, accessibility, etc","properties":{"openingHours":{"$ref":"#/components/schemas/OpeningHoursType"},"restrictedAccess":{"type":"boolean","example":false,"description":"Indicating if the access to this Fuel station is restricted. \n\nTrue when re-fuelling at this station required subscription, driver must be member and verified by card or mobile application.\n","default":false},"accessibilities":{"description":"Fuel station accessibility details. \n\nInformation for the driver about access restrictions and suitabilities. \n\nE.g. `Members only`, `Suitable for wheel chair`, `Vertical clearance 4 m`, etc.\n","type":"array","items":{"type":"string"},"example":["Members only","Vertical clearance 4m"]},"hydrogenPressures":{"type":"array","items":{"type":"integer","enum":[350,700],"example":350},"description":"Pressure level of the dispensed hydrogen (in bar). \n  \nOnly present for fuel type=74 (Hydrogen)\n"},"hydrogenVehicleTypes":{"type":"array","items":{"type":"string","enum":["car","bus","truck"],"example":"car"},"description":"Category of FCEV the hydrogen can be dispensed to.\n  \nOnly present for fuel type=74 (Hydrogen)\n"},"operationalState":{"$ref":"#/components/schemas/OperationalStateType"}}},"OperationalStateType":{"type":"object","description":"An \"operational state\" for a fuel station refers to its current \nstatus, which can be active and selling fuel or closed, \nand is determined by factors like the availability of fuel, \npower, and the ability to dispense it.\n","properties":{"h350Status":{"$ref":"#/components/schemas/HydrogenStatus","example":"online"},"h700Status":{"$ref":"#/components/schemas/HydrogenStatus","example":"limited"},"h350Inventory":{"type":"number","format":"double","example":4.25,"description":"Actual inventory of 350bar hydrogen in kg"},"h700Inventory":{"type":"number","format":"double","example":9.6,"description":"Actual inventory of 7000bar hydrogen in kg"},"eventMessage":{"type":"string","description":"Ongoing even message.","example":"The station is undergoing maintenance until further notice."}}},"HydrogenStatus":{"type":"string","description":"Status of hydrogen dispensor","example":"limited","enum":["online","offline","limited","offHours","refresh","unknown"]},"OpeningHoursType":{"type":"object","properties":{"regularOpeningHours":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHoursDetailsType"}},"annualOpenings":{"type":"array","items":{"$ref":"#/components/schemas/AnnualOpeningHoursDetailType"}}}},"OpeningHoursDetailsType":{"type":"object","properties":{"daymask":{"type":"integer","format":"int32","example":127,"description":"A mask representing the days of the week as an 8-bit integer mask."},"period":{"$ref":"#/components/schemas/TimePeriodType"}}},"AnnualOpeningHoursDetailType":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2020-12-24","description":"Date of special opening hours"},"period":{"$ref":"#/components/schemas/TimePeriodType"},"closed":{"type":"boolean","example":true,"description":"True if station is closed on particular date. Either the Closed or the Period elements are included in the response, not both."}}},"TimePeriodType":{"type":"object","properties":{"from":{"type":"string","format":"time","example":"06:00:00","description":"Start time, in hh:mm:ss format"},"to":{"type":"string","format":"time","example":"21:30:00","description":"End time, in hh:mm:ss format"}}},"KeyValueType":{"type":"object","properties":{"value":{"type":"string","example":"+49306233662","description":"Contact value - phone or fax number, web site URL, email address, etc"},"label":{"type":"string","example":"XYZ","description":"Contact type identifier"}}},"FuelTypes":{"type":"object","description":"Fuel type list","properties":{"fuelTypes":{"description":"List of available fuel types","type":"array","items":{"$ref":"#/components/schemas/FuelType"}}}},"FuelType":{"type":"object","description":"Fuel type","properties":{"id":{"description":"Unique fuel type identifier","type":"integer","format":"int32","example":1},"name":{"description":"Fuel type name","type":"string","example":"Regular"},"parentIds":{"description":"Container for ParentIds data type.\nE.g. if fuelType in search stations query is -3, returns all stations with fuel type that has parentId = -3. \nThis can be used to search stations with e.g. all types of Diesel - diesel, Bio-diesel, Red-diesel, etc.\n","type":"array","items":{"type":"integer","format":"int32","example":-3}}}},"FuelBrands":{"type":"object","description":"Fuel station brand list","properties":{"fuelBrands":{"description":"List of available fuel brands","type":"array","items":{"type":"string"}}}},"ApiIsAliveStatus":{"type":"string","description":"Health status of API","example":"200 OK"}},"examples":{"InternalServerErrorExample":{"value":{"status":500,"title":"Internal Server Error","cause":"There was some issue processing the request.","action":"Please retry after some time.","code":"E612010","correlationId":"c1281609-7a9a-45d0-8438-f4ac82c4e2c2"}},"502errorResponseExample":{"value":{"title":"Bad Gateway","status":502,"code":"E612201","cause":"Bad Gateway","action":"Failure of communication with external system.","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"504errorResponseExample":{"value":{"title":"Gateway timeout","status":504,"code":"E612101","cause":"Gateway Timeout","action":"Did not receive a timely response from an upstream server","correlationId":"dfe3b1a5-214f-49a9-b8a0-d78bd623bac0"}},"FuelTypesExample":{"value":{"fuelTypes":[{"id":-1,"name":"All Truck Diesel"},{"id":-2,"name":"All Diesel"},{"id":1,"name":"Diesel","parentIds":[-2]},{"id":6,"name":"Bio-Diesel","parentIds":[-2]},{"id":7,"name":"Bio-Diesel 10","parentIds":[-2]},{"id":10,"name":"Diesel plus","parentIds":[-2]},{"id":12,"name":"Red-Diesel","parentIds":[-2]}]}},"FuelBrandsExample":{"value":{"fuelBrands":["1 Stop","1-2-3","1a autoservice","25 Chasov","3A Barontini","4 Petroli","7-Eleven","Agip","Shell"]}}}}}