---
title: "Dealer heatmap full-matrix live frame (Pro+, ETag)"
method: GET
path: "/v1/derived/heatmap/{ticker}/live"
---

# Dealer heatmap full-matrix live frame (Pro+, ETag)

`GET /v1/derived/heatmap/{ticker}/live`

## Request

- Base URL: `https://api.yehangshe.com`
- URL: `https://api.yehangshe.com/v1/derived/heatmap/{ticker}/live`
- Auth: HTTP bearer

## Path parameters

- `ticker` string, required

## Query parameters

- `metric` 'gex' | 'vex'

## Headers

- `If-None-Match` string

## Response `200`

object payload

- object
  - `data` object, required
    - `ticker` string, required
    - `metric` 'gex' | 'vex', required
    - `session_date_et` string, date, required
    - `spot_usd` number, nullable, required
    - `expirations` string[], required
    - `strikes_usd` array[], required: strikes_usd[i] is the ascending strike list of expirations[i] (ragged; only strikes with a value).
      - number[]
    - `net_usd` array[], required: net_usd[i][j] is the value at expirations[i] x strikes_usd[i][j]; cells without a value are omitted.
      - number[]
    - `generated_at` string, date-time, required
    - `source_at` string, date-time, nullable, required
  - `_meta` ResponseMeta, required
    - `request_id` string, nullable, required
    - `cache_hit` boolean, required
    - `data_freshness_seconds` integer, nullable, required
    - `truncated` unknown, required
    - `notice` string
    - `rate_limit_remaining` integer
    - `quota_remaining_pct` number
    - `data_source` 'internal'

## Other responses

- `304`: If-None-Match matched the current representation; no body, consumes no quota
- `400`: validation error
- `401`: authentication error
- `402`: subscription paused
- `403`: scope insufficient, dataset access not enabled, or plan tier required
- `429`: rate limited or quota exhausted

## Changes

- **2026-11-17** `7ee9c45cd645`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yehangshe/apis/gex-heatmap-data-api/changes/v1/derived/heatmap/:ticker/live/get.md)

---

[API](https://skmtc.dev/yehangshe/apis/gex-heatmap-data-api.md) - [All operations](https://skmtc.dev/yehangshe/apis/gex-heatmap-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yehangshe/apis/gex-heatmap-data-api/revisions/7ee9c45cd645?raw)
