# CoinAnk Liquidation Heatmap API (`api_merge/coinank-liquidation-heatmap`) Actor

Fetches CoinAnk liquidation heatmap data for the selected crypto symbol

- **URL**: https://apify.com/api\_merge/coinank-liquidation-heatmap.md
- **Developed by:** [Api Merge](https://apify.com/api_merge) (community)
- **Categories:** Automation, Integrations
- **Stats:** 29 total users, 11 monthly users, 99.9% runs succeeded, 1 bookmarks
- **User rating**: No ratings yet

## Pricing

$10.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

### What does CoinAnk Liquidation Heatmap do?

CoinAnk Liquidation Heatmap fetches liquidation heatmap data for a selected Binance futures symbol such as `BTCUSDT`, `ETHUSDT`, or `SOLUSDT`.

Pick a symbol, select a time interval, and run the Actor. The Actor calls the CoinAnk proxy Worker and saves the cleaned response to the default Apify dataset as JSON.

### Why use it?

Use this Actor to collect CoinAnk liquidation heatmap data in a repeatable Apify workflow.

It is useful for:

- Tracking liquidation heatmap levels for Binance crypto markets
- Feeding dashboards, alerts, or trading tools
- Comparing heatmap data across supported intervals
- Automating repeated CoinAnk data collection with Apify schedules or API calls

### How to use

1. Open the Actor on Apify.
2. Select a `symbol`.
3. Select an `interval`.
4. Click **Start**.
5. Read the results from the dataset.

### Input

The Actor accepts two required inputs.

| Field | Required | Description |
| --- | --- | --- |
| `symbol` | Yes | Binance market symbol to fetch. Examples: `BTCUSDT`, `ETHUSDT`, `SOLUSDT`. |
| `interval` | Yes | Time range. Options: `12h`, `1d`, `3d`, `1w`, `2w`, `1M`, `3M`, `6M`, `1Y`. |

### Input example (JSON)

```json
{
    "symbol": "BTCUSDT",
    "interval": "12h"
}
```

### Output

The Actor returns one JSON object with the cleaned CoinAnk heatmap data.

### Output example (JSON)

```json
{
    "success": true,
    "message": "Liquidation heatmap data fetched successfully.",
    "tickSize": 25,
    "chartInterval": "5m",
    "start": 1779429000000,
    "end": 1779472200000,
    "liqHeatMap": {
        "data": [
            ["0", "0", "0"],
            ["0", "1", "0"],
            ["0", "2", "0"]
        ],
        "chartTimeArray": [
            1779429000000,
            1779429300000,
            1779429600000
        ],
        "priceArray": [
            73800,
            73850,
            73900
        ],
        "maxLiqValue": 13284152
    }
}
```

### Output fields

| Field | Description |
| --- | --- |
| `success` | `true` when the Actor completed cleanly, including free-limit notifications. |
| `message` | Human-readable result or warning message. |
| `tickSize` | Price step size used by the heatmap. |
| `chartInterval` | Candle interval used for the returned chart data. |
| `start` | Heatmap start timestamp in milliseconds. |
| `end` | Heatmap end timestamp in milliseconds. |
| `liqHeatMap.data` | Heatmap cells. Each item is `[time_index, price_index, liquidation_value]`. |
| `liqHeatMap.chartTimeArray` | Timestamps for the heatmap X-axis, in milliseconds. |
| `liqHeatMap.priceArray` | Price levels for the heatmap Y-axis. |
| `liqHeatMap.maxLiqValue` | Maximum liquidation value in the heatmap. |

### Notes

- `symbol` must be one of the values in the Actor input dropdown.
- Use full symbols such as `BTCUSDT`, not `BTC`.
- If Apify says the input is invalid, check that your `symbol` and `interval` values match the available options exactly.
- Free Apify plan users are limited to 5 runs per UTC day. When the daily limit is reached, a warning item is written to the dataset before requesting data.

# Actor input Schema

## `symbol` (type: `string`):

Select the cryptocurrency symbol to fetch liquidation heatmap data for.

## `interval` (type: `string`):

Select the liquidation heatmap time range.

## Actor input object example

```json
{
  "symbol": "BTCUSDT",
  "interval": "3d"
}
```

# Actor output Schema

## `dataset` (type: `string`):

Dataset items with liquidation heatmap arrays and update time.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "symbol": "BTCUSDT",
    "interval": "3d"
};

// Run the Actor and wait for it to finish
const run = await client.actor("api_merge/coinank-liquidation-heatmap").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "symbol": "BTCUSDT",
    "interval": "3d",
}

# Run the Actor and wait for it to finish
run = client.actor("api_merge/coinank-liquidation-heatmap").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"])
for item in client.dataset(run["defaultDatasetId"]).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "symbol": "BTCUSDT",
  "interval": "3d"
}' |
apify call api_merge/coinank-liquidation-heatmap --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "command": "npx",
            "args": [
                "mcp-remote",
                "https://mcp.apify.com/?tools=api_merge/coinank-liquidation-heatmap",
                "--header",
                "Authorization: Bearer <YOUR_API_TOKEN>"
            ]
        }
    }
}

```

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/5sxBkcaleZAxHRPWB/builds/OynACip0F53GmKngr/openapi.json