HERE

HERE Stream API

Consume data from stream layers

GitHub OpenAPI

Operations 7

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

POST /layers/{layerId}/subscribe Subscribe to a stream layer · Enable message consumption from a specific stream layer #
Ask an LLM
“How do I start consuming messages from a stream layer?”
“Can I subscribe in parallel mode for more throughput?”
Tell an agent
Subscribe to stream layer {layer_id}.
Subscribe to stream layer {layer_id} in {mode} mode as consumer {consumer_id}.
DELETE /layers/{layerId}/subscribe Delete a stream layer subscription · Delete subscription to a layer #
Ask an LLM
“How do I unsubscribe from a stream layer when I'm done?”
“Is a subscription ID required to delete a parallel-mode subscription?”
Tell an agent destructive · confirm first
Delete my subscription to stream layer {layer_id}.
Unsubscribe {subscription_id} from stream layer {layer_id}.
GET /layers/{layerId}/partitions Read messages from a stream layer · Consumes data from a layer #
Ask an LLM
“How do I read the latest messages from a stream layer I subscribed to?”
“What happens to stream messages larger than 1 MB when I consume them?”
Tell an agent
Consume messages from stream layer {layerId}.
Read data from {layerId} using subscription {subscriptionId} in {mode} mode.
GET /layers/{layerId}/endpoint Get Kafka consumer endpoint details for a layer · Expose the endpoint to consume the data of the layer directly #
Ask an LLM
“Can I consume a stream layer directly from Kafka brokers?”
“Which bootstrap servers and group ID prefix should my consumer use?”
Tell an agent
Get the Kafka consumer endpoint for stream layer {layer_id}.
Show the broker URLs for consuming layer {layer_id}, internal servers {internal}.
GET /layers/{layerId}/{type}/endpoint Get Kafka producer or consumer settings for a layer · Exposes the endpoint to use to produce and consume the data of the layer… #
Ask an LLM
“Where do I get the Kafka settings to produce data into a stream layer?”
“Are producer and consumer endpoint properties different?”
Tell an agent
Give me the connection properties to act as a {type} on layer {layer_id}.
Show producer broker settings for layer {layer_id} using type {type}.
PUT /layers/{layerId}/offsets Commit the offsets of messages I've read · Commits offsets of the last message read #
Ask an LLM
“Why should I commit offsets after reading stream data?”
“How does my app resume reading from the right place after a failure?”
Tell an agent
Commit offsets {offsets} on stream layer {layer_id}.
Save my read position {offsets} for subscription {subscription_id} on layer {layer_id}.
PUT /layers/{layerId}/seek Move the read pointer to a chosen offset · Seek to predefined offset #
Ask an LLM
“Can I replay a stream layer from an earlier offset?”
“Is it possible to skip ahead to a specific message position?”
Tell an agent
Seek stream layer {layer_id} to offsets {offsets}.
Rewind subscription {subscription_id} on layer {layer_id} to offsets {offsets}.

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

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/here/refs/heads/main/openapi/here-stream-api-openapi.yml

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-stream-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.

GitHub Google LinkedIn

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

OpenAPI Specification

here-stream-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: v2 Stream API
  description: The `stream` service provides the ability to consume data from a stream layer. With this service you can subscribe to a stream layer and consume messages.
  version: 2.1.2
  x-olp-service:
    name: stream
    version: v2
servers:
- url: https://use.apilookup.for.a.base.url/stream/v2
security:
- Bearer: []
tags:


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