HERE Shadows API

The Shadows service provides an effective way to manage configurations for devices that are only intermittently online. The device shadow contains `reported` and `desired` state objects of a device, referred to as `reported` and `desired` shadows. The `desired` shadow contains configuration settings that the device should use and possibly also some optional custom settings. The device receives the `desired` shadow from HERE Tracking as a response to the ingestion request. The `reported` shadow contains the most recent position, sensor readings and settings that the device has sent. The reported shadow may also contain additional properties generated by HERE Tracking based on the device-ingested telemetry. Such properties are stored in the `system.computed` property. In case the most recent telemetry did not contain all the possible fields, the last known information will remain in the shadow. This means that one can see, for example, the last reported temperature or tracker firmware information in the reported shadow, even if the device did not send that information in the latest telemetry. > **IMPORTANT** > Devices should not communicate directly with this service, but should instead send the telemetry to > the ingestion endpoint, which updates the `reported` shadow and returns the `desired` shadow. > Applications should only write to the `desired` shadow and only read from the > `reported` shadow.

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /shadows/v2/health Check the Shadows service health · Gets service health #
Ask an LLM
“Is the HERE Tracking Shadows service up right now?”
“Can I ping the Shadows service before sending it requests?”
Tell an agent
Check the health of the Shadows service.
Tell me whether the Shadows service is healthy.
GET /shadows/v2/version Get the Shadows service version · Gets service version #
Ask an LLM
“What version of the Shadows service is deployed?”
“Which build of the Shadows service am I talking to?”
Tell an agent
Get the version of the Shadows service.
Show me which Shadows service version is running.
PUT /shadows/v2/{trackingId} Set a device's desired shadow · Updates a device shadow #
Ask an LLM
“How do I push new configuration to a device through its shadow?”
“Can I update the reported shadow myself?”
Tell an agent
Set the desired shadow of device {trackingId} to {desired}.
Change tracker {trackingId}'s desired settings to {desired}.
GET /shadows/v2/{trackingId} Get a device's full shadow · Gets a device shadow #
Ask an LLM
“What is the last reported and desired state of a device?”
“Can I see a device shadow for a shipment ID?”
Tell an agent
Get the shadow of device {trackingId}.
Show both reported and desired shadows for tracker {trackingId}.
DELETE /shadows/v2/{trackingId} Clear a device's shadow · Clears a device shadow #
Ask an LLM
“Can I clear only the desired part of a device shadow?”
“What empties a device's reported and desired shadows?”
Tell an agent destructive · confirm first
Clear the shadow of device {trackingId}.
Clear only the desired shadow of {trackingId} with desired={desired}.
POST /shadows/v2/batch Get shadows for many devices at once · Gets a batch of device shadows #
Ask an LLM
“Can I fetch shadows for up to 100 devices in one request?”
“Which device shadows changed since a given time?”
Tell an agent
Get shadows for this batch of devices.
Get shadows of these devices modified after {after}.
GET /shadows/v2/{trackingId}/{state} Get a device's reported or desired state · Gets reported or desired state object of a device #
Ask an LLM
“Can I fetch just the reported state of a device?”
“What does the desired state object of a tracker contain?”
Tell an agent
Get the {state} state of device {trackingId}.
Show tracker {trackingId}'s {state} shadow only.
GET /shadows/v2/{trackingId}/{state}/{selector} Read one property from a device shadow · Gets a value of a shadow property #
Ask an LLM
“Can I read a single property like battery level from a device shadow?”
“How do I use a JSON selector to get one shadow value?”
Tell an agent
Get {selector} from the {state} shadow of device {trackingId}.
Read property {selector} of tracker {trackingId}'s {state} state.
GET /shadows/v4 List all device shadows in a project · Gets all shadows #
Ask an LLM
“Where are all my project's devices right now according to their shadows?”
“Can I list device shadows within a bounding box?”
Tell an agent
List all device shadows in project {projectId}.
List project shadows inside {bbox} modified after {after}.

Documentation

📖
Documentation
https://docs.here.com/identity-and-access-management/docs
📖
APIReference
https://docs.here.com/identity-and-access-management/reference
📖
Documentation
https://docs.here.com/data-api/docs
📖
APIReference
https://docs.here.com/data-api/reference
📖
Documentation
https://docs.here.com/usage/docs
📖
APIReference
https://docs.here.com/usage/reference
📖
Documentation
https://docs.here.com/destination-weather/docs
📖
APIReference
https://docs.here.com/destination-weather/reference
📖
Documentation
https://docs.here.com/ev-products/docs
📖
APIReference
https://docs.here.com/ev-products/reference
📖
Documentation
https://docs.here.com/fuel-prices/docs
📖
APIReference
https://docs.here.com/fuel-prices/reference
📖
Documentation
https://docs.here.com/geocoding-and-search/docs
📖
APIReference
https://docs.here.com/geocoding-and-search/reference
📖
Documentation
https://docs.here.com/routing/docs
📖
APIReference
https://docs.here.com/routing/reference
📖
Documentation
https://docs.here.com/positioning/docs
📖
APIReference
https://docs.here.com/positioning/reference
📖
Documentation
https://docs.here.com/indoor-map/docs
📖
APIReference
https://docs.here.com/indoor-map/reference
📖
Documentation
https://docs.here.com/transit/docs
📖
APIReference
https://docs.here.com/transit/reference
📖
Documentation
https://docs.here.com/map-attributes/docs
📖
APIReference
https://docs.here.com/map-attributes/reference
📖
Documentation
https://docs.here.com/map-rendering/docs
📖
APIReference
https://docs.here.com/map-rendering/reference
📖
Documentation
https://docs.here.com/workspace/docs
📖
APIReference
https://docs.here.com/workspace/reference
📖
Documentation
https://docs.here.com/tour-planning/docs
📖
APIReference
https://docs.here.com/tour-planning/reference
📖
Documentation
https://docs.here.com/tracking/docs
📖
APIReference
https://docs.here.com/tracking/reference
📖
Documentation
https://docs.here.com/traffic-api/docs
📖
APIReference
https://docs.here.com/traffic-api/reference
📖
Documentation
https://docs.here.com/wego-pro/docs
📖
APIReference
https://docs.here.com/wego-pro/reference

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/here:here-shadows-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

here-shadows-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: 2.6.11
  title: HERE Tracking Shadows API
  description: 'HERE Tracking is a cloud product designed to address location tracking problems for a wide range of Location IoT industry verticals.


    HERE Tracking also includes end-user mobile and web applications that can be used to demonstrate the product.'
  license:
    name: HERE Documentation License
    url: https://legal.here.com/en-gb/terms/documentation-license
servers:
- url: https://tracking.hereapi.com/
- url: https://tracking.api.here.com/
tags:


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