Position Heatmap API Endpoints Documentation

This document provides an overview of all Position Heatmap-tagged API endpoints available in the Hyblock Professional API v2.

Position Heatmap

Positions Heatmap Data

Endpoint: GET /v2/positionHeatmap

Description: The Positions Heatmap API endpoint tracks open interest, net longs, net shorts, and net long-short delta across price buckets, visualizing where traders are opening or closing positions. It provides insights into market sentiment, support/resistance zones, and potential trapped traders, with data reflecting the most recent timestamp only for up-to-date market positioning.

Summary: Positions Heatmap Data

Common Parameters

Most endpoints accept the following common query parameters:

exchange: Exchange identifier (e.g., binance_perp_stable)

coin: Cryptocurrency symbol (e.g., BTC, ETH)

timeframe: Time interval (1m, 5m, 15m, 1h, 4h, 1d)

limit: Number of data points to return (default: 50)

startTime: Start timestamp (Unix timestamp)

endTime: End timestamp (Unix timestamp)

sort: Sort order (asc or desc)

Note: This endpoint may have additional parameters specific to heatmap functionality.

Authentication

All endpoints require authentication via:

API Key: x-api-key header

OAuth2: Bearer token

Rate Limits

Rate Limit: 600 requests per minute

Burst Limit: 10 concurrent requests

Base URL

All endpoints are prefixed with /v2/ and should be accessed via the base API URL.

For detailed request/response schemas and examples, please refer to the OpenAPI specification at /v2/openapi.json or visit the interactive API documentation.

Position Heatmap

Position Heatmap API Endpoints Documentation#

Table of Contents#