Heatmap

Compare market or portfolio listings in a color-coded heatmap.

Overview

PropertyValue
Keyheatmap
CategoryTrading

The Heatmap widget is a read-only view of listings sized and colored from current market or portfolio data.

Features

  • Two sources -- sourceMode selects watchlist or portfolio data and defaults to watchlist.
  • Workspace watchlists -- Watchlist mode automatically combines listings from every watchlist in the active workspace and deduplicates listings shared by more than one watchlist.
  • Watchlist sizing -- watchlistSizeMetric defaults to volumeUsd for USD turnover; select volume for unit volume.
  • Portfolio context -- Portfolio mode reads the selected broker account through tradingProvider, serviceId, and portfolioIdentity.
  • Linked selection -- Selecting a tile updates the linked listing for widgets with the same pair color.
  • Refresh -- Updating runtime.refreshAt requests fresh data without changing saved settings.

Usage

Choose the market provider and its parameters or credentials. By default, Watchlist mode uses the deduplicated listings from all workspace watchlists and sizes them by volumeUsd; manage those listings in the Watchlist widget, or switch sizing to volume. The heatmap renders up to 200 listings and reports when additional listings are omitted.

In Portfolio mode, select a broker and broker account so portfolioIdentity identifies the holdings. Click a tile to publish its listing to linked widgets. The heatmap does not place or modify orders.

Portfolio mode requires a configured broker account; quote enrichment can still depend on the selected market provider.

Configuration

ParameterDescription
listingListing currently shared with linked widgets.
sourceModewatchlist (default) or portfolio.
watchlistSizeMetricvolumeUsd (default) or volume in Watchlist mode.
marketProviderProvider used for listing and quote data.
marketProviderParamsProvider-specific market parameters.
marketAuthOptional market-provider credentials.
tradingProviderBroker provider used in Portfolio mode.
serviceIdBroker service identifier.
portfolioIdentityCanonical selected broker-account identity.
runtime.refreshAtTimestamp used to request refresh.