{"openapi":"3.0.2","info":{"title":"HERE EV Charge Points API v3","description":"Use this API to get detailed information about charging locations. It builds on data\nretrieved from the **HERE Geocoding and Search API v7** or **HERE Map Content**.\n\nTariff information is provided by Charge Point Operators. HERE Technologies works to\nkeep this data accurate and up to date, but can't guarantee its completeness. Actual\ntariffs at charging locations may differ from the data returned by the API.\n\nSome fields and parameters are in **ALPHA** status. These may change without notice.\n\nFields and parameters marked with the **RESTRICTED** privilege qualifier are\navailable only to customers with a specific contract with HERE.\n","version":"3.20.1"},"servers":[{"url":"https://evcp.hereapi.com/v3","description":"Production environment URL"}],"security":[{"Bearer":[]},{"ApiKey":[]}],"tags":[{"name":"Charging Location Lookup","description":"Endpoints to query charging location data"},{"name":"Charging Location Metadata","description":"Endpoints to query charging location metadata, namely operators and e-Mobility Service Providers."},{"name":"API Information","description":"Additional API Information"}],"paths":{"/locations/{id}":{"get":{"summary":"Fetch a single location","description":"Allows fetching a single location given its ID. The set of returned location properties can be controlled via the `fields` parameter.","operationId":"HERE EV Charge Points API v3 getLocation","tags":["Charging Location Lookup"],"parameters":[{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/days"},{"$ref":"#/components/parameters/tariff"}],"responses":{"200":{"description":"EV charge point data","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/ChargingLocation"}}}},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"500":{"$ref":"#/components/responses/InternalErrorResponse"},"503":{"$ref":"#/components/responses/ServiceUnavailableErrorResponse"},"default":{"$ref":"#/components/responses/GenericErrorResponse"}}}},"/locations":{"get":{"summary":"Fetch multiple locations","description":"Returns data for the specified location identifiers in the `items` property of the response. If no data is found for a location identifier, it appears in the `missing` property.","operationId":"HERE EV Charge Points API v3 getLocations","tags":["Charging Location Lookup"],"parameters":[{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/idList"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/days"},{"$ref":"#/components/parameters/tariff"},{"$ref":"#/components/parameters/connectorTypes"}],"responses":{"200":{"description":"EV charge point data","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/ChargingLocations"}}}},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"403":{"$ref":"#/components/responses/ForbiddenErrorResponse"},"500":{"$ref":"#/components/responses/InternalErrorResponse"},"503":{"$ref":"#/components/responses/ServiceUnavailableErrorResponse"},"default":{"$ref":"#/components/responses/GenericErrorResponse"}}}},"/countryMetadata":{"get":{"summary":"Fetch metadata by countries.","description":"Fetch metadata by countries, such as a list of e-Mobility Service Providers\n(eMSPs). If you don't specify any countries, the response includes all available\ncountries. If you don't specify any fields, the response includes only the list of\navailable countries.\n","operationId":"HERE EV Charge Points API v3 getCountryMeta","tags":["Charging Location Metadata"],"parameters":[{"$ref":"#/components/parameters/xRequestId"},{"$ref":"#/components/parameters/countryCodes"},{"$ref":"#/components/parameters/metaFields"}],"responses":{"200":{"description":"List of metadata entries by country.","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/MetadataByCountry"}}}},"400":{"$ref":"#/components/responses/BadRequestErrorResponse"},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"500":{"$ref":"#/components/responses/InternalErrorResponse"},"503":{"$ref":"#/components/responses/ServiceUnavailableErrorResponse"},"default":{"$ref":"#/components/responses/GenericErrorResponse"}}}},"/health":{"get":{"summary":"Tests basic health of the service","operationId":"HERE EV Charge Points API v3 getHealth","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"responses":{"200":{"description":"Health 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"}}}},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"503":{"description":"Health response when the service is not healthy","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"}}}},"default":{"$ref":"#/components/responses/GenericErrorResponse"}}}},"/version":{"get":{"summary":"Retrieves API specification version information","operationId":"HERE EV Charge Points API v3 getVersion","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"responses":{"200":{"description":"Version of API","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"}}}},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"default":{"$ref":"#/components/responses/GenericErrorResponse"}}}},"/openapi":{"get":{"summary":"Retrieves this API specification in OpenAPI 3 format","operationId":"HERE EV Charge Points API v3 getOpenapi","tags":["API Information"],"parameters":[{"$ref":"#/components/parameters/xRequestId"}],"responses":{"200":{"description":"Version of API","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/OpenapiResponse"},"examples":{"openapi":{"$ref":"#/components/examples/OpenapiResponse"}}},"application/x-yaml":{"schema":{"type":"string"}},"text/x-yaml":{"schema":{"type":"string"}}}},"401":{"$ref":"#/components/responses/UnauthorizedErrorResponse"},"default":{"$ref":"#/components/responses/GenericErrorResponse"}}}}},"components":{"parameters":{"connectorTypes":{"name":"connectorTypes","in":"query","description":"Filter charging locations to only contain EVSEs and connector groups matching the\nrequested connector types.\n\nThis can reduce response size by returning only relevant data. Locations that\ndon't contain EVSEs matching the requested connector types aren't included in\nthe response.\n\nProvide a comma-separated list of connector type identifiers, as defined in the\nConnectorType schema. If you don't specify this parameter, the response includes\nall connector types and no filtering is applied.\n\nConnector types represent physical standards for EV charging connectors, such as\nIEC_62196_T2 and CHADEMO.\n\nFor a complete list of supported values, see the ConnectorType schema.\n","example":["IEC_62196_T2","IEC_62196_T2_COMBO","CHADEMO"],"explode":false,"required":false,"schema":{"type":"array","minItems":1,"maxItems":5,"uniqueItems":true,"items":{"$ref":"#/components/schemas/ConnectorType"}}},"countryCodes":{"name":"countryCodes","in":"query","description":"Filter metadata results to include only the specified countries. A comma-separated list of three-letter country codes according to ISO 3166-1 alpha 3.","example":["DEU","GBR","IRL"],"explode":false,"schema":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/CountryCode"}}},"days":{"name":"days","in":"query","description":"Data is retrieved starting from the current day, based on the local time zone of\nthe location. Currently applies to data from the following fields: `predictions`.\n\nIf no parameter is provided, the default value is 2, which returns data for the\ncurrent day and the following day.\n\nIf a parameter is provided, the system attempts to return data for the specified\nnumber of days, starting from today.\n\nThe actual number of days returned may be fewer than requested, depending on data\navailability.\n","required":false,"example":1,"schema":{"type":"integer","minimum":1,"maximum":7,"default":2}},"fields":{"name":"fields","description":"The `fields` parameter allows requesting additional fields in addition\nto the minimal set of fields to control the amount of data returned. \nThe minimal set of fields is defined as follows:\n * `id`\n * `location`\n * `name`\n * `operator`\n * `suboperator`\n * `restrictions`\n * `supportedVehicles`\n\nAdditional fields can be requested according to the following table. The fields\ncan be freely combined in the query. However some fields have dependencies to\nother fields as listed in the table. If a field is not present in the data, it\nwill be left out of the response.\n\n
| Fields-query | \nReturned fields | \n
| address | \n'address' in full details | \n
| evses | \n'evses' in full details, including 'connectors', 'maxPower', 'standard', 'status' etc | \n
| RESTRICTED truckRestrictions | \n'truckRestrictions', 'vehicleLimitations', 'isPullThrough', 'evse.vehicleTypes', 'evse.vehicleLimitations', 'evse.noClearanceHeight' | \n
| locationInfo | \n'accessPoints', 'parkingType', 'supportPhoneNumber', 'timeZone', 'isPullThrough', 'openingHours', 'energyMix', 'cpoLocationId', 'reservationRequired' | \n
| emsps | \n'eMobilityServiceProviders' | \n
| connectorGroups | \n'connectorGroups', a summary of connectors grouped by max power and type. If also evses-field is requested, the groups include references to EVSEs and connectors. | \n
| RESTRICTED predictions | \n'predictions' in charging location level. If also 'connectorGroups'-field is requested, gives predictions also in 'connectorGroups'. | \n
| ALPHA RESTRICTED reliability | \n'reliability' indicators for 'evses' and 'connectorGroups'. Ignored if requested without 'evses' or 'connectorGroups' fields. | \n
| tariffs | \n'tariffs' for 'connectors' / 'connectorGroups'. Ignored if requested without 'evses' or 'connectorGroups' fields. | \n
| nearby | \nALPHA 'nearbyPlaces', 'facilityTypes', 'hasMoreNearbyPlaces' | \n