HERE Fuel Prices API v3

{"openapi":"3.0.2","info":{"title":"Fuel Prices API v3","version":"3.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"},"security":[{"Bearer":[]},{"ApiKey":[]}],"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":{"/stations":{"get":{"tags":["Fuel stations"],"summary":"Fuel stations search","description":"Retrieves fuel stations within geospatial area","operationId":"Fuel Prices API v3 fuelStationsSearch","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"$ref":"#/components/parameters/in"},{"$ref":"#/components/parameters/fuelType"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/brands"},{"$ref":"#/components/parameters/returnAllStations"},{"$ref":"#/components/parameters/iconSize"}],"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"},"examples":{"proximitySearchExample":{"$ref":"#/components/examples/FuelStationsSearchExample"}}}}},"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/ErrorResponse"},"examples":{"badRequestMissingMandatoryParameterExample":{"$ref":"#/components/examples/BadRequestStationsExample"}}}}},"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"}}},"post":{"tags":["Fuel stations"],"summary":"Fuel stations along the route search","description":"Retrieves fuel stations along the route","operationId":"Fuel Prices API v3 fuelStationsCorridorSearch","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"$ref":"#/components/parameters/fuelType"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/brands"},{"$ref":"#/components/parameters/returnAllStations"},{"$ref":"#/components/parameters/iconSize"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CorridorSearchRequest"}}},"required":true},"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"},"examples":{"proximitySearchExample":{"$ref":"#/components/examples/FuelStationsSearchExample"}}}}},"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/ErrorResponse"},"examples":{"badRequestMissingMandatoryParameterExample":{"$ref":"#/components/examples/BadRequestStationsExample"}}}}},"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"}}}},"/stations/{id}":{"get":{"tags":["Fuel stations"],"summary":"One fuel station data","description":"Retrieves single fuel station information for given station id","operationId":"Fuel Prices API v3 fuelStationDetail","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"id","in":"path","description":"Fuel station id","required":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/iconSize"}],"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/FuelStation"},"examples":{"fuelStationExample":{"$ref":"#/components/examples/FuelStationExample"}}}}},"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/ErrorResponse"},"examples":{"notFoundtExample":{"$ref":"#/components/examples/NotFoundStationByIdExample"}}}}},"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"}}}},"/stations/bulk":{"get":{"tags":["Fuel stations"],"summary":"Return multiple fuel stations","description":"Retrieves multiple fuel stations by station ids","operationId":"Fuel Prices API v3 fuelStationBulk","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"ids","in":"query","description":"Fuel station ids","required":true,"explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"content","in":"query","description":"Limit the content in the response.\n\nThe possible values are:\n\n  * dynamic (returns only dynamic data - fuel prices)\n  * all (return both, static and dynamic data)\n","required":false,"schema":{"type":"string","default":"dynamic","enum":["dynamic","all"]}},{"$ref":"#/components/parameters/iconSize"}],"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"},"examples":{"fuelStationsAllExample":{"$ref":"#/components/examples/FuelStationsSearchExample"},"fuelStationsDynamicExample":{"$ref":"#/components/examples/FuelStationBulkDynamicExample"}}}}},"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/ErrorResponse"},"examples":{"badRequestMissingMandatoryParameterExample":{"$ref":"#/components/examples/BadRequestStationsNoIdExample"},"badRequestWrongContentParameterExample":{"$ref":"#/components/examples/BadRequestStationsContentExample"}}}}},"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"}}}},"/stations/count":{"get":{"tags":["Fuel stations"],"summary":"Number of fuel stations","description":"Return number of fuel stations within given geospatial area","operationId":"Fuel Prices API v3 fuelStationsCount","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"in","description":"Return fuel stations within a geographical area.\nArea within which to return fuel stations.\n\nA geographic area can be one of the following:\n\n * A circular area, provided as latitude, longitude, and radius (in meters)\n\n   Format: `circle:{latitude},{longitude};r={radius}`\n\n   Type: `circle:{decimal},{decimal};r={integer}`\n\n   Example: `circle:13.1,-43.1;r=10000`\n\n * A bounding box, provided as _west longitude_, _south latitude_, _east longitude_, _north latitude_\n\n   Format: `bbox:{west longitude},{south latitude},{east longitude},{north latitude}`\n\n   Example: `bbox:13.08836,52.33812,13.761,52.6755`\n\n * A corridor, provided as a polyline in\n   [Flexible Polyline](https://github.com/heremaps/flexible-polyline) encoding and a\n   radius (in meters). The radius is measured perpendicular to each segment of the\n   polyline on both sides, so a radius of 50 meters will cover an area 50 meters on either\n   side of the polyline and be 100 meters wide from one side to the other.\n\n   Format: `corridor:{polyline};r={radius}`\n\n   Example: `corridor:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e:r=50`\n","in":"query","style":"form","required":true,"schema":{"type":"string"},"examples":{"circle":{"value":"circle:13.1,-43.1;r=10000","summary":"A circular area"},"bbox":{"value":"bbox:13.08836,52.33812,13.761,52.6755","summary":"A bounding box"},"corridor":{"value":"corridor:BF05xgKuy2xCx9B7vUl0OhnR54EqSzpEl-HxjD3pBiGnyGi2CvwFsgD3nD4vB6e:r=50","summary":"A corridor"}}}],"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/FuelStationsCount"}}}},"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/ErrorResponse"},"examples":{"missingMandatoryInParameter":{"$ref":"#/components/examples/BadRequestStationsExample"}}}}},"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"}}}},"/fuelTypes":{"get":{"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 v3 fuelTypes","parameters":[{"$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/FuelTypes"},"examples":{"dieselFuelTypesExample":{"$ref":"#/components/examples/FuelTypesExample"}}}}},"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"}}}},"/fuelBrands":{"get":{"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 v3 fuelBrands","parameters":[{"$ref":"#/components/parameters/X-Request-Id"},{"name":"country","in":"query","description":"ISO 3166-1 alpha-3 country code for which list of brands is returned","required":false,"schema":{"type":"string"}}],"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"},"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"}}}},"/health":{"get":{"tags":["API Information"],"operationId":"Fuel Prices API v3 getHealth","parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"summary":"Health","description":"Returns the health status of the service","security":[],"responses":{"200":{"$ref":"#/components/responses/HealthResponseOk"},"default":{"$ref":"#/components/responses/HealthResponseFail"}}}},"/version":{"get":{"tags":["API Information"],"operationId":"Fuel Prices API v3 getVersion","parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"summary":"Version","description":"Returns the version of the service","security":[],"responses":{"200":{"$ref":"#/components/responses/VersionResponseOk"},"500":{"$ref":"#/components/responses/Error500Response"}}}},"/openapi":{"get":{"summary":"This API specification","description":"Returns this API specification in YAML format.","operationId":"Fuel Prices API v3 getOpenapi","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/X-Request-Id"}],"responses":{"200":{"description":"Open API specification of this service.\nIf Accept header is specified as `application/x-yaml` or `text/x-yaml`, then the API is returned in YAML format.\nBy default (or if not Accept header is specified) the return format is JSON.\n","content":{"application/json":{"schema":{"type":"object"},"examples":{"openapi":{"$ref":"#/components/examples/OpenApiResponse"}}},"application/x-yaml":{"schema":{"type":"string"}},"text/x-yaml":{"schema":{"type":"string"}}},"headers":{"X-Correlation-ID":{"$ref":"#/components/headers/X-Correlation-Id"},"X-Request-ID":{"$ref":"#/components/headers/X-Request-Id"}}},"401":{"$ref":"#/components/responses/Error401Response"},"403":{"$ref":"#/components/responses/Error403Response"},"500":{"$ref":"#/components/responses/Error500Response"},"502":{"$ref":"#/components/responses/Error502Response"},"503":{"$ref":"#/components/responses/Error503Response"},"504":{"$ref":"#/components/responses/Error504Response"}}}}},"servers":[{"url":"https://fuel.hereapi.com/v3","description":"Production environment URL"}],"components":{"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"},"ApiKey":{"type":"apiKey","in":"query","name":"apiKey","description":"A key generated specifically to authenticate API requests. For more information on how to get an API key, see https://developer.here.com/documentation/identity-access-management/dev_guide/index.html.\n"}},"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"}}},"responses":{"HealthResponseFail":{"description":"API response in case of failure.","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/HealthResponse"},"example":{"status":"fail"}}}},"HealthResponseOk":{"description":"API response in case of success","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/HealthResponse"},"example":{"status":"OK"}}}},"VersionResponseOk":{"description":"API response in case of success","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/VersionResponse"}}}},"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":{"HealthResponse":{"type":"object","description":"Returns the health of the service","properties":{"status":{"description":"Health status of the service:\n* `ok` - the service is operating normally\n* `fail` - the service is currently encountering a failure\n","type":"string"}}},"VersionResponse":{"type":"object","description":"Returns the version of the service","properties":{"apiVersion":{"type":"string","example":"X.Y.Z","description":"The current version of the service"}},"required":["apiVersion"]},"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."}},"FuelStationsResult":{"type":"object","properties":{"total":{"type":"integer","format":"int32","example":125,"description":"Total number of stations within search area"},"limit":{"type":"integer","format":"int32","example":50,"description":"Maximum number of stations in the response"},"count":{"type":"integer","format":"int32","example":50,"description":"Number of stations returned"},"nextOffset":{"type":"integer","format":"int32","example":51,"description":"Next offset"},"stations":{"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."},"modified":{"type":"string","format":"date-time","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. The time is UTC."},"timeZone":{"type":"string","example":"Europe/Berlin","description":"Time zone of the POI. Represents the standard denominator of the time zone."},"name":{"type":"string","example":"Shell","description":"Fuel station name"},"brand":{"type":"string","example":"Shell","description":"Fuel station brand name"},"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. \nPresent only for proximity search - query parameter in=circle.\n"},"open24x7":{"type":"boolean","example":true,"description":"Boolean value indicating if the fuel station is open 24 hours a day."},"address":{"$ref":"#/components/schemas/Address"},"contacts":{"$ref":"#/components/schemas/ContactType"},"position":{"allOf":[{"$ref":"#/components/schemas/Location"}],"description":"The coordinates (latitude, longitude) of a pin on a map corresponding to the searched fuel station."},"access":{"allOf":[{"$ref":"#/components/schemas/Location"}],"description":"Coordinates of the fuel station you are navigating to (for example, driving or walking). This is a point on a road or in a parking lot."},"prices":{"type":"array","items":{"$ref":"#/components/schemas/FuelPriceType"}},"stationDetails":{"$ref":"#/components/schemas/FuelStationDetailType"}}},"Address":{"type":"object","properties":{"label":{"type":"string","description":"Requested address.","example":"SchulstraĂźe 4, 32547 Bad Oeynhausen, Germany"},"countryCode":{"type":"string","description":"A three-letter country code.","example":"DEU"},"countryName":{"type":"string","description":"The localised country name.","example":"Deutschland"},"state":{"type":"string","description":"A code/abbreviation for the state division of a country.","example":"North Rhine-Westphalia"},"county":{"type":"string","description":"A division of a state; typically, a secondary-level administrative division of a country or equivalent.","example":"Mitte"},"city":{"type":"string","description":"The name of the primary locality of the place.","example":"Bad Oyenhausen"},"district":{"type":"string","description":"A division of city; typically an administrative unit within a larger city or a customary name of a city's neighborhood.","example":"Bad Oyenhausen"},"subdistrict":{"type":"string","description":"A subdivision of a district.","example":"Minden-LĂĽbbecke"},"street":{"type":"string","description":"Name of street.","example":"Schulstrasse"},"postalCode":{"type":"string","description":"An alphanumeric string included in a postal address to facilitate mail sorting, such as post code, postcode, or ZIP code.","example":"32547"},"houseNumber":{"type":"string","description":"House number.","example":"4"}}},"Location":{"type":"object","description":"Location on the Earth","properties":{"lat":{"description":"Location of a point on Earth north or south of the equator in decimal degrees.","type":"number","format":"double","example":52.531677},"lng":{"description":"Location of a place on Earth east or west of the prime meridian in decimal degrees.","type":"number","format":"double","example":13.381777},"elv":{"description":"The elevation of a point above mean sea level in meters.","type":"number","example":512.5}},"example":{"lat":52.531677,"lng":13.381777},"required":["lat","lng"]},"ContactType":{"type":"object","description":"Fuel station contacts","properties":{"phones":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"}},"faxes":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"}},"emails":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"}},"websites":{"type":"array","items":{"$ref":"#/components/schemas/KeyValueType"}}}},"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."},"fuelType":{"type":"string","example":"1","description":"Fuel type."},"unit":{"type":"string","example":"l","description":"Unit of measurement for fuel."},"currency":{"type":"string","example":"EUR","description":"Currency used in the price."},"available":{"type":"boolean","example":true,"description":"The fuel type is available (true) for refuelling or is not available (false) at this moment"},"modified":{"type":"string","format":"date-time","example":"2020-09-07T05:16:36.000Z","description":"Information about when the fuel price information was last updated, in ISO 8601 format. The time is UTC."}}},"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":{"regularSchedule":{"type":"array","items":{"$ref":"#/components/schemas/OpeningHoursDetailsType"}},"exceptions":{"type":"array","items":{"$ref":"#/components/schemas/AnnualOpeningHoursDetailType"}}}},"OpeningHoursDetailsType":{"type":"object","properties":{"days":{"type":"array","items":{"type":"string","enum":["mo","tu","we","th","fr","sa","su"]},"description":"A list of days for which opening time is valid"},"periods":{"type":"array","items":{"$ref":"#/components/schemas/TimePeriodType"}}}},"AnnualOpeningHoursDetailType":{"type":"object","properties":{"date":{"type":"string","format":"date","example":"2020-12-24","description":"Date of special opening hours"},"periods":{"type":"array","items":{"$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","exa

# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-fuel-prices-v3-openapi.yml