# HERE Shadows API

**Canonical:** https://apis.io/apis/here/here-shadows-api/  
**Provider:** HERE — https://apis.io/providers/here/  
**Base URL:** https://account.api.here.com  
**Documentation:** https://docs.here.com/identity-and-access-management/reference

HERE Shadows API is one of 139 APIs that [HERE](https://apis.io/providers/here/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Shadows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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)

| Method | Path | Summary |
|---|---|---|
| GET | `/shadows/v2/health` | Gets service health |
| GET | `/shadows/v2/version` | Gets service version |
| PUT | `/shadows/v2/{trackingId}` | Updates a device shadow |
| GET | `/shadows/v2/{trackingId}` | Gets a device shadow |
| DELETE | `/shadows/v2/{trackingId}` | Clears a device shadow |
| POST | `/shadows/v2/batch` | Gets a batch of device shadows |
| GET | `/shadows/v2/{trackingId}/{state}` | Gets reported or desired state object of a device |
| GET | `/shadows/v2/{trackingId}/{state}/{selector}` | Gets a value of a shadow property |
| GET | `/shadows/v4` | Gets all shadows |

## Machine-readable artifacts (37)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-shadows-api-openapi.yml
- **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

## Other HERE APIs (12)

- [HERE Geocoding and Search API](https://apis.io/apis/here/geocoding-search/)
- [HERE Autosuggest API](https://apis.io/apis/here/autosuggest/)
- [HERE Tour Planning API](https://apis.io/apis/here/tour-planning/)
- [HERE Public Transit API](https://apis.io/apis/here/public-transit/)
- [HERE Destination Weather API](https://apis.io/apis/here/destination-weather/)
- [HERE Map Tile API](https://apis.io/apis/here/map-tile/)
- [HERE Map Image API](https://apis.io/apis/here/map-image/)
- [HERE Tracking API](https://apis.io/apis/here/tracking/)
- [HERE Positioning API](https://apis.io/apis/here/positioning/)
- [HERE Parking API](https://apis.io/apis/here/parking/)
- [HERE Platform Data API](https://apis.io/apis/here/platform-data/)
- [HERE HD Live Map](https://apis.io/apis/here/hd-live-map/)

## Tags

Shadows

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/here/here-shadows-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/here/.