How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HERE Metadata API

Get information about catalogs, layers, and partitions

HERE Metadata API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 29 operations across 22 paths, and defines 76 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 5 base URLs: https://use.apilookup.for.a.base.url/, https://image.maps.hereapi.com/mia/v3, https://maps.hereapi.com/v3, https://tracking.hereapi.com/, https://tracking.api.here.com/.

29 operations 22 paths 76 schemas 3 DELETE18 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://account.api.here.com
Authentication
HTTP Bearer, API Key, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Oauth
Resource Areas
1

Authentication & Security 6

HERE Metadata API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). An API key is passed in the query as apiKey (ApiKey). It accepts HTTP bearer tokens (JWT) (UserToken). It accepts HTTP bearer tokens (JWT) (ClientToken). It accepts HTTP bearer tokens (JWT) (DeviceToken). It uses HTTP oauth authentication (signedRequest).

  • Bearer — A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. For more information on how to get a bearer to…
  • ApiKey — A key generated specifically to authenticate API requests. For more information on how to get an API key, see the [Identity & Access Management Guide - API Key…
  • UserToken — This token is obtained using user's realm, username and password and then further scoped to a specific project. First obtain access token from [/users/v2/login…
  • ClientToken — This token is obtained using application's OAuth 2.0 credentials (key + secret) and then scoped to a specific project. Follow [instructions here](https://www.h…
  • DeviceToken — This access token is obtained from [/v2/token endpoint](tag/Ingestion/paths/~1v2~1token/post) using a signed request. Note: Only a small subset of our endpoint…
  • signedRequest — HERE Tracking requires that you sign your requests for tokens. The signature method uses the OAuth 1.0 standard. For more information on this standard, see the…

Paths & Operations 29

Across 22 paths, the API surfaces 29 operations — 3 DELETE, 18 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Metadata 29

Get information about catalogs, layers, and partitions

GET
/layerVersions
Gets layer versions for catalog version
MetadataAPIV1GetLayersVersion 2 params → 200400401403404
GET
/layers/{layerId}/changes
Gets changes for the version range
MetadataAPIV1GetChanges 9 params → 200206400401403404416500
GET
/layers/{layerId}/changes/parts
Get partIds for parallel queries of changes for the version range
MetadataAPIV1GetChangesParts 2 params → 200400401403404
GET
/layers/{layerId}/partitions
Gets partitions
MetadataAPIV1GetPartitions 7 params → 200206400401403404416500
GET
/layers/{layerId}/partitions/parts
Get partIds for parallel queries of the metadata for all partitions in a…
MetadataAPIV1GetPartitionsParts 2 params → 200400401403404
GET
/versions
Gets catalog versions
MetadataAPIV1ListVersions 5 params → 200400401403404500503
POST
/versions/compatibles
Gets a list of available catalog versions that respect the given dependencies
MetadataAPIV1CompatibleVersions 2 params body → 200400401403404500503
GET
/versions/latest
Gets the latest available catalog version
MetadataAPIV1LatestVersion 2 params → 200400401403404
GET
/versions/minimum
Gets the earliest available catalog version
MetadataAPIV1MinimumVersion 1 param → 200400401403404
POST
/versions/minimum
Sets the earliest available catalog version
MetadataAPIV1SetMinimumVersion 1 param body → 204400401403404
GET
/info
Returns a list of accepted values for specific API parameters
getInfo 1 param → 200401403404500default
GET
/politicalViews
Returns geopolitical views
getPoliticalViews 1 param → 200401403404500default
GET
/features
Returns features per style
getFeatures 1 param → 200401403404500default
GET
/languages
Returns the available map languages
getLanguages 1 param → 200401403404500default
GET
/copyright
Returns copyright information
getCopyright 1 param → 200401403404500default
GET
/metadata/v2/healthdeprecated
Gets service health
getMetadataV2Health → 200500
GET
/metadata/v2/versiondeprecated
Gets service version
getMetadataV2Version → 200500
GET
/metadata/v2/devices/{trackingId}deprecated
Gets metadata of a device or a shipment
getMetadataV2DevicesByTrackingId 3 params → 200400401403404
PUT
/metadata/v2/devices/{trackingId}deprecated
Creates or updates metadata of a device or a shipment
putMetadataV2DevicesByTrackingId 3 params body → 200400401403404
DELETE
/metadata/v2/devices/{trackingId}deprecated
Deletes all metadata of a device or a shipment
deleteMetadataV2DevicesByTrackingId 3 params → 204400401403404
POST
/metadata/v2/devices/batchdeprecated
Gets a batch of metadata of multiple devices or shipments
postMetadataV2DevicesBatch 3 params body → 200400401403404
GET
/metadata/v2/geofences/{geofenceId}deprecated
Gets metadata of a geofence
getMetadataV2GeofencesByGeofenceId 2 params → 200400401403404
PUT
/metadata/v2/geofences/{geofenceId}deprecated
Creates or updates metadata of a geofence
putMetadataV2GeofencesByGeofenceId 2 params body → 200400401403404
DELETE
/metadata/v2/geofences/{geofenceId}deprecated
Deletes all metadata of a geofence
deleteMetadataV2GeofencesByGeofenceId 2 params → 204400401403404
POST
/metadata/v2/geofences/batchdeprecated
Gets a batch of metadata of multiple geofences
postMetadataV2GeofencesBatch 3 params body → 200400401403404
GET
/metadata/v2/sensorRules/{sensorRuleId}deprecated
Gets metadata of a sensor rule
getMetadataV2SensorRulesBySensorRuleId 2 params → 200400401403404
PUT
/metadata/v2/sensorRules/{sensorRuleId}deprecated
Creates or updates metadata of a sensor rule
putMetadataV2SensorRulesBySensorRuleId 2 params body → 200400401403404
DELETE
/metadata/v2/sensorRules/{sensorRuleId}deprecated
Deletes all metadata of a sensor rule
deleteMetadataV2SensorRulesBySensorRuleId 2 params → 204400401403404
POST
/metadata/v2/sensorRules/batchdeprecated
Gets a batch of metadata for multiple sensor rules
postMetadataV2SensorRulesBatch 3 params body → 200400401403404

Schemas 76

The contract defines 76 schemas that model the data the API accepts and returns. The most detailed are InfoSchema (10 properties), Partition (8 properties), ErrorResponseSchema_2 (7 properties), InternalServerErrorResponseSchema (7 properties). Each schema is shown below with its type and property counts.

VersionResponse
object
The version of the catalog.
1 property 1 required
VersionsResponse
object
2 properties
Dependencies
object
1 property
AdditionalFieldsEnum
string
Partitions
object
Describes a list of partitions for a given layer and layer version.
2 properties 1 required
MinimumVersionInfo
object
The minumum version of the catalog.
1 property 1 required
LayerVersions
object
Describes the list of the layer versions for a given catalog version.
2 properties 2 required
LayerVersion
object
Describes catalog layer version.
3 properties 3 required
VersionInfo
object
Describes properties for the catalog version.
5 properties 3 required
CatalogVersion
object
2 properties 2 required
Partition
object
Describes the partition object which is unique within a layer.
8 properties 2 required
VersionDependency
object
Describes the properties of the version dependencies.
3 properties 3 required
VersionInfos
object
Describes the list of version information for a catalog.
1 property 1 required
PartsResponse
object
1 property
CopyrightsSchema
object
Copyright objects and a mapping of "resource" paths to a set of copyright objects associated with the resource.
2 properties
IconTypesSchema
array
PoliticalViewsSchema
object
Map resource to list of supported geopolitical views for that resource. The values follow [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2)…
UnauthorizedErrorSchema
object
Custom error response schema returned as a result of authentication.
2 properties
ErrorResponseDetailsSchema
object
Detailed information about the error.
1 property
PoliticalViewSchema
string
Indicates a certain geopolitical view applied to the map. The values follow the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2) country co…
ErrorResponseSchema
object
Response in case of error.
7 properties 6 required
ProjectionsSchema
array
List of available map projection types.
ResourceSchema
string
Name of the underlying resource type for the map image.
LanguageSchema
string
Indicates that the map supports the returned language. The values follow the BCP47 language code limited to ISO 639-1 two-letter language code and, optionally,…
ProjectionSchema
string
The map projection type used when rendering images.
SizesSchema
object
List of supported image sizes.
2 properties
FormatSchema
string
Supported image format types.
CopyrightLayersSchema
object
The mapping that matches styles with copyright bounding box definitions.
1 property
AllowedSizesSchema
object
2 properties
CopyrightResourcesSchema
object
The copyright style mappings for this particular resource.
ZoomLevelsSchema
object
The range of available zoom levels.
2 properties
StyleFeaturesSchema
array
Defines all features supported by a particular style.
ResourcesSchema
array
List of available resource types.
InternalServerErrorResponseSchema
object
Internal Error | Indicates a server malfunction and an unexpected error.
7 properties 6 required
InfoSchema
object
10 properties
FeaturesSchema
object
Provides the information about supported features.
1 property
NotFoundErrorResponseSchema
object
Not Found | Indicates that the resource was not found.
7 properties 6 required
CopyrightsObjectSchema
object
The copyright objects.
FormatsSchema
array
List of supported image formats.
CopyrightSchema
object
5 properties
StylesFeaturesSchema
object
Features and their corresponding modes available for each style.
IconTypeSchema
string
Name of the underlying icon type for the icon image.
StyleFeatureSchema
object
Defines a single feature.
2 properties
MapVersionSchema
string
The current encoded map version which is valid for 24 hours. After that period, this value must be refreshed.
LanguagesSchema
object
List of languages supported for a specific resource type.
StylesSchema
array
List of available styles.
StyleSchema
string
ForbiddenErrorSchema
object
Custom error response schema returned as a result of authentication.
2 properties
CopyrightStylesSchema
object
PoliticalViewSchema_2
string
Indicates a certain geopolitical view of the map. The values follow [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO3166-1alpha-2) country codes schema.
UnauthorizedErrorSchema_2
object
Custom error response schema returned by authentication
2 properties
ErrorResponseDetailsSchema_2
object
Detailed information about the error
1 property
ErrorResponseSchema_2
object
Response in case of error
7 properties 6 required
ProjectionsSchema_2
array
List of available projections
ResourceSchema_2
string
Name of a tile resource
LanguageSchema_2
string
Indicates that the map on this layer supports the returned language language. The values follow ISO 639-1 two-letter language code and, optionally, ISO 15924 f…
ProjectionSchema_2
string
The projection used when rendering tiles
SizesSchema_2
array
List of supported image sizes
FormatSchema_2
string
Supported image format
ZoomLevelsSchema_2
object
The range of available zoom levels
2 properties
StyleFeaturesSchema_2
array
Defines all the features supported by a particular style.
ResourcesSchema_2
array
List of available resources
InternalServerErrorResponseSchema_2
object
Internal Error | Indicates a server malfunction and an unexpected error.
7 properties 6 required
InfoSchema_2
object
7 properties
FeaturesSchema_2
object
Provides information about supported features.
1 property
NotFoundErrorResponseSchema_2
object
Not Found | Indicates that the requested resource was not found.
7 properties 6 required
FormatsSchema_2
array
List of supported formats
CopyrightSchema_2
object
5 properties
StylesFeaturesSchema_2
object
Mapping of a style to all supported features for the style.
GenericError
object
generic error
StyleFeatureSchema_2
object
Defines a single feature.
2 properties
SizeSchema
integer
Supported image size
MapVersionSchema_2
string
The current encoded map version. Lasts for 24 hours. After that period, this value should be refreshed.
LanguagesSchema_2
object
Map resource to list of supported languages for that resource
StylesSchema_2
array
List of available styles
ForbiddenErrorSchema_2
object
Custom error response schema returned by authentication
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

here-metadata-api-openapi.yml Raw ↑

Other APIs HERE publishes across the network.

HERE Geocoding and Search API
HERE Autosuggest API
HERE Tour Planning API
HERE Public Transit API
HERE Destination Weather API
HERE Map Tile API
HERE Map Image API
HERE Tracking API
HERE Positioning API
HERE Parking API
HERE Platform Data API
HERE HD Live Map
Where this information came from

This is an independent, third-party profile of HERE Metadata API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.