{ "openapi": "3.0.1", "info": { "title": "Crypto Liquidations Tracker: Forced Long & Short Closeouts", "description": "Keyless crypto liquidation data from OKX and Gate.io: how much was liquidated long versus short in USD per coin, every forced closeout with its dollar size, and the OKX long/short account ratio behind a cascade. Contract sizes converted to dollars. Pay per row.", "version": "0.1", "x-build-id": "FMLjvQO0ank8MrSBg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapemint~crypto-liquidations-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapemint-crypto-liquidations-tracker", "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/scrapemint~crypto-liquidations-tracker/runs": { "post": { "operationId": "runs-sync-scrapemint-crypto-liquidations-tracker", "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/scrapemint~crypto-liquidations-tracker/run-sync": { "post": { "operationId": "run-sync-scrapemint-crypto-liquidations-tracker", "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", "properties": { "mode": { "title": "Mode", "enum": [ "summary", "liquidations", "positioning" ], "type": "string", "description": "summary = one row per coin per venue with long vs short liquidated in USD and the ratio between them. liquidations = one row per forced closeout. positioning = the OKX long/short account ratio over time, which is the build up a cascade needs.", "default": "summary" }, "coins": { "title": "Coins", "type": "array", "description": "Base coins to track, e.g. BTC, ETH, SOL. USDT perpetuals are used on both venues. Maximum 30 per run.", "default": [ "BTC", "ETH", "SOL" ], "items": { "type": "string" } }, "venues": { "title": "Exchanges", "type": "array", "description": "Which venues to read: okx, gate. OKX carries far more events; Gate is a thin second source.", "default": [ "okx", "gate" ], "items": { "type": "string" } }, "side": { "title": "Side liquidated", "enum": [ "both", "long", "short" ], "type": "string", "description": "Return only long liquidations (forced selling into a drop), only short liquidations (a squeeze), or both.", "default": "both" }, "minValueUsd": { "title": "Min liquidation size (USD)", "minimum": 0, "type": "integer", "description": "Skip liquidations smaller than this. Raise it to see only the large forced closeouts that actually move price. 0 = every event.", "default": 0 }, "period": { "title": "Period (positioning mode)", "enum": [ "5m", "15m", "30m", "1H", "4H", "1D" ], "type": "string", "description": "Candle size for the long/short account ratio series.", "default": "1H" }, "positioningPoints": { "title": "Points per coin (positioning mode)", "minimum": 1, "maximum": 1440, "type": "integer", "description": "How many of the most recent ratio readings to return for each coin.", "default": 48 }, "maxRows": { "title": "Max rows per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Cap on rows returned. Controls total cost. Busy coins can produce thousands of liquidation events per day.", "default": 200 } } }, "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 } } } } } } } } } }