# CoinGlass Liquidation Map API (`api_merge/coinglass-liquidation-map`) Actor Fetch CoinGlass liquidation map data for futures trading pairs. Search supported instruments, select a range, and get clean JSON output showing mapped liquidation price levels, liquidation size, and leverage ratio - **URL**: https://apify.com/api\_merge/coinglass-liquidation-map.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, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $10.00 / 1,000 liquidation maps 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 CoinGlass Liquidation Map do? CoinGlass Liquidation Map helps you search supported futures instruments and fetch liquidation map data for a selected instrument and range. Use `search_symbols` to find the correct `symbol` value, then send that value to `liquidation_map` to get clean JSON liquidation map output. ### Why use CoinGlass Liquidation Map? Use this Actor when you need structured liquidation map data for dashboards, market analysis, alerts, or automated workflows. - Search futures instruments by keyword - Fetch liquidation map data by instrument and range - Use separate pay-per-event pricing for symbol searches and liquidation map data - Export results as JSON, CSV, Excel, HTML, or RSS ### How to use CoinGlass Liquidation Map 1. Open the Actor on Apify. 2. Select `search_symbols` to find an instrument, or `liquidation_map` to fetch map data. 3. Fill the matching input fields. 4. Click **Start**. 5. Read the output from the default dataset. ### Input | Field | Required | Default | Description | | --- | --- | --- | --- | | `mode` | Yes | `search_symbols` | Operation to run. Supported values: `search_symbols`, `liquidation_map`. | | `keyword` | No | empty | Optional search keyword used with `search_symbols`. Leave it empty to return the default futures symbol list. | | `symbol` | Required for `liquidation_map` | `Binance_BTCUSDT` | Symbol value returned by `search_symbols`, such as `Binance_BTCUSDT`. | | `range` | Required for `liquidation_map` | `1d` | Liquidation map range. Supported values: `1d`, `7d`, `30d`, `90d`, `180d`, `365d`. | ### Search symbols input example ```json { "mode": "search_symbols", "keyword": "btc" } ```` `keyword` is optional. You can also leave it empty when using `search_symbols`. ### Search symbols output example ```json { "success": true, "message": "Futures symbols fetched successfully.", "mode": "search_symbols", "keyword": "btc", "data": [ { "base_asset": "BTC", "quote_asset": "USDT", "exchange": "Binance", "symbol": "Binance_BTCUSDT" } ] } ``` Use the `symbol` value from the `search_symbols` response as the `symbol` input for `liquidation_map`. ### Liquidation map input example ```json { "mode": "liquidation_map", "symbol": "Binance_BTCUSDT", "range": "1d" } ``` ### Liquidation map output example ```json { "success": true, "message": "Liquidation map data fetched successfully.", "mode": "liquidation_map", "symbol": "Binance_BTCUSDT", "range": "1d", "data": { "48935": [ // Liquidation price [ 48935, // Liquidation price 1579370.77, // Liquidation level 25, // Leverage ratio null ] ] } } ``` ### Data table | Field | Description | | --- | --- | | `success` | `true` when the Actor completed cleanly. | | `message` | Human-readable result or warning message. | | `mode` | Operation used for the run. | | `keyword` | Search keyword, when `search_symbols` is used. | | `symbol` | Search result symbol used for `liquidation_map`. | | `range` | Liquidation map range, when `liquidation_map` is used. | | `data` | Symbol search results or liquidation map data. | | `data.` | Liquidation price level key. | | `data.[0][0]` | Liquidation price. | | `data.[0][1]` | Liquidation level. | | `data.[0][2]` | Leverage ratio. | ### Pay-per-event pricing This Actor uses separate charge events for each operation: | Event name | Used for | | --- | --- | | `SEARCH_SYMBOLS` | Searching futures instruments. | | `LIQUIDATION_MAP` | Fetching liquidation map data. | ### Tips - Run `search_symbols` first if you do not know the exact `symbol`. - Use the returned `symbol` as the `symbol` input for `liquidation_map`. - Use longer ranges such as `90d`, `180d`, or `365d` for wider liquidation map snapshots. # Actor input Schema ## `mode` (type: `string`): Choose whether to search futures symbols or fetch liquidation map data. ## `keyword` (type: `string`): Search keyword used only when mode is search\_symbols. ## `symbol` (type: `string`): Symbol value returned by search\_symbols, used only when mode is liquidation\_map, such as Binance\_BTCUSDT. ## `range` (type: `string`): Time range used only when mode is liquidation\_map. ## Actor input object example ```json { "mode": "liquidation_map", "symbol": "Binance_BTCUSDT", "range": "1d" } ``` # Actor output Schema ## `dataset` (type: `string`): Dataset items with symbol search results, liquidation map data, or a warning. # 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 = { "mode": "liquidation_map", "symbol": "Binance_BTCUSDT", "range": "1d" }; // Run the Actor and wait for it to finish const run = await client.actor("api_merge/coinglass-liquidation-map").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 = { "mode": "liquidation_map", "symbol": "Binance_BTCUSDT", "range": "1d", } # Run the Actor and wait for it to finish run = client.actor("api_merge/coinglass-liquidation-map").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 '{ "mode": "liquidation_map", "symbol": "Binance_BTCUSDT", "range": "1d" }' | apify call api_merge/coinglass-liquidation-map --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=api_merge/coinglass-liquidation-map", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "CoinGlass Liquidation Map API", "description": "Fetch CoinGlass liquidation map data for futures trading pairs. Search supported instruments, select a range, and get clean JSON output showing mapped liquidation price levels, liquidation size, and leverage ratio", "version": "0.0", "x-build-id": "Ez6BIVCbFKRq2J0da" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/api_merge~coinglass-liquidation-map/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-api_merge-coinglass-liquidation-map", "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~coinglass-liquidation-map/runs": { "post": { "operationId": "runs-sync-api_merge-coinglass-liquidation-map", "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~coinglass-liquidation-map/run-sync": { "post": { "operationId": "run-sync-api_merge-coinglass-liquidation-map", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search_symbols", "liquidation_map" ], "type": "string", "description": "Choose whether to search futures symbols or fetch liquidation map data.", "default": "liquidation_map" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search keyword used only when mode is search_symbols." }, "symbol": { "title": "Symbol", "type": "string", "description": "Symbol value returned by search_symbols, used only when mode is liquidation_map, such as Binance_BTCUSDT.", "default": "Binance_BTCUSDT" }, "range": { "title": "Range", "enum": [ "1d", "7d", "30d", "90d", "180d", "365d" ], "type": "string", "description": "Time range used only when mode is liquidation_map.", "default": "1d" } } }, "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 } } } } } } } } } } ```