{ "openapi": "3.0.1", "info": { "title": "Crypto Derivatives Monitor — Funding, OI & Liquidations", "description": "Crypto futures intelligence across every exchange — funding rates, open interest, long/short ratios, liquidation feed, Fear & Greed index, extreme-funding screener. Keyless, monitoring-ready. From $1/1,000 results.", "version": "0.1", "x-build-id": "xdtfKKQYCke9635Lf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brick_joey_yto~crypto-derivatives-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brick_joey_yto-crypto-derivatives-monitor", "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/brick_joey_yto~crypto-derivatives-monitor/runs": { "post": { "operationId": "runs-sync-brick_joey_yto-crypto-derivatives-monitor", "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/brick_joey_yto~crypto-derivatives-monitor/run-sync": { "post": { "operationId": "run-sync-brick_joey_yto-crypto-derivatives-monitor", "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": [ "funding", "oi", "screener", "longshort", "taker", "liquidations", "okx_funding", "feargreed", "watch" ], "type": "string", "description": "What to pull: funding (rates per coin across all exchanges), oi (open interest rankings), screener (extreme funding/movers/OI leaders), longshort (long/short account ratio), taker (buy vs sell volume), liquidations (recent liquidation feed), okx_funding (current + NEXT funding per instrument), feargreed (Fear & Greed index + history), watch (combined derivatives snapshot per coin for scheduled monitoring).", "default": "screener" }, "coins": { "title": "Coins", "type": "array", "description": "Coin index IDs for funding/oi/longshort/taker/watch — e.g. [\"BTC\",\"ETH\",\"SOL\",\"DOGE\"]. Matches the base asset across all exchanges. Demo default: BTC, ETH, SOL.", "items": { "type": "string" } }, "instruments": { "title": "Instruments", "type": "array", "description": "OKX instrument IDs — for liquidations use families like [\"BTC-USDT\",\"ETH-USDT\"]; for okx_funding use full IDs like [\"BTC-USDT-SWAP\",\"ETH-USDT-SWAP\"].", "items": { "type": "string" } }, "screen": { "title": "Screener metric", "enum": [ "open_interest", "funding_long", "funding_short", "movers" ], "type": "string", "description": "screener mode: which extreme to rank — open_interest (largest positions), funding_long (most overcrowded longs — squeeze candidates), funding_short (negative funding — short squeeze fuel), movers (biggest 24h price swings).", "default": "open_interest" }, "period": { "title": "Candle period", "enum": [ "5m", "15m", "30m", "1H", "2H", "4H", "1D" ], "type": "string", "description": "For longshort and taker modes — the aggregation interval per row.", "default": "1H" }, "fearGreedDays": { "title": "Fear & Greed history (days)", "minimum": 1, "maximum": 100, "type": "integer", "description": "feargreed mode: how many days of index history to return — 1 to 100.", "default": 7 }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Row cap per source — 1 to 2000, default 50.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy — useful if CoinGecko rate-limits heavy schedules." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }