# CoinAnk Liquidation Heatmap (`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:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN 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 a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use 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 { "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 | | --- | --- | | `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. # 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": "12h" } ``` # 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 '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "symbol": "BTCUSDT", "interval": "12h" }; // 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 '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "symbol": "BTCUSDT", "interval": "12h", } # 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": "12h" }' | 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 " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "CoinAnk Liquidation Heatmap", "description": "Fetches CoinAnk liquidation heatmap data for the selected crypto symbol", "version": "0.0", "x-build-id": "zVBigtF8l2mownlGI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api_merge~coinank-liquidation-heatmap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api_merge-coinank-liquidation-heatmap", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/api_merge~coinank-liquidation-heatmap/runs": { "post": { "operationId": "runs-sync-api_merge-coinank-liquidation-heatmap", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/api_merge~coinank-liquidation-heatmap/run-sync": { "post": { "operationId": "run-sync-api_merge-coinank-liquidation-heatmap", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "symbol", "interval" ], "properties": { "symbol": { "title": "Symbol", "enum": [ "BTCUSDT", "ETHUSDT", "SOLUSDT", "XRPUSDT", "HYPEUSDT", "BNBUSDT", "ZKPUSDT", "RIVERUSDT", "LITUSDT", "DOGEUSDT", "ZECUSDT", "0GUSDT", "SUIUSDT", "ADAUSDT", "LINKUSDT", "BCHUSDT", "ASTERUSDT", "AVAXUSDT", "UNIUSDT", "LTCUSDT", "ENAUSDT", "TRXUSDT", "PAXGUSDT", "WLFIUSDT", "AAVEUSDT", "FARTCOINUSDT", "XAUTUSDT", "NEARUSDT", "1000PEPEUSDT", "TRUMPUSDT", "FILUSDT", "DOTUSDT", "XPLUSDT", "PUMPUSDT", "APTUSDT", "PIPPINUSDT", "TONUSDT", "TAOUSDT", "MONUSDT", "ARBUSDT", "WIFUSDT", "WLDUSDT", "ONDOUSDT", "ETCUSDT", "ICPUSDT", "XLMUSDT", "CRVUSDT", "BEATUSDT", "HBARUSDT", "ATOMUSDT", "XMRUSDT", "STRKUSDT", "ๅธๅฎ‰ไบบ็”ŸUSDT", "METUSDT", "1000SHIBUSDT", "ZBTUSDT" ], "type": "string", "description": "Select the cryptocurrency symbol to fetch liquidation heatmap data for.", "default": "BTCUSDT" }, "interval": { "title": "Interval", "enum": [ "12h", "1d", "3d", "1w", "2w", "1M", "3M", "6M", "1Y" ], "type": "string", "description": "Select the liquidation heatmap time range.", "default": "12h" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```